Google ログイン JavaScript クライアント リファレンス

このリファレンスでは、ウェブ アプリケーションに Google ログインを実装するために使用する JavaScript のクライアント メソッドと属性について説明します。

ライブラリの使用中に問題が発生した場合は、GitHub リポジトリに報告してください。

認証の設定

Google API プラットフォーム ライブラリを読み込んで gapi オブジェクトを作成します。

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

プラットフォーム ライブラリが読み込まれたら、auth2 ライブラリを読み込みます。

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init（params）

GoogleAuth オブジェクトを初期化します。gapi.auth2.GoogleAuth のメソッドを呼び出す前に、このメソッドを呼び出す必要があります。

GoogleAuth オブジェクトを初期化するときに、OAuth 2.0 クライアント ID と任意の追加オプションを使用してオブジェクトを構成します。ユーザーがすでにログインしている場合、GoogleAuth オブジェクトは前回のセッションのユーザーのログイン状態を復元します。

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}

GoogleAuth.then（onInit、onError）

GoogleAuth オブジェクトが完全に初期化されたときに、onInit 関数を呼び出します。初期化中にエラーが発生した場合（これはサポートされていない古いブラウザで発生する可能性があります）、代わりに onError 関数が呼び出されます。

エラーコード

idpiframe_initialization_failed

サポートされていない環境などが原因で、Google から必要な iframe を初期化できませんでした。details プロパティは、発生したエラーに関する詳細情報を提供します。

gapi.auth2.ClientConfig

gapi.auth2.init メソッドのさまざまな構成パラメータを表すインターフェース。

認証

GoogleAuth は、ユーザーが Google アカウントでログインするメソッド、ユーザーの現在のログイン ステータスを取得するメソッド、ユーザーの Google プロフィールから特定のデータを取得するメソッド、追加のスコープをリクエストするメソッド、現在のアカウントからのログアウトを行うためのメソッドを提供するシングルトン クラスです。

gapi.auth2.getAuthInstance()

GoogleAuth オブジェクトを返します。このメソッドを呼び出す前に、gapi.auth2.init() を使用して GoogleAuth オブジェクトを初期化する必要があります。

GoogleAuth.isSignedIn.get()

現在のユーザーがログインしているかどうかを返します。

GoogleAuth.isSignedIn.listen(listener)

現在のユーザーのログイン状態の変化をリッスンします。

GoogleAuth.signIn()

gapi.auth2.init() に指定されたオプションでユーザーをログインさせます。

エラーコード

GoogleAuth.signIn(options)をご確認ください。

GoogleAuth.signIn(options)

指定されたオプションを使用してユーザーをログインさせます。

エラーコード

popup_closed_by_user

ユーザーがログインフローを完了する前にポップアップを閉じました。

access_denied

ユーザーが、必要なスコープに対する権限を拒否しました。

immediate_failed

同意フローを表示せずに自動的にユーザーを選択できませんでした。prompt: 'none' オプションを指定して signIn を使用するとエラーが発生します。gapi.auth2.init を使用すると、以前のセッション中にすでにログインしていたユーザーが自動的にログインされるため、このオプションを使用する必要はありません。

gapi.auth2.SignInOptions

GoogleAuth.signIn(options) メソッドのさまざまな構成パラメータを表すインターフェース。

GoogleAuth.signOut()

現在のアカウントをアプリケーションからログアウトします。

GoogleAuth.disconnect()

ユーザーが付与したすべてのスコープを取り消します。

GoogleAuth.grantOfflineAccess（options）

指定されたスコープにオフラインでアクセスするための権限をユーザーから取得します。

{
  scope: 'profile email'
}

auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

エラーコード

popup_closed_by_user

ユーザーが同意フローを終了する前にポップアップを閉じました。

access_denied

ユーザーが、必要なスコープに対する権限を拒否しました。

immediate_failed

同意フローを表示せずに自動的にユーザーを選択できませんでした。prompt: 'none' オプションを指定して signIn を使用するとエラーが発生します。gapi.auth2.init は、以前のセッション中にすでにログインしていたユーザーを自動的にログインさせるため、このオプションを使用する必要はありません。

gapi.auth2.OfflineAccessOptions

