YouTube Data APIのAPIキーの取得とクォータの確認方法。

YouTubeのチャンネルや動画のJSONデータ取得などの機能を提供するYouTube Data APIを利用するためのAPIキーの取得方法と、呼び出し制限の割り当て量(クォータ : Quota)の確認方法。忘れるのでメモ。

※ YouTube Data APIの公式ドキュメント。

APIキーの取得方法

YouTube Data APIを利用するためのAPIキーを取得する方法。

※ APIキーの取得にはGoogleアカウントが必要。

APIキーの取得

1. Google API Consoleの「APIs & Services」(「API とサービス」)へ行く。
2. 画面上部固定のメニューバー内にある既存プロジェクトを選択するプルダウンボタンでプロジェクト選択ウィンドウを開く。
3. 右上の「New Project」(「新しいプロジェクト」)で任意の名前を付けてプロジェクトを新規作成。
4. 作成したプロジェクトを選択した状態で左カラムのメニューから「Library」(「ライブラリ」)をクリック。
5. APIの中から「YouTube Data API v3」を選択して、「ENABLE」(「有効にする」)にする。
6. プロジェクトのダッシュボードに戻り、左カラムのメニューから「Credentials」(「認証情報」)を選択。
7. メインカラム上部にある「CREATE CREDENTIALS」(「認証情報を作成」) > 「API Key」(「API キー」)でAPIキーを作成。
8. モーダルウィンドウが開き、APIキーが表示される。
9. メインカラムのAPI Keysの一覧に表示されている該当のキー名をクリックして、詳細ページ右上の欄でもAPIキーが確認できる。

APIキーの使用制限

そのままでは、取得したAPIキーに使用制限が無いので、APIキーを使用できるウェブアプリケーションを制限する。

該当の「API Key」の詳細ページにある「Application restrictions」(「アプリケーションの制限」)の項目でアクセス制限の設定をする。

• none : 制限無し
• HTTP referrers (web sites) : HTTPのリファラーを確認してURLで制限。
• IP addresses (web servers, cron jobs, etc.) : IPアドレスで制限。
• Android apps : アンドロイドアプリで制限。
• iOS apps : iOSアプリで制限。

「HTTP referrers」で許可するURLを指定するときは、特定のURLを指定するか、「*」(ワイルドカード)を使う。

• 「memo.ag2works.tokyo/特定のパス」 : 特定のURLのみ。
• 「ag2works.tokyo/*」 : ドメイン以下すべて。
• 「memo.ag2works.tokyo/*」 : 特定のサブドメイン以下すべて。
• 「*.ag2works.tokyo/*」: すべてのサブドメイン以下すべて。

※ リファラーは簡単に偽装できるので、リファラーでの制限にあまり意味は無い。(サーバーサイドで動作するようにしてサーバーのIPアドレスで制限する方が無難。)

プロジェクトの削除

作成したプロジェクトを削除したい場合は、画面左上のメニューボタン > 「IAM & Admin」(「IAMと管理」) > 「Settings」(「設定」) > 「SHUT DOWN」(「シャットダウン」)。

YouTube Data APIの呼び出し制限

YouTube Data APIの利用は、アプリケーションがどのようなリソースにアクセスするかによってリクエストの総量がユニットという単位で算出され、1日に利用できるリクエストの割り当て量(クォータ : Quota)が設定されている。

※ クォータの使用量についての公式ドキュメント。

※ 呼び出しコストの一覧の公式ドキュメント。

クォータの確認方法

1. Google API Consoleの「APIs & Services」(「API とサービス」)へ行く。
2. メインカラムの一覧にある「YouTube Data API v3」をクリック。
3. 「QUOTAS」(「割り当て」)のタブをクリック。
4. 「Queries」をクリックするとプルダウンが開く。
5. 上部に表示されるグラフで現在の使用量、下部にある「Quota Name」(「割り当て名」)と「Limit」(「上限」)で割り当て量が確認できる。

※ 「Limit」(「上限」)にある数値をクリックすると、自分で上限を任意に設定できる。

クォータの増加申請

クォータの上限を増やすには、Googleへ事業内容などを申請し、審査に通る必要がある。

※ 割り当て増加の申請フォーム。

• YouTube API Quotas, please explain. Quota exceeded. How to solve?