Videos: batchGetStats

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

Влияние на квоту. Вызов этого метода расходует 1 единицу квоты.

Запрос

HTTP-запрос

GET https://www.googleapis.com/youtube/v3/videos:batchGetStats

Авторизация

Для работы с видео, не являющимися общедоступными, требуется аутентификация. Если авторизация предоставлена, запрос должен быть авторизован по крайней мере с одной из следующих областей действия (подробнее об аутентификации и авторизации).

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

Параметры

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

Параметры
Обязательные параметры
id string
Параметр id задает список идентификаторов видео на YouTube, разделенных запятыми, для ресурсов, которые нужно получить. В ресурсе videoStat свойство id указывает идентификатор видео.
part string
Параметр part определяет список из одного или нескольких свойств ресурса videoStat, разделенных запятыми, которые будут включены в ответ API.

В списке ниже приведены названия part, которые можно включить в значение параметра.
  • contentDetails
  • id
  • snippet
  • statistics
Необязательные параметры
onBehalfOfContentOwner string
Этот параметр можно использовать только в авторизованном запросе. Примечание. Этот параметр предназначен исключительно для партнеров YouTube по контенту.

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

Тело запроса

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

Ответ

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

{
  "kind": "youtube#batchGetStatsResponse",
  "etag": etag,
  "items": [
    {
      "kind": "youtube#videoStats",
      "etag": etag,
      "id": string,
      "snippet": {
        "publishTime": datetime
      },
      "statistics": {
        "viewCount": unsigned long,
        "likeCount": unsigned long,
        "commentCount": unsigned long
      },
      "contentDetails": {
        "duration": string,
        "durationMillis": unsigned long
      }
    }
  ],
  "summary": {
    "requestedVideoCount": unsigned long,
    "succeededVideoCount": unsigned long,
    "failedVideoCount": unsigned long,
    "failedVideoIds": [
      string
    ]
  }
}

Свойства

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

Свойства
kind string
Тип ресурса API. Значение будет youtube#batchGetStatsResponse.
etag etag
Тег Etag этого ресурса.
items[] list
Список статистики видео, соответствующей критериям запроса.
items[].id string
Идентификатор, который YouTube использует для уникальной идентификации видео.
items[].snippet.publishTime datetime
Дата и время загрузки видео.
items[].statistics.viewCount unsigned long
Количество просмотров видео.
items[].statistics.likeCount unsigned long
Количество пользователей, которым понравилось видео.
items[].statistics.commentCount unsigned long
Количество комментариев к видео.
items[].contentDetails.duration string
Продолжительность видео.
items[].contentDetails.durationMillis unsigned long
Продолжительность видео в миллисекундах.
summary object
Сводка по запросу batchGetStats.
summary.requestedVideoCount unsigned long
Количество запрошенных видео.
summary.succeededVideoCount unsigned long
Количество видео, которые удалось обработать.
summary.failedVideoCount unsigned long
Количество видео, которые не удалось обработать.
summary.failedVideoIds[] list
Идентификаторы видео, которые не удалось обработать.

Ошибки

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