CommentThreads: list

Retorna uma lista de sequências de comentários que correspondem aos parâmetros de solicitação de API.

Impacto na cota:uma chamada para esse método tem um custo de cota de 1 unidade.

Casos de uso comuns

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/commentThreads

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part	string O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recurso commentThread que a resposta da API vai incluir. A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro: id replies snippet
Filtros (especifique exatamente um dos seguintes parâmetros)
allThreadsRelatedToChannelId	string O parâmetro allThreadsRelatedToChannelId instrui a API a retornar todas as sequências de comentários associadas ao canal especificado.
id	string O parâmetro id especifica uma lista separada por vírgulas de IDs de sequências de comentários para os recursos que precisam ser recuperados.
videoId	string O parâmetro videoId instrui a API a retornar sequências de comentários associadas ao ID do vídeo especificado.
Parâmetros opcionais
maxResults	unsigned integer O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Observação: esse parâmetro não pode ser usado em conjunto com o parâmetro id. Os valores aceitáveis são de 1 a 100, inclusive. O valor padrão é 20.
moderationStatus	string Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada. Defina esse parâmetro para limitar as sequências de comentários retornadas a um estado de moderação específico. Observação: esse parâmetro não pode ser usado em conjunto com o id parâmetro. O valor padrão é published. Os valores aceitáveis são: heldForReview – Recupera sequências de comentários que estão aguardando revisão por um moderador. Uma sequência de comentários pode ser incluída na resposta se o comentário de nível superior ou pelo menos uma das respostas a esse comentário estiver aguardando revisão. likelySpam – Recupera sequências de comentários classificadas como prováveis spams. Uma sequência de comentários pode ser incluída na resposta se o comentário de nível superior ou pelo menos uma das respostas a esse comentário for considerado um spam. published – Recupera sequências de comentários publicados. Esse é o valor padrão. Uma sequência de comentários pode ser incluída na resposta se o comentário de nível superior tiver sido publicado.
order	string O parâmetro order especifica a ordem em que a resposta da API precisa listar as sequências de comentários. Os valores válidos são: time - As sequências de comentários são ordenadas por tempo. Esse é o comportamento padrão. relevance - As sequências de comentários são ordenadas por relevância. Observação:esse parâmetro não pode ser usado em conjunto com o parâmetro id.
pageToken	string O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. Em uma resposta da API, a propriedade nextPageToken identifica a próxima página do resultado que pode ser recuperada. Observação: esse parâmetro não pode ser usado em conjunto com o parâmetro id.
searchTerms	string O parâmetro searchTerms instrui a API a limitar a resposta da API para conter apenas comentários que contenham os termos de pesquisa especificados. Observação: esse parâmetro não pode ser usado em conjunto com o parâ parâmetro id.
textFormat	string Defina o valor desse parâmetro como html ou plainText para instruir a API a retornar os comentários deixados pelos usuários em formato HTML ou em texto simples. O valor padrão é html. Os valores aceitáveis são: html – Retorna os comentários em formato HTML. Esse é o valor padrão. plainText – Retorna os comentários em formato de texto simples.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar esse método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread Resource
  ]
}

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#commentThreadListResponse.
etag	etag O Etag desse recurso.
nextPageToken	string O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados.
pageInfo	object O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults	integer O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage	integer O número de resultados incluídos na resposta da API.
items[]	list Uma lista de sequências de comentários que correspondem aos critérios da solicitação.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Para mais detalhes, consulte a documentação da mensagem de erro.

Tipo de erro	Detalhe do erro	Descrição
badRequest (400)	operationNotSupported	O filtro id só é compatível com comentários baseados no Google+.
badRequest (400)	processingFailure	O servidor de API não conseguiu processar a solicitação. Embora esse possa ser um erro temporário, ele geralmente indica que a entrada da solicitação é inválida. Verifique a estrutura do recurso commentThread no corpo da solicitação para garantir que ele seja válido.
forbidden (403)	commentsDisabled	O vídeo identificado pelo parâmetro videoId desativou os comentários.
forbidden (403)	forbidden	Uma ou mais das sequências de comentários solicitadas não podem ser recuperadas devido a permissões insuficientes. A solicitação pode não es devidamente autorizada.
notFound (404)	channelNotFound	Não foi possível encontrar o canal identificado pelo parâmetro allThreadsRelatedToChannelId.
notFound (404)	commentThreadNotFound	Não foi possível encontrar uma ou mais das sequências de comentários especificadas. Verifique os valores do parâmetro id da solicitação para garantir que ele esteja correto.
notFound (404)	videoNotFound	Não foi possível encontrar o vídeo identificado pelo parâmetro videoId.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.