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

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

ライブラリの使用中に問題が発生した場合は、 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)

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

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

高度

gapi.auth2.authorize(params, callback)

1 回限りの OAuth 2.0 認証を行います。使用するパラメータによっては、ウィンドウが開き、 ポップアップを表示するか、リクエストされた応答をユーザーの操作なしで自動的に読み込もうとします。

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

• アプリケーションで Google API エンドポイントを一度リクエストするだけで済みます。たとえば、 最初にログインしたときに、お気に入りの YouTube 動画が表示されます。
• アプリケーションに独自のセッション管理インフラストラクチャがあり、 バックエンドでユーザーを識別するために 1 回だけ ID トークン。
• 同じページ内で複数のクライアント 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 メソッドを使用します。