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

Sponsors

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

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

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

SuperChatEvents

Ресурс superChatEvent представляет собой сообщение Super Chat, купленное фанатом во время прямой трансляции на YouTube. В прямом эфире чата на YouTube суперчаты выделяются среди других сообщений двумя способами:

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

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

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

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

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

FanFundingEvents

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

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

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