Method: advertisers.channels.patch

  • This operation updates an existing channel with the provided details and returns the updated channel data upon successful completion.

  • It uses an HTTP PATCH request with specified path and query parameters to identify and modify the channel.

  • The request body requires a Channel object containing the desired updates, and the response body returns the updated Channel object if the operation is successful.

  • Authorization with the https://www.googleapis.com/auth/display-video scope is required for this operation.

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.