Retorna uma lista de comentários que correspondem aos parâmetros da solicitação de API.
Impacto da 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/comments
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 comment que serão incluídas pela resposta da API.A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro:
|
|
Filtros (especifique exatamente um dos parâmetros a seguir) | ||
id |
string O parâmetro id especifica uma lista separada por vírgulas de IDs de comentários para os recursos que estão sendo recuperados. Em um recurso comment , a propriedade id especifica o ID do comentário. |
|
parentId |
string O parâmetro parentId especifica o ID do comentário para o qual as respostas precisam ser recuperadas. Observação:atualmente, o YouTube aceita respostas apenas para comentários de nível superior. No entanto, é possível que respostas a respostas sejam aceitas no futuro. |
|
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 é compatível com id . Os valores aceitáveis são de 1 a 100 , inclusive. O valor padrão é 20 . |
|
pageToken |
string O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. 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 id . |
|
textFormat |
string Esse parâmetro indica se a API retornará comentários formatados como HTML ou como 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#commentListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ comment 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#commentListResponse . |
etag |
etag A 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 do 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 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 de ID só é compatível com comentários baseados no Google+. |
forbidden (403) |
forbidden |
Um ou mais dos comentários solicitados não podem ser recuperados devido à insuficiência de permissões. A solicitação pode não es devidamente autorizada. |
notFound (404) |
commentNotFound |
Não foi possível encontrar um ou mais dos comentários especificados. Verifique os valores dos parâmetros id e parentId da solicitação para garantir que eles estejam corretos. |
Confira!
Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.