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

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

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

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 и чат YouTube, в котором этому пользователю запрещено участвовать.

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

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

LiveChatMessages

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

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

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

Метод 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. Модератор чата может блокировать и разблокировать пользователей, удалять сообщения и выполнять другие административные действия в онлайн-чате.

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

Метод 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 представляет собой сообщение SuperChat, приобретённое фанатом во время прямой трансляции на YouTube. В прямой трансляции чата на YouTube сообщения SuperChat выделяются среди других сообщений двумя способами:

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

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

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

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