Эта страница переведена с помощью Cloud Translation API.

LiveBroadcasts: list

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

Общие варианты использования

Запрос

HTTP-запрос

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

Авторизация

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

Объем
`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` и `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` указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров 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` 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. Пользователь может найти дополнительную информацию на странице https://www.youtube.com/features .

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

Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.