LiveBroadcasts: list

Возвращает список трансляций YouTube, соответствующих параметрам запроса API.

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

Запрос

HTTP-запрос

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

Авторизация

Для этого запроса требуется авторизация хотя бы с одной из следующих областей. Дополнительные сведения об аутентификации и авторизации см. в разделе «Реализация аутентификации OAuth 2.0» .

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

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part указывает разделенный запятыми список одного или нескольких с��ойств ресурса liveBroadcast , которые будут включены в ответ API. Имена part , которые вы можете включить в значение параметра: id , snippet , contentDetails , monetizationDetails и status .
Фильтры (укажите ровно один из следующих параметров)
broadcastStatus string
Параметр broadcastStatus фильтрует ответ API, включив в него только широковещательные сообщения с указанным статусом.

Приемлемые значения:
  • active — возврат текущих прямых трансляций.
  • all – вернуть все трансляции.
  • completed — вернуть трансляции, которые уже закончились.
  • upcoming — возврат трансляций, которые еще не начались.
id string
Параметр id указывает список идентификаторов трансляций YouTube, разделенных запятыми, которые идентифицируют извлекаемые трансляции. В ресурсе liveBroadcast свойство id указывает идентификатор трансляции.
mine boolean
Параметр mine можно использовать, чтобы указать API возвращать только широковещательные сообщения, принадлежащие аутентифицированному пользователю. Установите для параметра значение true , чтобы получать только свои собственные трансляции.
Дополнительные параметры
broadcastType string
Параметр broadcastType фильтрует ответ API, включив в него только широковещательные сообщения указанного типа. Этот параметр следует использовать в запросах, которые устанавливают для параметра mine значение true или используют параметр broadcastStatus . Значение по умолчанию — event .

Приемлемые значения:
  • all – вернуть все трансляции.
  • event — возвращать только запланированные трансляции событий.
  • persistent — возвращать только постоянные широковещательные сообщения.
maxResults unsigned integer
Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в наборе результатов. Допустимые значения: от 0 до 50 включительно. Значение по умолчанию — 5 .
onBehalfOfContentOwner string
Этот параметр можно использовать только в должным образом авторизованном запросе .
Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

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

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

Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Он позволяет владельцам контента один раз пройти аутентификацию и выполнять действия от имени канала, указанного в значении параметра, без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала.
pageToken string
Параметр pageToken идентифицирует конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken идентифицируют другие страницы, которые можно получить.

Тело запроса

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

Ответ

В случае успеха этот метод возвращает тело ответа следующей структуры:

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

Характеристики

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

Характеристики
kind string
Идентифицирует тип ресурса API. Значением будет youtube#liveBroadcastListResponse .
etag etag
Этаг этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в наборе результатов.
prevPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения предыдущей страницы в наборе результатов.
pageInfo object
Объект pageInfo инкапсулирует информацию о подкачке для набора результатов.
pageInfo. totalResults integer
Общее количество результатов в наборе результатов.
pageInfo. resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список трансляций, соответствующих критериям запроса.

Ошибки

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

Тип ошибки Детализация ошибки Описание
insufficientPermissions insufficientLivePermissions Запрос не авторизован для получения прямой трансляции.
insufficientPermissions liveStreamingNotEnabled Пользователь, авторизовавший запрос, не имеет права транслировать видео в реальном времени на YouTube. Дополнительную информацию см. в разделе «Приемлемость функций» .

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

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