Comments: list

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

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

Распространенные случаи использования

Запрос

HTTP-запрос

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

Параметры

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

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

Следующий список содержит названия part , которые можно включить в значение параметра:
  • id
  • snippet
Фильтры (укажите ровно один из следующих параметров)
id string
Параметр id указывает разделенный запятыми список идентификаторов комментариев для извлекаемых ресурсов. В ресурсе comment свойство id указывает идентификатор комментария.
parentId string
Параметр parentId указывает идентификатор комментария, для которого необходимо получить ответы.

Примечание. В настоящее время YouTube поддерживает ответы только на комментарии верхнего уровня. Однако ответы на ответы могут поддерживаться в будущем.
Дополнительные параметры
maxResults unsigned integer
Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в наборе результатов.

Примечание. Этот параметр не поддерживается для использования вместе с параметром id . Допустимые значения: от 1 до 100 включительно. Значение по умолчанию — 20 .
pageToken string
Параметр pageToken идентифицирует конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойство nextPageToken определяет следующую страницу результата, которую можно получить.

Примечание. Этот параметр не поддерживается для использования вместе с параметром id .
textFormat string
Этот параметр указывает, должен ли API возвращать комментарии в формате HTML или в виде обычного текста. Значение по умолчанию — html .

Приемлемые значения:
  • html — возвращает комментарии в формате HTML. Это значение по умолчанию.
  • plainText — возвращает комментарии в текстовом формате.

Тело запроса

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

Ответ

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

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

Характеристики

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

Характеристики
kind string
Идентифицирует тип ресурса API. Значением будет youtube#commentListResponse .
etag etag
Etag этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в наборе результатов.
pageInfo object
Объект pageInfo инкапсулирует информацию о подкачке для набора результатов.
pageInfo. totalResults integer
Общее количество результатов в наборе результатов.
pageInfo. resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список комментариев, соответствующих критериям запроса.

Ошибки

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

Тип ошибки Детализация ошибки Описание
badRequest (400) operationNotSupported Фильтр идентификаторов совместим только с комментариями на основе Google+.
forbidden (403) forbidden Один или несколько запрошенных комментариев не могут быть получены из-за недостаточности разрешений. Возможно, запрос не авторизован должным образом.
notFound (404) commentNotFound Невозможно найти один или несколько указанных комментариев. Проверьте значения параметров id и parentId запроса, чтобы убедиться, что они верны.

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

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.