Video API, gRPC: ChannelService.Create

Статья создана

Yandex Cloud

Обновлена 28 мая 2026 г.

gRPC request
CreateChannelRequest
ChannelSettings
AdvertisementSettings
YandexDirect
RefererVerificationSettings
ChannelVideoSettings
operation.Operation

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"
      ]
    },
    "video": {
      "show_source_file_before_transcoding": "bool"
    }
  }
}

Field	Description
organization_id	string Required field. ID of the organization where the channel will be created. The maximum string length in characters is 50.
title	string Required field. Title of the channel to be displayed in interfaces. The maximum string length in characters is 300.
description	string Detailed description of the channel's purpose and content. The maximum string length in characters is 4000.
labels	object (map<string, string>) Custom user-defined labels as key:value pairs. Maximum 64 labels per channel. Keys must be lowercase alphanumeric strings with optional hyphens/underscores. Values can contain alphanumeric characters and various symbols. The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_.@:/0-9a-zA-Z]`. No more than 64 per resource.
settings	ChannelSettings Configuration settings for the channel's behavior and features. Includes settings for advertisements, content cleanup, and Referer verification.

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	AdvertisementSettings Settings for advertisement display and behavior. Controls whether and how advertisements are shown with content in this channel. If not specified, default advertisement settings are applied.
referer_verification	RefererVerificationSettings Settings for HTTP Referer verification to control content embedding. Restricts which domains can embed content from this channel. If not specified or disabled, content can be embedded on any domain.
video	ChannelVideoSettings Settings for displaying video

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

YandexDirect

Yandex.Direct advertisement provider settings.
When specified, advertisements will be served through Yandex.Direct.

Includes only one of the fields yandex_direct.

Specifies the advertisement provider to use.
Only one provider can be active at a time.

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. When set to true, advertisements will be shown with content. When set to false, no advertisements will be shown.
page_id	int64 Yandex.Direct page identifier. This ID is used to associate the channel with a specific page in the Yandex.Direct system for targeting and reporting.
category	int64 Yandex.Direct category identifier. This ID is used to categorize the channel's content for appropriate advertisement targeting and compliance.

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.
When set to true, only requests from allowed domains will be permitted.
When set to false, content can be embedded on any domain.

allowed_domains[]

string

List of domains allowed to embed content from this channel.
Only relevant when enable is set to true.
Supports wildcard notation (e.g., "*.example.com") to allow all subdomains.

The string length in characters for each value must be 4-255. Each value must match the regular expression ^(?:\*\.)?(?:[a-zA-Z0-9-]*\.)+[a-zA-Z]{2,}$|^\*\.[a-zA-Z]{2,}$. The maximum number of elements is 100.

ChannelVideoSettings

Settings for displaying video

Field

Description

show_source_file_before_transcoding

bool

Instruct the player to allow playback of the raw source file while
transcoding is in progress. Once a transcoded version is available,
the source file will no longer be used.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Video API, gRPC: ChannelService.Create

gRPC requestgRPC request

CreateChannelRequestCreateChannelRequest

ChannelSettingsChannelSettings

AdvertisementSettingsAdvertisementSettings

YandexDirectYandexDirect

RefererVerificationSettingsRefererVerificationSettings

ChannelVideoSettingsChannelVideoSettings

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

CreateChannelRequest

ChannelSettings

AdvertisementSettings

YandexDirect

RefererVerificationSettings

ChannelVideoSettings

operation.Operation