Video API, gRPC: ChannelService.Create
Creates a new channel in the specified organization.
gRPC request
rpc Create (CreateChannelRequest) returns (operation.Operation)
CreateChannelRequest
{
"organization_id": "string",
"title": "string",
"description": "string",
"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"
]
}
}
}
Field |
Description |
organization_id |
string Required field. ID of the organization where the channel will be created. |
title |
string Required field. Title of the channel to be displayed in interfaces. |
description |
string Detailed description of the channel's purpose and content. |
labels |
object (map<string, string>) Custom user-defined labels as key:value pairs. |
settings |
Configuration settings for the channel's behavior and features. |
ChannelSettings
Configuration settings for the channel's behavior and features.
These settings apply to all content in the channel and control
various aspects of how the channel and its content behave.
Field |
Description |
advertisement |
Settings for advertisement display and behavior. |
referer_verification |
Settings for HTTP Referer verification to control content embedding. |
AdvertisementSettings
Settings for advertisement display and behavior in the channel.
These settings control whether and how advertisements are shown
with content in this channel, including both videos and streams.
Field |
Description |
yandex_direct |
Yandex.Direct advertisement provider settings. Includes only one of the fields Specifies the advertisement provider to use. |
YandexDirect
Configuration for the Yandex.Direct advertisement provider.
These settings are specific to the Yandex.Direct advertising platform.
Field |
Description |
enable |
bool Enables or disables Partner Ad for both Live and VOD content. |
page_id |
int64 Yandex.Direct page identifier. |
category |
int64 Yandex.Direct category identifier. |
RefererVerificationSettings
Settings for HTTP Referer verification to control where content can be embedded.
When enabled, the system checks the HTTP Referer request header to ensure
that content is only embedded on allowed domains.
Field |
Description |
enable |
bool Enables or disables Referer verification for this channel. |
allowed_domains[] |
string List of domains allowed to embed content from this channel. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"channel_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"organization_id": "string",
"title": "string",
"description": "string",
"default_style_preset_id": "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"
]
}
}
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
created_at |
Creation timestamp. |
created_by |
string ID of the user or service account who initiated the operation. |
modified_at |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateChannelMetadata
Field |
Description |
channel_id |
string ID of the channel being created. |
Channel
Root entity for content organization and separation within the video platform.
A channel serves as a container for videos and streams, providing a way to
group related content and apply common settings and access controls.
Each channel belongs to a specific organization and can have its own
configuration for advertisements, content cleanup, and embedding restrictions.
Field |
Description |
id |
string Unique identifier of the channel. |
organization_id |
string Identifier of the organization to which this channel belongs. |
title |
string Title of the channel displayed in interfaces. |
description |
string Detailed description of the channel's purpose and content. |
default_style_preset_id |
string Identifier of the default style preset applied to videos in this channel. |
created_at |
Timestamp when the channel was initially created. |
updated_at |
Timestamp of the last modification to the channel or its settings. |
labels |
object (map<string, string>) Custom user-defined labels as |
settings |
Configuration settings for the channel's behavior and features. |
ChannelSettings
Configuration settings for the channel's behavior and features.
These settings apply to all content in the channel and control
various aspects of how the channel and its content behave.
Field |
Description |
advertisement |
Settings for advertisement display and behavior. |
referer_verification |
Settings for HTTP Referer verification to control content embedding. |
AdvertisementSettings
Settings for advertisement display and behavior in the channel.
These settings control whether and how advertisements are shown
with content in this channel, including both videos and streams.
Field |
Description |
yandex_direct |
Yandex.Direct advertisement provider settings. Includes only one of the fields Specifies the advertisement provider to use. |
YandexDirect
Configuration for the Yandex.Direct advertisement provider.
These settings are specific to the Yandex.Direct advertising platform.
Field |
Description |
enable |
bool Enables or disables Partner Ad for both Live and VOD content. |
page_id |
int64 Yandex.Direct page identifier. |
category |
int64 Yandex.Direct category identifier. |
RefererVerificationSettings
Settings for HTTP Referer verification to control where content can be embedded.
When enabled, the system checks the HTTP Referer request header to ensure
that content is only embedded on allowed domains.
Field |
Description |
enable |
bool Enables or disables Referer verification for this channel. |
allowed_domains[] |
string List of domains allowed to embed content from this channel. |