LiveStreams: list

Возвращает список видеопотоков, соответствующих параметрам запроса к API.

Примеры использования

Запрос

HTTP-запрос

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

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей доступа. Подробнее…

Область действия
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part определяет список свойств ресурса liveStream, разделенных запятыми, которые будут включены в ответ API. В качестве значения параметра можно указать следующие названия part: id, snippet, cdn и status.
Фильтры (укажите ровно один из следующих параметров)
id string
Параметр id задает список идентификаторов трансляций YouTube, разделенных запятыми. В ресурсе liveStream свойство id указывает идентификатор трансляции.
mine boolean
Этот параметр можно использовать только в авторизованном запросе. Параметр mine можно использовать, чтобы API возвращал только потоки, принадлежащие аутентифицированному пользователю. Чтобы получать только свои трансляции, задайте для параметра значение true.
Необязательные параметры
maxResults unsigned integer
Параметр maxResults задает максимальное количество объектов, которые должны быть возвращены в наборе результатов. Допустимые значения: от 0 до 50 включительно. Значение по умолчанию – 5.
onBehalfOfContentOwner string
Этот параметр можно использовать только в авторизованном запросе. Примечание. Этот параметр предназначен исключительно для партнеров YouTube по контенту.

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

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

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

Тело запроса

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

Ответ

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

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

Свойства

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

Свойства
kind string
Определяет тип ресурса API. Значение будет youtube#liveStreamListResponse.
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 и ответ.