Estamos atualizando a API Data para corresponder à forma como o YouTube conta as visualizações dos Shorts.
Saiba mais
Videos: getRating
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera as classificações que o usuário autorizado deu a uma lista de vídeos especificados.
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/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 está agindo 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 de recurso da API. O valor será youtube#videoGetRatingResponse. |
etag |
etag
A Etag desse 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 de forma exclusiva o vídeo. |
items[].rating |
string
A classificação que o usuário autorizado deu ao vídeo.
Os valores válidos para essa propriedade são:
dislikelikenoneunspecified
|
Erros
A API não define mensagens de erro exclusivas para esse método de API. No entanto, esse método ainda pode retornar erros gerais da API listados na documentação da mensagem de erro.
Confira!
Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-04-26 UTC.
[null,null,["Última atualização 2024-04-26 UTC."],[],[],null,["# Videos: getRating\n\nRetrieves the ratings that the authorized user gave to a list of specified videos.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/videos/getRating\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/guides/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtubepartner` |\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data. In a `video` resource, the `id` property specifies the video's ID. |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/v3/guides/authentication). **Note:** This parameter is intended exclusively for YouTube content partners. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```text\n{\n \"kind\": \"youtube#videoGetRatingResponse\",\n \"etag\": etag,\n \"items\": [\n {\n \"videoId\": string,\n \"rating\": string\n }\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#videoGetRatingResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of ratings that match the request criteria. |\n| items[].`videoId` | `string` The ID that YouTube uses to uniquely identify the video. |\n| items[].`rating` | `string` The rating that the authorized user gave to the video. Valid values for this property are: - `dislike` - `like` - `none` - `unspecified` |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/v3/docs/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
