我們正在更新 Data API,以符合 YouTube 計算 Shorts 觀看次數的方式。
瞭解詳情
Videos: getRating
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
擷取授權使用者授予指定影片清單的評分。
配額影響:呼叫這個方法的配額為 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
授權使用者為影片提供的內容分級。
這個屬性的有效值包括:
dislike
like
none
unspecified
|
錯誤
API 不會定義此 API 方法專屬的任何錯誤訊息。不過,這個方法仍可傳回錯誤訊息說明文件中列出的一般 API 錯誤。
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-04-26 (世界標準時間)。
[null,null,["上次更新時間:2024-04-26 (世界標準時間)。"],[],[],null,["# Videos: getRating\n\nRetrieves the ratings that the authorized user gave to a list of specified videos.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/videos/getRating\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/guides/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtubepartner` |\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `id` | `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. |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/v3/guides/authentication). **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. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```text\n{\n \"kind\": \"youtube#videoGetRatingResponse\",\n \"etag\": etag,\n \"items\": [\n {\n \"videoId\": string,\n \"rating\": string\n }\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#videoGetRatingResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of ratings that match the request criteria. |\n| items[].`videoId` | `string` The ID that YouTube uses to uniquely identify the video. |\n| items[].`rating` | `string` The rating that the authorized user gave to the video. Valid values for this property are: - `dislike` - `like` - `none` - `unspecified` |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/v3/docs/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]