Method: partners.channels.list
Stay organized with collections
Save and categorize content based on your preferences.
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:
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["Lists channels associated with a specified partner or advertiser."],["Uses an HTTP GET request with path and query parameters to filter results."],["Requires `https://www.googleapis.com/auth/display-video` OAuth scope for authorization."],["Returns a `ListChannelsResponse` object containing channel details upon successful execution."],["Allows for pagination and sorting of results using query parameters like `pageSize`, `pageToken`, and `orderBy`."]]],[]]