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 CMS, действующего от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для партнеров 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, перечисленные в документации к сообщениям об ошибках .