擷取授權使用者在指定影片清單中的評分。
配額影響:呼叫此方法的配額費用為 1 單位。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/videos/getRating
授權
此要求需要至少具備下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
範圍 |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
id |
string id 參數會用逗號分隔列出要擷取評分資料的 YouTube 影片 ID 清單。在 video 資源中,id 屬性會指定影片的 ID。 |
|
選用參數 | ||
onBehalfOfContentOwner |
string 這個參數只能在妥善的授權要求中使用。注意:這個參數僅適用於 YouTube 內容合作夥伴。 onBehalfOfContentOwner 參數表示請求的授權憑證能代表代替參數值中所指定的內容擁有者所擔任的 YouTube CMS 使用者。這個參數適用於擁有和管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次即可,就能存取所有影片和頻道資料,而不需要為每個頻道分別提供驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
要求主體
呼叫此方法時請不要提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#videoGetRatingResponse", "etag": etag, "items": [ { "videoId": string, "rating": string } ] }
屬性
下表定義此資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源類型。這個值會是 youtube#videoGetRatingResponse 。 |
etag |
etag 這項資源的 Etag。 |
items[] |
list 符合要求條件的評分清單。 |
items[].videoId |
string YouTube 用於識別影片的專屬 ID。 |
items[].rating |
string 授權使用者給影片的評分。 這項屬性的有效值如下:
|
錯誤
API 不會定義任何專屬於此 API 方法的錯誤訊息。但這個方法仍可能傳回錯誤訊息文件中所列的一般 API 錯誤。
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。