Um recurso comment
contém informações sobre um único comentário do YouTube. Um recurso comment
pode representar um comentário sobre um vídeo ou canal. Além disso, o comentário pode ser de nível superior ou uma resposta a um comentário de nível superior.
Métodos
A API oferece suporte aos seguintes métodos para recursos comments
:
- list
- Retorna uma lista de comentários que correspondem aos parâmetros de solicitação da API. Faça um teste agora.
- inserir
- Cria uma resposta a um comentário. Observação:para criar um comentário de nível superior, use o método
commentThreads.insert
. Teste agora. - update
- Modifica um comentário. Faça um teste agora.
- delete
- Exclui um comentário. Faça um teste agora.
- setModerationStatus
- Define o status de moderação de um ou mais comentários. A solicitação da API precisa ser autorizada pelo proprietário do canal ou do vídeo associado aos comentários. Faça um teste agora.
- markAsSpam
- Observação:este método foi descontinuado e não tem mais suporte.
- Expressa a opinião do autor da chamada de que um ou mais comentários devem ser sinalizados como spam.
Representação de recurso
A estrutura JSON a seguir mostra o formato de um 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 } }
Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
Propriedades | |
---|---|
kind |
string Identifica o tipo do recurso da API. O valor será youtube#comment . |
etag |
etag A Etag deste recurso. |
id |
string O ID que o YouTube usa para identificar o comentário de forma exclusiva. |
snippet |
object O objeto snippet contém detalhes básicos sobre o comentário. |
snippet.authorDisplayName |
string O nome de exibição do usuário que postou o comentário. |
snippet.authorProfileImageUrl |
string O URL do avatar do usuário que postou o comentário. |
snippet.authorChannelUrl |
string O URL do canal do YouTube do autor do comentário, se disponível. |
snippet.authorChannelId |
object Este objeto encapsula informações sobre o canal do YouTube do autor do comentário, se disponível. |
snippet.authorChannelId.value |
string O ID do canal do YouTube do autor do comentário, se disponível. |
snippet.channelId |
string O ID do canal do YouTube associado ao comentário. |
snippet.textDisplay |
string O texto do comentário. O texto pode ser recuperado em texto simples ou HTML. Os métodos comments.list e commentThreads.list oferecem suporte a um parâmetro textFormat , que especifica o formato de texto escolhido.Mesmo o texto simples pode ser diferente do texto original do comentário. Por exemplo, ele pode substituir links de vídeos por títulos de vídeos. |
snippet.textOriginal |
string O texto original do comentário, como foi postado inicialmente ou atualizado pela última vez. O texto original só será retornado ao usuário autenticado se ele for o autor do comentário. |
snippet.parentId |
string O ID exclusivo do comentário pai. Essa propriedade só é definida se o comentário foi enviado como uma resposta a outro comentário. |
snippet.canRate |
boolean Essa configuração indica se o leitor atual pode avaliar o comentário. |
snippet.viewerRating |
string A classificação que o espectador deu a esse comentário. Essa propriedade não identifica classificações dislike , mas esse comportamento está sujeito a mudanças. Enquanto isso, o valor da propriedade é like se o espectador avaliou o comentário positivamente. O valor é none em todos os outros casos, incluindo quando o usuário deu uma nota negativa ou não avaliou o comentário.Os valores válidos para essa propriedade são:
|
snippet.likeCount |
unsigned integer O número total de marcações "Gostei" (classificações positivas) que o comentário recebeu. |
snippet.moderationStatus |
string O status de moderação do comentário. Essa propriedade só é retornada se a solicitação da API foi autorizada pelo proprietário do canal ou do vídeo em que os comentários foram feitos. Além disso, essa propriedade não é definida se a solicitação da API usou o parâmetro de filtro id .Os valores válidos para essa propriedade são:
|
snippet.publishedAt |
datetime A data e a hora em que o comentário foi publicado originalmente. O valor é especificado no formato ISO 8601. |
snippet.updatedAt |
datetime A data e a hora em que o comentário foi atualizado pela última vez. O valor é especificado no formato ISO 8601. |