擷取授權使用者對指定影片清單的評分。
配額影響:呼叫這個方法會產生 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 |
https://www.googleapis.com/auth/youtube.readonly |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
| 參數 | ||
|---|---|---|
| 必要參數 | ||
id |
stringid 參數會指定 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 |
stringYouTube 用來識別影片的專屬 ID。 |
items[].rating |
string授權使用者給予影片的評分。 這個屬性的有效值如下:
|
錯誤
API 未定義任何專屬於這個 API 方法的錯誤訊息。不過,這個方法仍可能傳回錯誤訊息說明文件中列出的一般 API 錯誤。
試試看!
使用 APIs Explorer 呼叫這個 API,並查看 API 要求和回應。