REST Resource: partners.channels

  • Channels are custom groups of related websites and apps.

  • A Channel resource includes fields such as name, channelId, displayName, and counts for positively and negatively targeted line items.

  • Channels are owned by either a partner or an advertiser, identified by partnerId or advertiserId.

  • Available methods for Channels include create, get, list, and patch.

Resource: Channel

A single channel. Channels are custom groups of related websites and apps.

JSON representation
{
  "name": string,
  "channelId": string,
  "displayName": string,
  "positivelyTargetedLineItemCount": string,
  "negativelyTargetedLineItemCount": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
Fields
name

string

Output only. The resource name of the channel.

channelId

string (int64 format)

Output only. The unique ID of the channel. Assigned by the system.

displayName

string

Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.

positivelyTargetedLineItemCount

string (int64 format)

Output only. Number of line items that are directly targeting this channel positively.

negativelyTargetedLineItemCount

string (int64 format)

Output only. Number of line items that are directly targeting this channel negatively.

Identifies the DV360 entity that owns the channel. It can be either a partner or an advertiser. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
partnerId

string (int64 format)

The ID of the partner that owns the channel.

advertiserId

string (int64 format)

The ID of the advertiser that owns the channel.

End of mutually exclusive fields.

Methods

create

Creates a new channel.

get

Gets a channel for a partner or advertiser.

list

Lists channels for a partner or advertiser.

patch

Updates a channel.