Method: partners.channels.list

    • The Display & Video 360 API v2 has sunset.

    • This method lists channels for a specified partner or advertiser.

    • The HTTP request uses a GET method with a URL that includes the partner ID and the path /channels .

    • The response body contains an instance of ListChannelsResponse if the request is successful.

    • The request requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

    Lists channels for a partner or advertiser.

    HTTP request

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

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    Union parameter owner . Required. Identifies the DV360 entity that owns the channels. It can be either a partner or an advertiser. owner can be only one of the following:
    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 200 . 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 can only contain at most one restriction.
    • A restriction has the form of {field} {operator} {value} .
    • All fields must use the HAS (:) operator.

    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.

    Reference our filter LIST requests guide for more information.

    Union parameter owner . Required. Identifies the DV360 entity that owns the channels. It can be either a partner or an advertiser. owner can be only one of the following:
    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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: