CommentThreads: list

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

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

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

Запрос

HTTP-запрос

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

Параметры

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

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

В списке ниже приведены названия part, которые можно включить в значение параметра.
  • id
  • replies
  • snippet
Фильтры (укажите ровно один из следующих параметров)
allThreadsRelatedToChannelId string
Параметр allThreadsRelatedToChannelId указывает API, что нужно вернуть все цепочки комментариев, связанные с указанным каналом.
id string
Параметр id представляет собой список идентификаторов цепочек комментариев, разделенных запятыми.
videoId string
Параметр videoId указывает API вернуть цепочки комментариев, связанные с указанным идентификатором видео.
Необязательные параметры
maxResults unsigned integer
Параметр maxResults определяет максимальное количество элементов, которые должны быть возвращены в наборе результатов.

Примечание. Этот параметр не поддерживается для использования в сочетании с параметром id. Допустимые значения: от 1 до 100 включительно. Значение по умолчанию: 20.
moderationStatus string
Этот параметр можно использовать только в авторизованном запросе. Этот параметр позволяет ограничить возвращаемые цепочки комментариев определенным статусом модерации.

Примечание. Этот параметр не поддерживается для использования вместе с параметром id. Значение по умолчанию – published.

Допустимые значения:
  • heldForReview – получить цепочки комментариев, ожидающие проверки модератором. Цепочка комментариев может быть включена в ответ, если комментарий верхнего уровня или хотя бы один из ответов на него ожидает проверки.
  • likelySpam – получить цепочки комментариев, которые, вероятно, являются спамом. Цепочка комментариев может быть включена в ответ, если комментарий верхнего уровня или хотя бы один из ответов на него считается спамом.
  • published – получение цепочек опубликованных комментариев. Это значение используется по умолчанию. Цепочка комментариев может быть включена в ответ, если ее комментарий верхнего уровня был опубликован.
order string
Параметр order определяет порядок, в котором API должен перечислять цепочки комментариев в ответе. Допустимые значения:
  • time – цепочки комментариев отсортированы по времени. Такая сортировка используется по умолчанию.
  • relevance – цепочки комментариев отсортированы по релевантности.
Примечание. Этот параметр не поддерживается при использовании вместе с параметром id.
pageToken string
Параметр pageToken определяет конкретную страницу в наборе результатов, которую необходимо вернуть. В ответе API свойство nextPageToken указывает на следующую страницу результатов, которую можно получить.

Примечание. Этот параметр не поддерживается для использования в сочетании с параметром id.
searchTerms string
Параметр searchTerms указывает, что в ответе API должны быть только комментарии, содержащие заданные поисковые запросы.

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

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

Тело запроса

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

Ответ

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

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

Свойства

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

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

Ошибки

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

Тип ошибки Сведения об ошибке Описание
badRequest (400) operationNotSupported Фильтр id совместим только с комментариями, основанными на Google+.
badRequest (400) processingFailure Серверу API не удалось обработать запрос. Хотя эта ошибка может быть временной, обычно она указывает на то, что входные данные запроса недопустимы. Проверьте структуру ресурса commentThread в теле запроса.
forbidden (403) commentsDisabled Комментарии к видео, указанному в параметре videoId, отключены.
forbidden (403) forbidden Не удалось получить одну или несколько цепочек комментариев из-за недостаточных разрешений. Запрос может быть не авторизован.
notFound (404) channelNotFound Не удалось найти канал, указанный в параметре allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound Не удалось найти одну или несколько указанных цепочек комментариев. Проверьте значения параметра id в запросе.
notFound (404) videoNotFound Видео, указанное в параметре videoId, не найдено.

Попробовать

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