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 указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров 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.