LiveBroadcasts: control

Примечание. Метод liveBroadcasts.control устарел и перестанет работать 1 октября 2020 года или после этой даты. После этой даты все вызовы этого метода будут возвращать запрещенную ошибку (403), а позже метод будет полностью удален.

Клиенты по-прежнему могут реализовать собственное планирование, добавив наложение к видео, отправленному на серверы приема YouTube. См. объявление об устаревании .

Управляет настройками заставки, которая может отображаться в потоке трансляции.

Распространенные случаи использования

Запрос

HTTP-запрос

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

Авторизация

Этот запрос требует авторизации хотя бы в одной из следующих областей ( подробнее об аутентификации и авторизации читайте здесь ).

Объем
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.

Параметры
Обязательные параметры
id string
Параметр id указывает идентификатор прямой трансляции YouTube, который уникально идентифицирует трансляцию, в которой обновляется презентация.
part string
Параметр part указывает разделенный запятыми список одного или нескольких свойств ресурса liveBroadcast , которые будут включены в ответ API. Имена part , которые вы можете включить в значение параметра: id , snippet , contentDetails и status .
Дополнительные параметры
displaySlate boolean
Параметр displaySlate указывает, включена или отключена грифельная доска.
offsetTimeMs unsigned long
Параметр offsetTimeMs указывает положительное смещение времени, когда произойдет указанное изменение расписания. Значение измеряется в миллисекундах от начала потока мониторинга трансляции, то есть времени начала фазы тестирования трансляции. Несмотря на то, что оно указано в миллисекундах, на самом деле это значение является приблизительным, и YouTube выполняет запрошенное действие как можно ближе к этому времени.

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

Важно: вам следует указывать значение для этого параметра только в том случае, если ваш широковещательный поток задерживается.
onBehalfOfContentOwner string
Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube.
onBehalfOfContentOwnerChannel string
Этот параметр можно использовать только в должным образом авторизованном запросе . Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

Параметр onBehalfOfContentOwnerChannel указывает идентификатор канала YouTube, на который добавляется видео. Этот параметр является обязательным, если в запросе указано значение параметра onBehalfOfContentOwner , и его можно использовать только вместе с этим параметром. Кроме того, запрос должен быть авторизован с использованием учетной записи CMS, связанной с владельцем контента, указанным в параметре onBehalfOfContentOwner . Наконец, канал, указанный в значении параметра onBehalfOfContentOwnerChannel , должен быть связан с владельцем контента, указанным в параметре onBehalfOfContentOwner .

Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Он позволяет владельцам контента один раз пройти аутентификацию и выполнять действия от имени канала, указанного в значении параметра, без необходимости предоставления учетных данных аутентификации для каждого отдельного канала.
walltime datetime
Параметр walltime указывает время на настенных часах, в которое произойдет указанное изменение списка. Значение указывается в формате ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ).

Тело запроса

Не указывайте тело запроса при вызове этого метода.

Ответ

В случае успеха этот метод возвращает ресурс liveBroadcast в теле ответа.

Ошибки

В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .

Тип ошибки Детализация ошибки Описание
backendError errorDisplaySlate Произошла ошибка при выполнении запрошенного действия.
forbidden (403) liveBroadcastControlNotAllowed Запрошенное действие разрешено только в том случае, если статус трансляции — « live трансляция».
insufficientPermissions insufficientLivePermissions Пользователь не авторизован для выполнения запрошенной операции, возможно, потому, что у него нет разрешения на потоковую трансляцию.
insufficientPermissions liveStreamingNotEnabled Пользователь, авторизовавший запрос, не имеет права транслировать видео в реальном времени на YouTube. Пользователь может найти дополнительную информацию по адресу https://www.youtube.com/features .
invalidValue (400) conflictingTimeFields Можно указать только одно из offsetTimeMs и walltime .
invalidValue (400) invalidOffsetTimeMs Недопустимое значение параметра offsetTimeMs . Значение параметра должно быть положительным, но параметр можно указать только в том случае, если включен поток мониторинга трансляции.
invalidValue (400) invalidWalltime Недопустимое значение параметра walltime .
notFound (404) liveBroadcastNotFound Широковещательная рассылка, указанная параметром id , не существует.
required (400) actionRequired В запросе API необходимо указать хотя бы одно действие. В настоящее время единственным поддерживаемым действием является возможность включения или отключения планшета.
required (400) idRequired Обязательный параметр id должен идентифицировать обновляемую трансляцию.

Попробуй это!

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.