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