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 Фильтр id совместим только с комментариями, основанными на Google+.
forbidden (403) forbidden Не удалось получить один или несколько запрошенных комментариев из-за недостаточных разрешений. Запрос может быть не авторизован.
notFound (404) commentNotFound Не удалось найти один или несколько указанных комментариев. Проверьте значения параметров id и parentId в запросе.

Попробовать

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