Un recurso comment
contiene información sobre un solo comentario de YouTube. Un recurso comment
puede representar un comentario sobre un video o un canal. Además, el comentario puede ser de nivel superior o una respuesta a un comentario de nivel superior.
Métodos
La API admite los siguientes métodos para los recursos comments
:
- list
- Devuelve una lista de comentarios que coinciden con los parámetros de la solicitud a la API. Pruébala ahora.
- insertar
- Crea una respuesta a un comentario existente. Nota: Para crear un comentario de nivel superior, usa el método
commentThreads.insert
. Pruébalo ahora. - actualizar
- Modifica un comentario. Pruébala ahora.
- borrar
- Borra un comentario. Pruébala ahora.
- setModerationStatus
- Establece el estado de moderación de uno o más comentarios. El propietario del canal o del video asociado a los comentarios debe autorizar la solicitud a la API. Pruébala ahora.
Representación de recursos
En la siguiente estructura JSON, se muestra el formato de un recurso 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 } }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Identifica el tipo de recurso de la API. El valor será youtube#comment . |
etag |
etag Es el ETag de este recurso. |
id |
string Es el ID que YouTube usa para identificar de forma única el comentario. |
snippet |
object El objeto snippet contiene detalles básicos sobre el comentario. |
snippet.authorDisplayName |
string Es el nombre visible del usuario que publicó el comentario. |
snippet.authorProfileImageUrl |
string Es la URL del avatar del usuario que publicó el comentario. |
snippet.authorChannelUrl |
string URL del canal de YouTube del autor del comentario, si está disponible. |
snippet.authorChannelId |
object Este objeto encapsula información sobre el canal de YouTube del autor del comentario, si está disponible. |
snippet.authorChannelId.value |
string ID del canal de YouTube del autor del comentario, si está disponible. |
snippet.channelId |
string Es el ID del canal de YouTube asociado con el comentario. |
snippet.textDisplay |
string Es el texto del comentario. El texto se puede recuperar en formato HTML o de texto sin formato. (Los métodos comments.list y commentThreads.list admiten un parámetro textFormat , que especifica el formato de texto elegido).Incluso el texto sin formato puede diferir del texto original del comentario. Por ejemplo, puede reemplazar los vínculos de video por los títulos de los videos. |
snippet.textOriginal |
string Es el texto original sin procesar del comentario tal como se publicó inicialmente o se actualizó por última vez. El texto original solo se devuelve al usuario autenticado si es el autor del comentario. |
snippet.parentId |
string Es el ID único del comentario principal. Esta propiedad solo se establece si el comentario se envió como respuesta a otro comentario. |
snippet.canRate |
boolean Este parámetro de configuración indica si el usuario actual puede calificar el comentario. |
snippet.viewerRating |
string Es la calificación que el usuario le otorgó a este comentario. Esta propiedad no identifica las calificaciones de dislike , aunque este comportamiento está sujeto a cambios. Mientras tanto, el valor de la propiedad es like si el usuario calificó el comentario de forma positiva. El valor es none en todos los demás casos, incluido el caso en que el usuario le haya dado al comentario una calificación negativa o no lo haya calificado.Los valores válidos para esta propiedad son los siguientes:
|
snippet.likeCount |
unsigned integer Es la cantidad total de Me gusta (calificaciones positivas) que recibió el comentario. |
snippet.moderationStatus |
string Es el estado de moderación del comentario. Esta propiedad solo se devuelve si el propietario del canal o del video en el que se hicieron los comentarios solicitados autorizó la solicitud a la API. Además, esta propiedad no se establece si la solicitud a la API usó el parámetro de filtro id .Los valores válidos para esta propiedad son los siguientes:
|
snippet.publishedAt |
datetime Fecha y hora en que se publicó originalmente el comentario. El valor se especifica en formato ISO 8601. |
snippet.updatedAt |
datetime Fecha y hora en que se actualizó el comentario por última vez. El valor se especifica en formato ISO 8601. |