擷取授權使用者授予指定影片清單的評分。
配額影響:呼叫這個方法的配額為 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 要求和回應。