Video API, REST: Channel.Get
Get the specific channel.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/channels/{channelId}
Path parameters
|
Field |
Description |
|
channelId |
string Required field. ID of the channel. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"organizationId": "string",
"title": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"labels": "object",
"settings": {
"advertisement": {
// Includes only one of the fields `yandexDirect`
"yandexDirect": {
"enable": "boolean",
"pageId": "string",
"category": "string"
}
// end of the list of possible fields
},
"refererVerification": {
"enable": "boolean",
"allowedDomains": [
"string"
]
}
}
}
Root entity for content separation.
|
Field |
Description |
|
id |
string ID of the channel. |
|
organizationId |
string ID of the organization where channel should be created. |
|
title |
string Channel title. |
|
description |
string Channel description. |
|
createdAt |
string (date-time) Time when channel was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Time of last channel update. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
labels |
object (map<string, string>) Custom labels as |
|
settings |
Channel settings. |
ChannelSettings
Channel settings.
|
Field |
Description |
|
advertisement |
Advertisement settings. |
|
refererVerification |
Referer verification settings |
AdvertisementSettings
Advertisement settings.
|
Field |
Description |
|
yandexDirect |
Includes only one of the fields Advertisement provider. |
YandexDirect
YandexDirect provider settings.
|
Field |
Description |
|
enable |
boolean Enable Partner Ad for Live and VOD content. |
|
pageId |
string (int64) Advertisement page ID. |
|
category |
string (int64) Advertisement category. |
RefererVerificationSettings
Referer verification settings.
|
Field |
Description |
|
enable |
boolean Enable verification |
|
allowedDomains[] |
string List of available domains |