Method: advertisers.channels.patch

  • This documentation describes how to update a channel using a PATCH request to the specified URL.

  • The request requires path parameters for advertiserId and channel.channelId.

  • Query parameters include the required updateMask and optional partnerId.

  • The request and response bodies both contain an instance of a Channel.

  • Authorization 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/v1beta2/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.
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".
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.