許可されたユーザーが、指定した動画リストにつけた評価を取得します。
割り当てへの影響: このメソッドを呼び出すと、割り当てコストは 1 単位になります。
一般的なユースケース
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/youtube/v3/videos/getRating
承認
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
範囲 |
---|
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 のリクエストとレスポンスを確認します。