GoogleAuth.grantOfflineAccess(options) メソッドのさまざまな構成パラメータを表すインターフェース。

GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)

指定したコンテナのクリック ハンドラにログインフローを接続します。

ユーザー

GoogleUser オブジェクトは 1 つのユーザー アカウントを表します。GoogleUser オブジェクトは通常、GoogleAuth.currentUser.get() を呼び出して取得します。

GoogleAuth.currentUser.get()

現在のユーザーを表す GoogleUser オブジェクトを返します。新しく初期化された GoogleAuth インスタンスでは、現在のユーザーが設定されていないことに注意してください。currentUser.listen() メソッドまたは GoogleAuth.then() を使用して、初期化された GoogleAuth インスタンスを取得します。

GoogleAuth.currentUser.listen(listener)

currentUser の変更をリッスンする。

GoogleUser.getId()

ユーザーの一意の ID 文字列を取得します。

GoogleUser.isSignedIn()

ユーザーがログインしている場合は true を返します。

GoogleUser.getHostedDomain()

ユーザーが G Suite アカウントでログインしている場合は、ユーザーの G Suite ドメインを取得します。

GoogleUser.getGrantedScopes()

ユーザーが付与したスコープをスペース区切りの文字列として取得します。

GoogleUser.getBasicProfile()

ユーザーの基本的なプロフィール情報を取得します。

GoogleUser.getAuthResponse(includeAuthorizationData)

ユーザーの認証セッションからレスポンス オブジェクトを取得します。

GoogleUser.reloadAuthResponse()

アクセス トークンを強制的に更新し、新しい AuthResponse に対する Promise を返します。

gapi.auth2.AuthResponse

GoogleUser.getAuthResponse(includeAuthorizationData) メソッドまたは GoogleUser.reloadAuthResponse() メソッドを呼び出したときに返されるレスポンス。

GoogleUser.hasGrantedScopes（scopes）

指定されたスコープをユーザーが付与した場合、true を返します。

GoogleUser.grant（options）

ユーザーに追加のスコープをリクエストします。

パラメータとエラーコードのリストについては、GoogleAuth.signIn() をご覧ください。

GoogleUser.grantOfflineAccess（options）

指定されたスコープにオフラインでアクセスするための権限をユーザーから取得します。

{
  scope: 'profile email'
}

GoogleUser.disconnect()

ユーザーがアプリケーションに付与したすべてのスコープを取り消します。

UI 要素

gapi.signin2.render(id, options)

options オブジェクトで指定された設定を使用して、指定された ID の要素内にログインボタンをレンダリングします。

{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}

高度な絞り込み

gapi.auth2.authorize(params, callback)

1 回限りの OAuth 2.0 認証を行います。使用するパラメータに応じて、Google ログインフローのポップアップが表示されるか、リクエストされたレスポンスをユーザーの操作なしで読み込みを試行します。

この方法は、次のようなユースケースに役立ちます。

• アプリケーションで Google API エンドポイントをリクエストする必要があるのは 1 回のみです。たとえば、ユーザーが初めてログインしたときにお気に入りの YouTube 動画を読み込む場合などです。
• アプリケーションには独自のセッション管理インフラストラクチャがあり、バックエンドでユーザーを識別するために ID トークンが必要になるのは 1 回だけです。
• 同じページ内で複数のクライアント ID が使用されている。

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}

例

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

エラーコード

idpiframe_initialization_failed

サポートされていない環境などが原因で、Google から必要な iframe を初期化できませんでした。details プロパティは、発生したエラーに関する詳細情報を提供します。

popup_closed_by_user

ユーザーがログインフローを完了する前にポップアップを閉じました。

access_denied

ユーザーが、必要なスコープに対する権限を拒否しました。

immediate_failed

同意フローを表示せずに自動的にユーザーを選択できませんでした。prompt: 'none' オプションを指定して signIn を使用するとエラーが発生します。

gapi.auth2.AuthorizeConfig

gapi.auth2.authorize メソッドのさまざまな構成パラメータを表すインターフェース。

gapi.auth2.AuthorizeResponse

gapi.auth2.authorize メソッドのコールバックに返されるレスポンス。