Retorna uma lista de conversas que correspondem aos parâmetros da solicitação de API.
Impacto na cota:uma chamada para esse método tem um custo de cota de uma 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 incluirá.A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro:
|
|
Filtros (especifique exatamente um dos seguintes parâmetros) | ||
allThreadsRelatedToChannelId |
string O parâmetro allThreadsRelatedToChannelId instrui a API a retornar todas as conversas de comentários associadas ao canal especificado. A resposta pode incluir comentários sobre o canal ou sobre os vídeos dele. |
|
channelId |
string O parâmetro channelId instrui a API a retornar sequências de comentários que contêm comentários sobre o canal especificado. A resposta não incluirá comentários deixados em vídeos enviados pelo canal. |
|
id |
string O parâmetro id especifica uma lista separada por vírgulas de IDs da conversa de comentários para os recursos que precisam ser recuperados. |
|
videoId |
string O parâmetro videoId instrui a API a retornar as 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 com o parâmetro id . Os valores aceitos 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 autorizada corretamente. Defina esse parâmetro para limitar as linhas de execução de comentários retornadas a um estado de moderação específico. Observação:esse parâmetro não pode ser usado com o parâmetro id . O valor padrão é published .Os valores aceitáveis são os seguintes:
|
|
order |
string O parâmetro order especifica a ordem em que a resposta da API listará as conversas dos comentários. Os valores válidos são:
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 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: este parâmetro não pode ser usado com o 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 HTML ou texto simples. O valor padrão é html .Os valores aceitáveis são os seguintes:
|
Corpo da solicitação
Não forneça um corpo de solicitação ao chamar este 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 do recurso da API. O valor será youtube#commentThreadListResponse . |
etag |
etag A ETag deste 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 conversas de comentários que correspondem aos critérios da solicitação. |
Erros
A tabela a seguir identifica mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.
Tipo de erro | Detalhe do erro | Descrição |
---|---|---|
badRequest (400) |
operationNotSupported |
O filtro "id" é compatível apenas com comentários do Google+. |
badRequest (400) |
processingFailure |
O servidor da API não conseguiu processar a solicitação. Embora esse erro possa ser 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 |
Não foi possível recuperar uma ou mais conversas de comentários solicitadas devido a permissões insuficientes. A solicitação pode não es devidamente autorizada. |
notFound (404) |
channelNotFound |
O canal identificado pelo parâmetro channelId ou allThreadsRelatedToChannelId não foi encontrado. |
notFound (404) |
commentThreadNotFound |
Não foi possível encontrar uma ou mais conversas especificadas. Verifique os valores do parâmetro id da solicitação para garantir que ele esteja correto. |
notFound (404) |
videoNotFound |
O vídeo identificado pelo parâmetro videoId não foi encontrado. |
Confira!
Use o APIs Explorer para chamar a API e ver a solicitação e a resposta da API.