OAuth 2.0 認証を実装する

YouTube Reporting API と YouTube Analytics API は、非公開のユーザーデータへのアクセスを承認するための OAuth 2.0 プロトコルをサポートしています。次のリストに、OAuth 2.0 のコアコンセプトをいくつか示します。

  • ユーザーが Google Account or YouTube account へのログインを必要とするアプリ内の機能を初めて使用しようとすると、アプリは OAuth 2.0 承認プロセスを開始します。

  • アプリケーションがユーザーを Google の承認サーバーに転送します。このページへのリンクは、ユーザーのアカウントにアプリケーションがリクエストしているアクセス権の scope を指定します。scope には、認証済みユーザーとして動作するときにアプリが取得、挿入、更新、削除できるリソースを指定します。

  • アプリケーションがこれらのリソースにアクセスすることをユーザーが同意した場合、Google はアプリケーションにトークンを返します。アプリケーションの種類によって、トークンの検証または別の種類のトークンへの交換が行われます。

    たとえばサーバーサイド ウェブ アプリケーションは、アクセス トークンと更新トークンについて返されたトークンを交換します。アプリケーションはアクセス トークンを使用してユーザーの代わりにリクエストを承認し、元のアクセス トークンの期限が切れると更新トークンを使用して新しいトークンを取得します。

重要: OAuth 2.0 認証を使用するには、Google API Console で認証情報を取得する必要があります。

詳しくは、OAuth 2.0 認可ガイドをご覧ください。

OAuth 2.0 フロー

Google API は、次のような OAuth 2.0 のユースケースをサポートしています。

  • サーバーサイド ウェブアプリのフローは、永続的な情報を安全に保存できるウェブ アプリケーションをサポートします。
  • JavaScript ウェブアプリのフローは、ブラウザで実行される JavaScript アプリケーションをサポートします。
  • モバイルアプリとパソコン用アプリのフローは、スマートフォンやパソコンなどのデバイスにインストールされているアプリをサポートしています。
  • テレビと入力機能が限られたデバイス向けの OAuth 2.0 フローでは、ゲーム機やビデオカメラなど、入力機能が制限されたデバイスがサポートされています。 The YouTube Reporting and YouTube Analytics APIs do not currently support the OAuth 2.0 flow for devices.
  • サービス アカウント フローの OAuth 2.0 フローは、ユーザー情報にアクセスしないサーバー間のインタラクションをサポートしています。ただし、YouTube Reporting API と YouTube Analytics API はこのフローをサポートしていません。 Since there is no way to link a Service Account to a YouTube account, attempts to authorize requests with this flow will generate an error.

アクセス スコープを特定する

スコープを使用すると、アプリケーションは必要なリソースへのアクセスのみをリクエストできると同時に、ユーザーはアプリケーションに付与するアクセス権の量を制御できるようになります。そのため、リクエストするスコープの数とユーザーの同意を得られる可能性との間には逆相関関係がある可能性があります。

OAuth 2.0 認証の実装を開始する前に、アプリがアクセス権限を必要とするスコープを設定しておくことをおすすめします。

YouTube Analytics API では、次のスコープを使用します。

スコープ
https://www.googleapis.com/auth/youtubeYouTube アカウントの管理
https://www.googleapis.com/auth/youtube.readonlyYouTube アカウントの表示
https://www.googleapis.com/auth/youtubepartnerYouTube のアセットや関連するコンテンツの表示と管理
https://www.googleapis.com/auth/yt-analytics-monetary.readonlyYouTube コンテンツに関する YouTube アナリティクスの収益レポートと非収益レポートの表示
https://www.googleapis.com/auth/yt-analytics.readonlyYouTube コンテンツの YouTube アナリティクス レポートの表示

YouTube Reporting API では次のスコープを使用します。

スコープ
https://www.googleapis.com/auth/yt-analytics-monetary.readonlyYouTube コンテンツに関する YouTube アナリティクスの収益レポートと非収益レポートの表示
https://www.googleapis.com/auth/yt-analytics.readonlyYouTube コンテンツの YouTube アナリティクス レポートの表示

Google API へのアクセスに使用できるスコープの一覧については、OAuth 2.0 API スコープのドキュメントをご覧ください。