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 アナリティクス API では、次のスコープが使用されます。

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

YouTube Reporting API では、次のスコープが使用されます。

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

OAuth 2.0 API スコープのドキュメントには、Google API へのアクセスに使用できるスコープの完全なリストが記載されています。