Video API, gRPC: ChannelService.Get
Get the specific channel.
gRPC request
rpc Get (GetChannelRequest) returns (Channel)
GetChannelRequest
{
"channel_id": "string"
}
|
Field |
Description |
|
channel_id |
string Required field. ID of the channel. |
Channel
{
"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"
]
}
}
}
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 |