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 ограничить ответ 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
Этаг этого ресурса.
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.