Videos: getRating

Retrieves the ratings that the authorized user gave to a list of specified videos. Try it now.

Quota impact: A call to this method has a quota cost of approximately 1 unit.

Usage

Request

HTTP request

GET https://www.googleapis.com/youtube/v3/videos/getRating

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters
Required parameters
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.
Optional parameters
onBehalfOfContentOwner string
This parameter can only be used in a properly authorized request. 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.

Request body

Do not provide a request body when calling this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "youtube#videoGetRatingResponse",
  "etag": etag,
  "items": [
    {
      "videoId": string,
      "rating": string
    }
  ]
}

Properties

The following table defines the properties that appear in this resource:

Properties
kind string
Identifies the API resource's type. The value will be youtube#videoGetRatingResponse.
etag etag
The Etag of this resource.
items[] list
A list of ratings that match the request criteria.
items[].videoId string
The ID that YouTube uses to uniquely identify the video.
items[].rating string
The rating that the authorized user gave to the video.

Valid values for this property are:
  • dislike
  • like
  • none
  • unspecified

Errors

The 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 documentation.

Send feedback about...

YouTube Data API
YouTube Data API