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 вернуть все потоки комментариев, связанные с указанным каналом. Ответ может включать комментарии о канале или видео на канале.
channelId string
Параметр channelId указывает 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
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 Не удалось найти канал, указанный параметром channelId или параметром allThreadsRelatedToChannelId .
notFound (404) commentThreadNotFound Не удается найти одну или несколько указанных цепочек комментариев. Проверьте значения параметра id запроса, чтобы убедиться в их правильности.
notFound (404) videoNotFound Не удалось найти видео, указанное параметром videoId .

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

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