Add a like or dislike rating to a video or remove a rating from a video. Try it now or see an example.
Quota impact: A call to this method has a quota cost of approximately 50 units.
Request
HTTP request
POST https://www.googleapis.com/youtube/v3/videos/rate
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 the YouTube video ID of the video that is being rated or having its rating removed. |
|
rating |
string Specifies the rating to record. Acceptable values are:
|
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns an HTTP 204
response code (No Content
).
Examples
Note: The following code samples may not represent all supported programming languages. See the client libraries documentation for a list of supported languages.
Python
This sample calls the API'svideos.rate
method to set a positive rating for a video.
This example uses the Python client library.
#!/usr/bin/python import httplib2 import os import sys from apiclient.discovery import build from apiclient.errors import HttpError from oauth2client.client import flow_from_clientsecrets from oauth2client.file import Storage from oauth2client.tools import argparser, run_flow # The CLIENT_SECRETS_FILE variable specifies the name of a file that contains # the OAuth 2.0 information for this application, including its client_id and # client_secret. You can acquire an OAuth 2.0 client ID and client secret from # the {{ Google Cloud Console }} at # {{ https://cloud.google.com/console }}. # Please ensure that you have enabled the YouTube Data API for your project. # For more information about using OAuth2 to access the YouTube Data API, see: # https://developers.google.com/youtube/v3/guides/authentication # For more information about the client_secrets.json file format, see: # https://developers.google.com/api-client-library/python/guide/aaa_client_secrets CLIENT_SECRETS_FILE = "client_secrets.json" # This variable defines a message to display if the CLIENT_SECRETS_FILE is # missing. MISSING_CLIENT_SECRETS_MESSAGE = """ WARNING: Please configure OAuth 2.0 To make this sample run you will need to populate the client_secrets.json file found at: %s with information from the {{ Cloud Console }} {{ https://cloud.google.com/console }} For more information about the client_secrets.json file format, please visit: https://developers.google.com/api-client-library/python/guide/aaa_client_secrets """ % os.path.abspath(os.path.join(os.path.dirname(__file__), CLIENT_SECRETS_FILE)) # This OAuth 2.0 access scope allows for full read/write access to the # authenticated user's account. YOUTUBE_READ_WRITE_SCOPE = "https://www.googleapis.com/auth/youtube" YOUTUBE_API_SERVICE_NAME = "youtube" YOUTUBE_API_VERSION = "v3" def get_authenticated_service(args): flow = flow_from_clientsecrets(CLIENT_SECRETS_FILE, scope=YOUTUBE_READ_WRITE_SCOPE, message=MISSING_CLIENT_SECRETS_MESSAGE) storage = Storage("%s-oauth2.json" % sys.argv[0]) credentials = storage.get() if credentials is None or credentials.invalid: credentials = run_flow(flow, storage, args) return build(YOUTUBE_API_SERVICE_NAME, YOUTUBE_API_VERSION, http=credentials.authorize(httplib2.Http())) # Add the video rating. This code sets the rating to "like," but you could # also support an additional option that supports values of "like" and # "dislike." def like_video(youtube, video_id): youtube.videos().rate( id=video_id, rating="like" ).execute() if __name__ == "__main__": argparser.add_argument("--videoid", default="L-oNKK1CrnU", help="ID of video to like.") args = argparser.parse_args() youtube = get_authenticated_service(args) try: like_video(youtube, args.videoid) except HttpError, e: print "An HTTP error %d occurred:\n%s" % (e.resp.status, e.content) else: print "%s has been liked." % args.videoid
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the error message documentation for more detail.
Error type | Error detail | Description |
---|---|---|
badRequest (400) |
emailNotVerified |
The user must verify their e-mail address prior to rating. |
badRequest (400) |
invalidRating |
The request contained an unexpected value for the rating parameter. |
badRequest (400) |
videoPurchaseRequired |
Rental videos can only be rated by users who rented them. |
forbidden (403) |
forbidden |
The video that you are trying to rate cannot be rated. The request might not be properly authorized. |
forbidden (403) |
videoRatingDisabled |
The owner of the video that you are trying to rate has disabled ratings for that video. |
notFound (404) |
videoNotFound |
The video that you are trying to rate cannot be found. Check the value of the request's id parameter to ensure that it is correct. |
Try it!
Use the API Explorer to call this method on live data and see the API request and response.