Документация по 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 Перечисляет сообщения живого чата для определенного чата.

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

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

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

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

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

Устаревшие типы ресурсов

FanFundingEvents

Ресурс fanFundingEvent представляет событие Fan Funding на канале YouTube. Функция «Фан-фандинг» позволяет оказывать денежную поддержку авторам YouTube. Событие Fan Funding происходит, когда пользователь совершает единоразовый добровольный платеж на канал. Посетите Справочный центр YouTube, чтобы узнать больше о пожертвованиях сообщества.

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

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents Перечисляет мероприятия, финансируемые фанатами для канала. Запрос API должен быть авторизован владельцем канала.

LiveCuepoints

Ресурс liveCuepoint запускает рекламную паузу в транслируемом видеопотоке.

Примечание. Команда API для управления точками разметки на самом деле является частью API Content ID YouTube и имеет другие требования к авторизации, чем запросы на управление ресурсами liveBroadcast и liveStream .

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

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/
insert POST /liveCuepoints Вставляет точку разметки в прямую трансляцию. В настоящее время запросы к этому методу должны быть авторизованы учетной записью, связанной с владельцем контента YouTube.

Sponsors

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

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

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/youtube/v3
list GET /sponsors Перечисляет спонсоров канала. Запрос API должен быть авторизован владельцем канала.