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 um 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 da solicitação da API. Faça um teste agora.
- inserir
- Cria uma resposta a um comentário existente. Observação:para criar um comentário de nível superior, use o método
commentThreads.insert
. Teste agora mesmo. - update
- Modifica um comentário. Faça um teste agora.
- excluir
- 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 de API precisa ser autorizada pelo proprietário do canal ou vídeo associado aos comentários. Faça um teste agora.
- markAsSpam
- Observação:esse método foi descontinuado e não é mais compatível.
- expressa a opinião do autor da chamada de que um ou mais comentários precisam 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 de recurso da API. O valor será youtube#comment . |
etag |
etag A Etag desse recurso. |
id |
string O ID que o YouTube usa para identificar de forma exclusiva o comentário. |
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 Esse objeto encapsula informações sobre o canal do YouTube do autor do comentário, se disponíveis. |
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.Até mesmo o texto simples pode ser diferente do texto original do comentário. Por exemplo, links de vídeos podem ser substituídos por títulos de vídeos. |
snippet.textOriginal |
string O texto original e bruto do comentário como foi postado inicialmente ou atualizado pela última vez. O texto original só será retornado para o usuário autenticado se ele for o autor do comentário. |
snippet.parentId |
string O ID exclusivo do comentário pai. Esta propriedade só é definida se o comentário foi enviado como resposta a outro comentário. |
snippet.canRate |
boolean Essa configuração indica se o espectador atual pode avaliar o comentário. |
snippet.viewerRating |
string A avaliação que o espectador deu a este comentário. Esta propriedade não identifica classificações do dislike , embora esse comportamento esteja sujeito a mudanças. Enquanto isso, o valor da propriedade será like se o espectador tiver avaliado o comentário positivamente. O valor é none em todos os outros casos, incluindo o usuário que atribuiu uma nota negativa ao comentário ou não o avaliou.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 de API tiver sido autorizada pelo proprietário do canal ou pelo vídeo em que os comentários solicitados foram feitos. Além disso, essa propriedade não será definida se a solicitação de API tiver usado o parâmetro de filtro id .Os valores válidos para ela 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. |