Документация по API

В этой документации по API рассказывается, как планировать прямые трансляции и видеопотоки на YouTube с помощью YouTube Live Streaming API.

Типы ресурсов

LiveBroadcasts

Ресурс liveBroadcast представляет собой событие, которое будет транслироваться на YouTube в прямом эфире.

Дополнительную информацию об этом ресурсе можно найти в его представлении и списке свойств.

Метод HTTP-запрос Описание
URI, относящиеся к https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind Связывает трансляцию YouTube с потоком или удаляет существующую связь между ними. Трансляция может быть связана только с одним видеопотоком, но видеопоток может быть связан с несколькими трансляциями.
delete DELETE /liveBroadcasts Удаляет трансляцию.
insert POST /liveBroadcasts Создает трансляцию.
list GET /liveBroadcasts Возвращает список трансляций на YouTube, соответствующих параметрам запроса к API.
transition POST /liveBroadcasts/transition Изменяет статус трансляции на YouTube и запускает процессы, связанные с новым статусом. Например, когда вы меняете статус трансляции на testing, YouTube начинает передавать видео в поток мониторинга. Перед вызовом этого метода убедитесь, что свойство status.streamStatus для потока, связанного с трансляцией, имеет значение active.
update PUT /liveBroadcasts Обновляет трансляцию. Например, вы можете изменить настройки трансляции, заданные в объекте contentDetails ресурса liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint Вставляет рекламную паузу в прямую трансляцию. Временная точка может запустить рекламную паузу.

LiveChatBans

Ресурс liveChatBan идентифицирует пользователя YouTube и чат, в котором он заблокирован.

Дополнительную информацию об этом ресурсе можно найти в его представлении и списке свойств.

Метод HTTP-запрос Описание
URI, относящиеся к https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans Снимает запрет на участие в чате для определенного пользователя. Запрос к API должен быть авторизован владельцем канала или модератором чата, в котором была заблокирована запись.
insert POST /liveChat/bans Запрещает определенному пользователю писать в чат. Запрос к API должен быть авторизован владельцем канала или модератором чата, в котором была заблокирована запись.

LiveChatMessages

liveChatMessage – это ресурс, представляющий сообщение в чате YouTube Live. Ресурс может содержать сведения о сообщениях нескольких типов, включая недавно опубликованные текстовые сообщения и события фан-фандинга.

Функция чата включена по умолчанию для прямых трансляций и доступна, пока трансляция активна. (После окончания трансляции чат становится недоступен.)

Дополнительную информацию об этом ресурсе можно найти в его представлении и списке свойств.

Метод HTTP-запрос Описание
URI, относящиеся к https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages Удаляет сообщение чата. Запрос к API должен быть авторизован владельцем канала или модератором чата, в котором был заблокирован пользователь.
insert POST /liveChat/messages Добавляет сообщение в чат.
list GET /liveChat/messages Создание списка сообщений в чате трансляции для определенного чата.
streamList Включает потоковое подключение к серверу для получения сообщений чата с низкой задержкой.

LiveChatModerators

Ресурс liveChatModerator представляет модератора чата YouTube Live. Модератор чата может блокировать и разблокировать пользователей, удалять сообщения и выполнять другие административные действия в чате.

Дополнительную информацию об этом ресурсе можно найти в его представлении и списке свойств.

Метод HTTP-запрос Описание
URI, относящиеся к https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Удаляет модератора чата. Запрос должен быть авторизован владельцем канала, на котором проводится трансляция.
insert POST /liveChat/moderators Добавляет нового модератора чата. Запрос должен быть авторизован владельцем канала, на котором проводится трансляция.
list GET /liveChat/moderators Возвращает список модераторов чата. Запрос должен быть авторизован владельцем канала, на котором проводится трансляция.

LiveStreams

Ресурс liveStream содержит информацию о видеопотоке, который вы передаете на YouTube. Поток содержит контент, который будет транслироваться пользователям YouTube. После создания ресурс liveStream можно связать с одним или несколькими ресурсами liveBroadcast.

Дополнительную информацию об этом ресурсе можно найти в его представлении и списке свойств.

Метод HTTP-запрос Описание
URI, относящиеся к https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams Удаляет видеопоток.
insert POST /liveStreams Создает видеопоток. Поток позволяет отправлять видео на YouTube, а платформа транслирует его зрителям.
list GET /liveStreams Возвращает список видеопотоков, соответствующих параметрам запроса к API.
update PUT /liveStreams Обновляет видеопоток. Если свойства, которые вы хотите изменить, нельзя обновить, вам нужно создать новый поток с правильными настройками.

SuperChatEvents

Ресурс superChatEvent представляет сообщение Суперчата, купленное поклонником во время YouTube Live. Сообщения Суперчата отличаются от обычных двумя особенностями:

  • Сообщения Суперчата выделяются цветом.
  • Сообщения Суперчата остаются закрепленными в бегущей строке в течение определенного времени.

Цвет сообщения, время его закрепления в тикете и максимальная длина зависят от суммы покупки. Подробнее о Суперчате рассказывается в Справочном центре YouTube.

Дополнительную информацию об этом ресурсе можно найти в его представлении и списке свойств.

Метод HTTP-запрос Описание
URI, относящиеся к https://www.googleapis.com/youtube/v3
list GET /superChatEvents Список событий Суперчата из трансляций канала за последние 30 дней.