Video API, gRPC: ChannelService.List

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

Обновлена 8 августа 2025 г.

gRPC request
ListChannelsRequest
ListChannelsResponse
Channel
ChannelSettings
AdvertisementSettings
YandexDirect
RefererVerificationSettings

Lists all channels in a specific organization with pagination support.
Results can be filtered and sorted using the provided parameters.

gRPC request

rpc List (ListChannelsRequest) returns (ListChannelsResponse)

ListChannelsRequest

{
  "organization_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "order_by": "string",
  "filter": "string"
}

Field	Description
organization_id	string Required field. ID of the organization containing the channels to list.
page_size	int64 The maximum number of channels to return per page.
page_token	string Page token for retrieving the next page of results. This token is obtained from the next_page_token field in the previous ListChannelsResponse.
order_by	string Specifies the ordering of results. Format is " " (e.g., "createdAt desc"). Default: "id asc". Supported fields: ["id", "title", "createdAt", "updatedAt"]. Both snake_case and camelCase field names are supported.
filter	string Filter expression to narrow down the list of returned channels. Expressions consist of terms connected by logical operators. Values containing spaces or quotes must be enclosed in quotes (`'` or `"`) with inner quotes being backslash-escaped. Supported logical operators: ["AND", "OR"]. Supported comparison operators: ["=", "!=", ":"] where ":" enables substring matching. Parentheses can be used to group logical expressions. Example: `title:'news' AND id!='channel-123'` Filterable fields: ["id", "title"]. Both snake_case and camelCase field names are supported.

ListChannelsResponse

{
  "channels": [
    {
      "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"
          ]
        }
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

channels[]

Channel

List of channels matching the request criteria.
May be empty if no channels match the criteria or if the organization has no channels.

next_page_token

string

Token for retrieving the next page of results.
Empty if there are no more results available.

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.
organization_id	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.
default_style_preset_id	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.
created_at	google.protobuf.Timestamp Timestamp when the channel was initially created. This value is set automatically by the system and cannot be modified.
updated_at	google.protobuf.Timestamp Timestamp of the last modification to the channel or its settings. This value is updated automatically whenever the channel is modified.
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

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.

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.

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

Video API, gRPC: ChannelService.List

gRPC requestgRPC request

ListChannelsRequestListChannelsRequest

ListChannelsResponseListChannelsResponse

ChannelChannel

ChannelSettingsChannelSettings

AdvertisementSettingsAdvertisementSettings

YandexDirectYandexDirect

RefererVerificationSettingsRefererVerificationSettings

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

gRPC request

ListChannelsRequest

ListChannelsResponse

Channel

ChannelSettings

AdvertisementSettings

YandexDirect

RefererVerificationSettings