Связаться с намиПодключиться

Video API, REST: Channel.Get

Статья создана
Обновлена 25 ноября 2025 г.

Retrieves detailed information about a specific channel by its ID.
Returns all channel metadata, settings, and related information.

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 to retrieve.

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "organizationId": "string",
  "title": "string",
  "description": "string",
  "defaultStylePresetId": "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 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.
This ID is used to reference the channel in API calls and URLs.

organizationId

string

Identifier of the organization to which this channel belongs.
Each channel must be associated with exactly one organization.

title

string

Title of the channel displayed in interfaces.
This is the primary display name shown to users.

description

string

Detailed description of the channel's purpose and content.
This optional field provides additional context about the channel.

defaultStylePresetId

string

Identifier of the default style preset applied to videos in this channel.
Videos, episodes, and playlists created in this channel
inherit this preset unless explicitly overridden.

createdAt

string (date-time)

Timestamp when the channel was initially created.
This value is set automatically by the system and cannot be modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Timestamp of the last modification to the channel or its settings.
This value is updated automatically whenever the channel is modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Custom user-defined labels as key:value pairs.
Maximum 64 labels per channel.
Labels can be used for organization, filtering, and metadata purposes.

settings

ChannelSettings

Configuration settings for the channel's behavior and features.
These settings control advertisements, content cleanup policies,
and embedding restrictions for all content in the channel.

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.

refererVerification

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.

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

yandexDirect

YandexDirect

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

Includes only one of the fields yandexDirect.

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

boolean

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.

pageId

string (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

string (int64)

Yandex.Direct category identifier.
This ID is used to categorize the channel's content for
appropriate advertisement targeting and compliance.

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

boolean

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.

allowedDomains[]

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.

Each value must match the regular expression ^(?:\*\.)?(?:[a-zA-Z0-9-]*\.)+[a-zA-Z]{2,}$\|^\*\.[a-zA-Z]{2,}$. The string length in characters for each value must be 4-255. The maximum number of elements is 100.
Предыдущая
Overview
Следующая
List