Method: advertisers.channels.patch

  • Display & Video 360 API v1 has been sunset.

  • This page details how to update a channel using a PATCH HTTP request to the specified endpoint.

  • Path parameters required for the request include channel.channelId and advertiserId.

  • Query parameters allow for specifying an updateMask (required) and an optional partnerId.

  • Both the request and response bodies contain an instance of a Channel.

Updates a channel. Returns the updated channel if successful.

HTTP request

PATCH https://displayvideo.googleapis.com/v1/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.