Video API, gRPC: ChannelService.List
List channels for organization.
gRPC request
rpc List (ListChannelsRequest) returns (ListChannelsResponse)
ListChannelsRequest
{
"organization_id": "string",
"page_size": "int64",
"page_token": "string",
"order_by": "string",
"filter": "string"
}
Field |
Description |
organization_id |
string Required field. ID of the organization. |
page_size |
int64 The maximum number of the results per page to return. |
page_token |
string Page token for getting the next page of the result. |
order_by |
string By which column the listing should be ordered and in which direction, |
filter |
string Filter expression that filters resources listed in the response. |
ListChannelsResponse
{
"channels": [
{
"id": "string",
"organization_id": "string",
"title": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"labels": "map<string, string>",
"settings": {
"advertisement": {
// Includes only one of the fields `yandex_direct`
"yandex_direct": {
"enable": "bool",
"page_id": "int64",
"category": "int64"
}
// end of the list of possible fields
},
"referer_verification": {
"enable": "bool",
"allowed_domains": [
"string"
]
}
}
}
],
"next_page_token": "string"
}
Field |
Description |
channels[] |
List of channels for specific organization. |
next_page_token |
string Token for getting the next page. |
Channel
Root entity for content separation.
Field |
Description |
id |
string ID of the channel. |
organization_id |
string ID of the organization where channel should be created. |
title |
string Channel title. |
description |
string Channel description. |
created_at |
Time when channel was created. |
updated_at |
Time of last channel update. |
labels |
object (map<string, string>) Custom labels as |
settings |
Channel settings. |
ChannelSettings
Channel settings.
Field |
Description |
advertisement |
Advertisement settings. |
referer_verification |
Referer verification settings |
AdvertisementSettings
Advertisement settings.
Field |
Description |
yandex_direct |
Includes only one of the fields Advertisement provider. |
YandexDirect
YandexDirect provider settings.
Field |
Description |
enable |
bool Enable Partner Ad for Live and VOD content. |
page_id |
int64 Advertisement page ID. |
category |
int64 Advertisement category. |
RefererVerificationSettings
Referer verification settings.
Field |
Description |
enable |
bool Enable verification |
allowed_domains[] |
string List of available domains |