Ресурс comment содержит информацию об одном комментарии на YouTube. comment может представлять собой комментарий к видео или каналу. Кроме того, это может быть комментарий первого уровня или ответ на него.
Методы
API поддерживает следующие методы для ресурсов comments:
- list
- Возвращает список комментариев, соответствующих параметрам запроса к API. Перейти
- insert
- Создает ответ на существующий комментарий. Примечание. Чтобы создать комментарий верхнего уровня, используйте метод
commentThreads.insert. Попробовать - update
- Изменяет комментарий. Перейти
- delete
- Удаляет комментарий. Перейти
- setModerationStatus
- Задает статус модерации для одного или нескольких комментариев. Запрос к API должен быть авторизован владельцем канала или видео, с которыми связаны комментарии. Перейти
Представление ресурса
Ниже показана структура JSON для ресурса comments.
{
"kind": "youtube#comment",
"etag": etag,
"id": string,
"snippet": {
"authorDisplayName": string,
"authorProfileImageUrl": string,
"authorChannelUrl": string,
"authorChannelId": {
"value": string
},
"channelId": string,
"textDisplay": string,
"textOriginal": string,
"parentId": string,
"canRate": boolean,
"viewerRating": string,
"likeCount": unsigned integer,
"moderationStatus": string,
"publishedAt": datetime,
"updatedAt": datetime,
"imageUrl": string
}
}Свойства
В таблице ниже описаны свойства, которые появляются в этом ресурсе.
| Свойства | |
|---|---|
kind |
stringТип ресурса API. Значение будет youtube#comment. |
etag |
etagТег ETag этого ресурса. |
id |
stringИдентификатор, который YouTube использует для уникальной идентификации комментария. |
snippet |
objectОбъект snippet содержит основные сведения о комментарии. |
snippet.authorDisplayName |
stringОтображаемое имя пользователя, который опубликовал комментарий. |
snippet.authorProfileImageUrl |
stringURL аватара пользователя, который опубликовал комментарий. |
snippet.authorChannelUrl |
stringURL канала автора комментария (если доступен). |
snippet.authorChannelId |
objectЭтот объект содержит информацию о канале YouTube автора комментария, если она доступна. |
snippet.authorChannelId.value |
stringИдентификатор канала YouTube, принадлежащего автору комментария (если доступен). |
snippet.channelId |
stringИдентификатор канала YouTube, связанного с комментарием. |
snippet.textDisplay |
stringТекст комментария. Текст можно получить в виде обычного текста или HTML-кода. (Методы comments.list и commentThreads.list поддерживают параметр textFormat, который определяет выбранный формат текста.)Даже обычный текст может отличаться от исходного текста комментария. Например, ссылки на видео могут быть заменены их названиями. |
snippet.textOriginal |
stringИсходный текст комментария в том виде, в котором он был опубликован или обновлен. Исходный текст возвращается только пользователю, прошедшему аутентификацию, если он является автором комментария. |
snippet.parentId |
stringУникальный идентификатор родительского комментария. Это свойство задается только в том случае, если комментарий был отправлен в ответ на другой комментарий. |
snippet.canRate |
booleanЭтот параметр указывает, может ли текущий зритель оценить комментарий. |
snippet.viewerRating |
stringОценка, которую зритель дал этому комментарию. Это свойство не идентифицирует оценки dislike, хотя такое поведение может измениться. Если зритель оценил комментарий положительно, свойство имеет значение like. В остальных случаях, в том числе если пользователь поставил комментарию отрицательную оценку или не оценил его, значение равно none.Допустимые значения этого свойства:
|
snippet.likeCount |
unsigned integerОбщее количество лайков (положительных оценок), полученных комментарием. |
snippet.moderationStatus |
stringСтатус модерации комментария. Это свойство возвращается только в том случае, если запрос к API был авторизован владельцем канала или видео, к которому относятся запрошенные комментарии. Кроме того, это свойство не задается, если в запросе к API использовался параметр фильтра id.Допустимые значения этого свойства:
|
snippet.publishedAt |
datetimeДата и время публикации комментария. Значение указывается в формате ISO 8601. |
snippet.updatedAt |
datetimeДата и время последнего обновления комментария. Значение указывается в формате ISO 8601. |
snippet.imageUrl |
stringURL изображения или анимированного GIF-файла, прикрепленного к комментарию (если есть). Это свойство присутствует только в том случае, если комментарий содержит изображение или GIF. URL предоставляется в виде подписанной ссылки со сроком действия шесть часов (TTL). По истечении этого времени ссылка становится недействительной. |