Videos: getRating

Recupera as classificações que o usuário autorizado deu a uma lista de vídeos especificados.

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/videos/getRating

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

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
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs dos vídeos do YouTube para os recursos para os quais você está recuperando dados de classificação. Em um recurso video, a propriedade id especifica o ID do vídeo.
Parâmetros opcionais
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que atua em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.

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#videoGetRatingResponse",
  "etag": etag,
  "items": [
    {
      "videoId": string,
      "rating": string
    }
  ]
}

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#videoGetRatingResponse.
etag etag
A ETag deste recurso.
items[] list
Uma lista de classificações que correspondem aos critérios da solicitação.
items[].videoId string
O ID que o YouTube usa para identificar o vídeo com exclusividade.
items[].rating string
A classificação dada pelo usuário autorizado ao vídeo.

Os valores válidos para essa propriedade são:
  • dislike
  • like
  • none
  • unspecified

Erros

A API não define mensagens de erro exclusivas para esse método. No entanto, esse método ainda pode retornar erros gerais da API listados na documentação mensagem de erro.

Confira!

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