Une ressource comment
contient des informations sur un seul commentaire YouTube. Une ressource comment
peut représenter un commentaire sur une vidéo ou une chaîne. Il peut également s'agir d'un commentaire de premier niveau ou d'une réponse à un commentaire de premier niveau.
Méthodes
L'API accepte les méthodes suivantes pour les ressources comments
:
- list
- Renvoie une liste de commentaires correspondant aux paramètres de requête API. Essayer
- insérer
- Crée une réponse à un commentaire existant. Remarque:Pour créer un commentaire de premier niveau, utilisez la méthode
commentThreads.insert
. Essayer maintenant - mettre à jour
- Modifie un commentaire. Essayer
- supprimer
- Supprime un commentaire. Essayer
- setModerationStatus
- Définit l'état de modération d'un ou de plusieurs commentaires. La demande API doit être autorisée par le propriétaire de la chaîne ou de la vidéo associée aux commentaires. Essayer
- marquer comme spam
- Remarque:Cette méthode est obsolète et n'est plus compatible.
- Indique à l'appelant qu'un ou plusieurs commentaires doivent être signalés comme spam.
Représentation des ressources
La structure JSON suivante illustre le format d'une ressource comments
:
{ "kind": "youtube#comment", "etag": etag, "id": string, "snippet": { "authorDisplayName": string, "authorProfileImageUrl": string, "authorChannelUrl": string, "authorChannelId": { "value": string }, "channelId": string, "videoId": string, "textDisplay": string, "textOriginal": string, "parentId": string, "canRate": boolean, "viewerRating": string, "likeCount": unsigned integer, "moderationStatus": string, "publishedAt": datetime, "updatedAt": datetime } }
Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:
Propriétés | |
---|---|
kind |
string Identifie le type de ressource API. La valeur est youtube#comment . |
etag |
etag Etag de cette ressource. |
id |
string ID utilisé par YouTube pour identifier le commentaire de manière unique. |
snippet |
object L'objet snippet contient des informations de base sur le commentaire. |
snippet.authorDisplayName |
string Nom à afficher de l'utilisateur qui a publié le commentaire. |
snippet.authorProfileImageUrl |
string URL de l'avatar de l'utilisateur qui a publié le commentaire. |
snippet.authorChannelUrl |
string URL de la chaîne YouTube de l'auteur du commentaire, si disponible. |
snippet.authorChannelId |
object Cet objet encapsule les informations sur la chaîne YouTube de l'auteur du commentaire, le cas échéant. |
snippet.authorChannelId.value |
string ID de la chaîne YouTube de l'auteur du commentaire, s'il est disponible. |
snippet.channelId |
string ID de la chaîne YouTube associée au commentaire.
|
snippet.videoId |
string L'ID de la vidéo à laquelle le commentaire fait référence. Cette propriété n'est présente que si le commentaire a été publié sur une vidéo. |
snippet.textDisplay |
string Texte du commentaire. Le texte peut être récupéré en texte brut ou en HTML. (Les méthodes comments.list et commentThreads.list acceptent un paramètre textFormat , qui spécifie le format de texte souhaité.)Notez que même le texte brut peut différer du texte d'origine du commentaire. Par exemple, il peut remplacer les liens vers les titres des vidéos. |
snippet.textOriginal |
string Texte brut original du commentaire, tel qu'il a été publié ou mis à jour pour la dernière fois. Le texte d'origine n'est renvoyé que s'il est accessible à l'utilisateur authentifié, ce qui n'est garanti que si l'utilisateur est l'auteur du commentaire. |
snippet.parentId |
string Identifiant unique du commentaire parent. Cette propriété n'est définie que si le commentaire a été envoyé en tant que réponse à un autre commentaire. |
snippet.canRate |
boolean Ce paramètre indique si le spectateur actuel peut donner son avis sur le commentaire. |
snippet.viewerRating |
string La note que le spectateur a donnée à ce commentaire. Notez que cette propriété n'identifie pas actuellement les notes de dislike , bien que ce comportement soit susceptible de changer. En attendant, la valeur de la propriété est like si le spectateur a donné une note positive au commentaire. La valeur est none dans tous les autres cas, y compris si l'utilisateur a attribué une note négative au commentaire ou ne l'a pas évalué.Les valeurs valides pour cette propriété sont les suivantes :
|
snippet.likeCount |
unsigned integer Nombre total de "J'aime" (avis positifs) reçus par le commentaire. |
snippet.moderationStatus |
string État de modération du commentaire. Cette propriété n'est renvoyée que si la requête API a été autorisée par le propriétaire de la chaîne ou de la vidéo sur laquelle les commentaires demandés ont été publiés. De plus, notez que cette propriété n'est pas définie si la requête API a utilisé le paramètre de filtre id .Les valeurs valides pour cette propriété sont les suivantes :
|
snippet.publishedAt |
datetime Date et heure de publication initiale du commentaire. La valeur est spécifiée au format ISO 8601. |
snippet.updatedAt |
datetime Date et heure de la dernière mise à jour du commentaire. La valeur est spécifiée au format ISO 8601. |