Get Rating
|
|||||
|
|
||||
Retrieves the ratings that the authorized user gave to a list of specified videos
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- View and manage your assets and associated content on YouTube
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
id Required |
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 |
onBehalfOfContentOwner |
STRING |
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 |
= Parameter name
= Format
|
id STRING Required 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 |
|
onBehalfOfContentOwner STRING 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 |
Output
This building block provides 7 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
Etag of this resource |
eventId |
STRING |
Serialized EventId of the request which produced this response |
items[] |
OBJECT |
|
items[].rating |
ENUMERATION |
|
items[].videoId |
STRING |
|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse" |
visitorId |
STRING |
The visitorId identifies the visitor |
= Parameter name
= Format
|
etag STRING Etag of this resource |
|
eventId STRING Serialized EventId of the request which produced this response |
|
items[] OBJECT |
|
items[].rating ENUMERATION |
|
items[].videoId STRING |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse" |
|
visitorId STRING The visitorId identifies the visitor |