Method: partners.channels.list

  • The channels.list method lists channels for a specified partner or advertiser.

  • The HTTP request for listing channels uses a GET method and includes the partnerId in the path.

  • Query parameters like pageSize, pageToken, orderBy, filter, and advertiserId can be used to refine the list results.

  • The request body is empty, and a successful response returns a ListChannelsResponse object.

  • Authorization requires the https://www.googleapis.com/auth/display-video OAuth scope.

Lists channels for a partner or advertiser.

HTTP request

GET https://displayvideo.googleapis.com/v1beta2/partners/{partnerId}/channels

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
partnerId

string (int64 format)

The ID of the partner that owns the channels.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
pageToken

string

A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to channels.list method. If not specified, the first page of results will be returned.
orderBy

string

Field by which to sort the list. Acceptable values are:

  • displayName (default)
  • channelId

The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: displayName desc.
filter

string

Allows filtering by channel fields.

Supported syntax:

  • Filter expressions for channel currently can only contain at most one
  • restriction.
  • A restriction has the form of {field} {operator} {value}.
  • The operator must be CONTAINS (:).
  • Supported fields:
    • displayName

Examples:

  • All channels for which the display name contains "google": displayName : "google".

The length of this field should be no more than 500 characters.
advertiserId

string (int64 format)

The ID of the advertiser that owns the channels.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.