このページは Cloud Translation API によって翻訳されました。

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

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

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

Auth の設定

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 オブジェクトはユーザーのログイン状態を以前のセッションから復元します。

引数
`params`	クライアント構成データの Key-Value ペアを含むオブジェクト。構成可能な別のプロパティについては、`gapi.auth2.ClientConfig` をご覧ください。次に例を示します。 { client_id: 'CLIENT_ID.apps.googleusercontent.com' }

戻り値
`gapi.auth2.GoogleAuth`	`gapi.auth2.GoogleAuth` オブジェクト。then() メソッドを使用して、`gapi.auth2.GoogleAuth` オブジェクトの初期化が完了したときに解決される Promise を取得します。

GoogleAuth.then（`onInit`、`onError`）

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

引数
`onInit`	完全に初期化されたときに `GoogleAuth` オブジェクトで呼び出される関数。
`onError`	`GoogleAuth` の初期化に失敗した場合に、`error` プロパティを含むオブジェクトで呼び出される関数。

戻り値
Promise	`onInit` 関数が完了したときに実行され、初期化エラーが発生した場合は拒否される `Promise`。`onInit` 関数からの戻り値（ある場合）で解決されます。

警告: gapi.auth2.init() の結果で Promise.resolve() などを呼び出してはいけません。返される GoogleAuth オブジェクトは、それ自体で解決される then() メソッドを実装しているため、無限の再帰が発生します。

エラーコード

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

gapi.auth2.ClientConfig

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

パラメータ
`client_id`	`string`	必須: Google Cloud コンソールで確認および作成されたアプリのクライアント ID。
`cookie_policy`	`string`	ログイン Cookie を作成するドメイン。URI、`single_host_origin`、`none` のいずれか。指定しない場合のデフォルトは `single_host_origin` です。
`scope`	`string`	リクエストするスコープ。スペース区切りの文字列で指定します。`fetch_basic_profile` が false に設定されていない場合は省略可能です。
`fetch_basic_profile`	`boolean`	ユーザーがログインしたときに、ユーザーの基本的なプロフィール情報を取得します。リクエストされたスコープに「profile」、「email」、「openid」を追加しました。指定しない場合は true になります。
`hosted_domain`	`string`	ユーザーがログインするために所属する必要がある G Suite ドメイン。これはクライアントによって変更される可能性があるため、返されたユーザーのホストドメインのプロパティを必ず確認してください。クライアントで GoogleUser.getHostedDomain() を使用し、サーバー上の ID トークンで `hd` クレームを使用して、ドメインが想定どおりであることを確認します。このパラメータを `fetch_basic_profile: false` とともに使用する場合は、`'email'` スコープをリクエストする必要があります。
`ux_mode`	`string`	ログインフローに使用する UX モード。デフォルトでは、同意フローがポップアップで開きます。有効な値は `popup` と `redirect` です。
`redirect_uri`	`string`	`ux_mode='redirect'` を使用する場合、このパラメータを使用すると、同意フローの最後に使用されるデフォルトの `redirect_uri` をオーバーライドできます。デフォルトの `redirect_uri` は、クエリパラメータとハッシュフラグメントが取り除かれた現在の URL です。
`plugin_name`	`string`	（省略可）この値が設定されている場合、2022 年 7 月 29 日より前に作成された新しいクライアント ID では、以前の Google プラットフォームライブラリを使用できます。デフォルトでは、新しく作成されたクライアント ID はプラットフォームライブラリを使用できないため、新しい Google Identity Services ライブラリを使用する必要があります。任意の値を選択できます。識別しやすいように、プロダクト名やプラグイン名など、わかりやすい名前をおすすめします。例: `plugin_name: 'YOUR_STRING_HERE'`

認証

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

gapi.auth2.getAuthInstance()

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

戻り値
`gapi.auth2.GoogleAuth`	`gapi.auth2.GoogleAuth` オブジェクト。このオブジェクトを使用して、`gapi.auth2.GoogleAuth` のメソッドを呼び出します。

GoogleAuth.isSignedIn.get()

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

戻り値
ブール値	ユーザーがログインしている場合は `true`、ユーザーがログアウト中または `GoogleAuth` オブジェクトが初期化されていない場合は `false`。

GoogleAuth.isSignedIn.listen(listener)

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

引数
`listener`	ブール値を受け取る関数。`listen()` は、ユーザーがログインしたときにこの関数に `true` を渡し、ユーザーがログアウトしたときに `false` を渡します。

GoogleAuth.signIn()

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

戻り値
Promise	ユーザーが認証に成功してリクエストされたスコープを付与すると、`GoogleUser` インスタンスで履行される `Promise`。エラーが発生した場合は、`error` プロパティを含むオブジェクトで拒否される（エラーコードについては下記を参照）。

エラーコード

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

GoogleAuth.signIn（`options`）

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

引数

引数
`options`	次のいずれかです。ログインパラメータの Key-Value ペアを含む `gapi.auth2.SignInOptions` オブジェクト。次に例を示します。 { scope: 'profile email' } `gapi.auth2.SigninOptionsBuilder` のインスタンス。次に例を示します。 options = new gapi.auth2.SigninOptionsBuilder(); options.setAppPackageName('com.example.app'); options.setFetchBasicProfile(True); options.setPrompt('select_account'); options.setScope('profile').setScope('email');

options

次のいずれかです。

ログインパラメータの Key-Value ペアを含む gapi.auth2.SignInOptions オブジェクト。次に例を示します。
```
{
  scope: 'profile email'
}
```

gapi.auth2.SigninOptionsBuilder のインスタンス。次に例を示します。

options = new gapi.auth2.SigninOptionsBuilder();
options.setAppPackageName('com.example.app');
options.setFetchBasicProfile(True);
options.setPrompt('select_account');
options.setScope('profile').setScope('email');

戻り値
Promise	ユーザーが認証に成功してリクエストされたスコープを付与すると、`GoogleUser` インスタンスで履行される `Promise`。エラーが発生した場合は、`error` プロパティを含むオブジェクトで拒否される（エラーコードについては下記を参照）。

エラーコード

popup_closed_by_user: ユーザーがログインフローを完了する前にポップアップを閉じた。
access_denied: 必要なスコープに対する権限がユーザーによって拒否されました。
immediate_failed: 同意フローを表示するまで、ユーザーを自動的に選択することはできません。prompt: 'none' オプションを指定して signIn を使用するとエラーが発生します。前回のセッションでログイン済みの場合、gapi.auth2.init は自動的にユーザーをログインさせるため、このオプションの使用は必須ではありません。

gapi.auth2.SignInOptions

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

パラメータ
`prompt`	`string`	同意フローで特定のモードを強制的に適用します。省略可。有効な値は次のとおりです。 `consent` 認可サーバーはアプリケーションに情報を返す前に、ユーザーに同意を求めます。 `select_account` 認可サーバーが、ユーザーに Google アカウントの選択を求めるプロンプトを表示します。これにより、複数のアカウントを持つユーザーは、現在セッションを行っている可能性のある複数のアカウントの中から選択できます。 `none`（非推奨）認可サーバーでは、認証画面やユーザーの同意画面は表示されません。ユーザーがまだ認証されておらず、リクエストされたスコープに以前に同意されていない場合は、エラーが返されます。 `gapi.auth2.init` では、ユーザーがすでにアプリケーションにログインしている場合、自動的にログインするため、`signIn({prompt: 'none'})` の呼び出しは通常は失敗します。
`scope`	`string`	`gapi.auth2.init` パラメータで定義されたスコープに加えて、スペース区切りの文字列としてリクエストするスコープ。`fetch_basic_profile` が false に設定されていない場合は省略可能です。
`ux_mode`	`string`	ログインフローに使用する UX モード。デフォルトでは、同意フローがポップアップで開きます。有効な値は `popup` と `redirect` です。
`redirect_uri`	`string`	`ux_mode='redirect'` を使用する場合、このパラメータを使用すると、同意フローの最後に使用されるデフォルトの `redirect_uri` をオーバーライドできます。デフォルトの `redirect_uri` は、クエリパラメータとハッシュフラグメントが取り除かれた現在の URL です。

GoogleAuth.signOut()

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

戻り値
Promise	ユーザーがログアウトしたときに実行される `Promise`。

GoogleAuth.disconnect()

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

GoogleAuth.grantOfflineAccess（`options`）

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

引数
`options`	パラメータの Key-Value ペアを含む `gapi.auth2.OfflineAccessOptions` オブジェクト。次に例を示します。 { scope: 'profile email' }

戻り値
Promise	リクエストされたスコープをユーザーが付与し、認証コードを含むオブジェクトを `Promise` のフルフィルメントハンドラに渡すときに実行される `Promise`。次に例を示します。 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) メソッドのさまざまな構成パラメータを表すインターフェース。

パラメータ
`prompt`	`string`	同意フローで特定のモードを強制的に適用します。省略可。有効な値は次のとおりです。 `consent` 認可サーバーはアプリケーションに情報を返す前に、ユーザーに同意を求めます。 `select_account` 認可サーバーが、ユーザーに Google アカウントの選択を求めるプロンプトを表示します。これにより、複数のアカウントを持つユーザーは、現在セッションを行っている可能性のある複数のアカウントの中から選択できます。オフラインコードフローでは `none` を使用できません。
`scope`	`string`	`gapi.auth2.init` パラメータで定義されたスコープに加えて、スペース区切りの文字列としてリクエストするスコープ。`fetch_basic_profile` が false に設定されていない場合は省略可能です。

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

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

引数
`container`	クリックハンドラをアタッチする `div` 要素の ID または参照。
`options`	パラメータの Key-Value ペアを含むオブジェクト。GoogleAuth.signIn() をご覧ください。
`onsuccess`	ログインの完了後に呼び出す関数。
`onfailure`	ログインに失敗した場合に呼び出す関数。

ユーザー数

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

GoogleAuth.currentUser.get()

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

戻り値
`GoogleUser`	現在のユーザー

GoogleAuth.currentUser.listen（`listener`）

currentUser の変更をリッスンします。

引数
`listener`	`GoogleUser` パラメータを受け取る関数。 `listen` は、`currentUser` を変更するたびにこの関数に `GoogleUser` インスタンスを渡します。

GoogleUser.getId()

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

現在ログインしているユーザーをバックエンドサーバーに伝えるのに、getId() から返された Google ID は使用しないでください。代わりに、サーバー上で安全に検証できるID トークンを送信します。

戻り値
文字列	ユーザーの一意の ID

GoogleUser.isSignedIn()

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

戻り値
ブール値	ユーザーがログインしている場合は true

GoogleUser.getHostedDomain()

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

戻り値
文字列	ユーザーの G Suite ドメイン

GoogleUser.getGrantedScopes()

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

戻り値
文字列	ユーザーが付与したスコープ

GoogleUser.getBasicProfile()

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

戻り値
`gapi.auth2.BasicProfile`	`gapi.auth2.BasicProfile` のプロパティは、次のメソッドで取得できます。 BasicProfile.getId() BasicProfile.getName() BasicProfile.getGivenName() BasicProfile.getFamilyName() BasicProfile.getImageUrl() BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

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

引数
`includeAuthorizationData`	省略可: 常にアクセストークンとスコープを返すかどうかを指定するブール値。デフォルトでは、`fetch_basic_profile` が true（デフォルト値）で、追加のスコープがリクエストされていない場合、アクセストークンとリクエストされたスコープは返されません。

戻り値
`gapi.auth2.AuthResponse`	`gapi.auth2.AuthResponse` オブジェクト。

GoogleUser.reloadAuthResponse()

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

戻り値
`Promise`	OAuth トークンの再読み込み時に再読み込みされた `gapi.auth2.AuthResponse` で履行される `Promise` が完了しています。

gapi.auth2.AuthResponse

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

プロパティ
`access_token`	`string`	付与されたアクセストークン。
`id_token`	`string`	付与された ID トークン。
`scope`	`string`	アクセストークンで付与されるスコープ。
`expires_in`	`number`	アクセストークンの期限が切れるまでの秒数。
`first_issued_at`	`number`	リクエストされたスコープをユーザーが最初に付与した時点のタイムスタンプ。
`expires_at`	`number`	アクセストークンの有効期限が切れるタイムスタンプ。

GoogleUser.hasGrantedScopes（`scopes`）

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

引数
`scopes`	スペースで区切られたスコープの文字列。

戻り値
ブール値	スコープが付与された場合は true

GoogleUser.grant（`options`）

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

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

GoogleUser.grantOfflineAccess（`options`）

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

引数
`options`	パラメータの Key-Value ペアを含む `gapi.auth2.OfflineAccessOptions` オブジェクト。次に例を示します。 { scope: 'profile email' }

GoogleUser.disconnect()

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

UI 要素

gapi.signin2.render(`id`, `options`)

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

引数

id ログインボタンをレンダリングする要素の ID。

options

ボタンのレンダリングに使用する設定を含むオブジェクト。次に例を示します。

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

次のオプションを指定できます。

パラメータ
スコープ	ユーザーがログインしたときにリクエストするスコープ（デフォルト: `profile`）。
width	ピクセル単位のボタンの幅（デフォルト: `120`）。
height	ピクセル単位のボタンの高さ（デフォルト: `36`）。
長いタイトル	「ログイン」ではなく「Google でログイン」のような長いラベルを表示します（デフォルト: `false`）。長いタイトルを使用する場合は、ボタンの幅をデフォルトから大きくする必要があります。
テーマ	ボタンのカラーテーマ: `light` または `dark`（デフォルト: `light`）。
onsuccess	ユーザーがログインに成功したときに呼び出すコールバック関数。この関数は 1 つの引数、`gapi.auth2.GoogleUser` のインスタンスを取る必要があります（デフォルト: none）。
失敗	ログインに失敗したときに呼び出すコールバック関数。この関数は引数を受け取りません（デフォルト: none）。

上級

gapi.auth2.authorize(`params`, `callback`)

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

このメソッドが役立つユースケースとしては、次のようなものがあります。

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

警告: 推奨の gapi.auth2.init および signIn フローと併用しないでください。これらは 2 つの異なる動作（gapi.auth2.authorize の承認と gapi.auth2.init/signIn の認証）であり、同じアプリケーション内で使用すると予期しない問題が発生します。

引数
`params`	構成データの Key-Value ペアを含むオブジェクト。構成可能な別のプロパティについては、`gapi.auth2.AuthorizeConfig` をご覧ください。次に例を示します。 { client_id: 'CLIENT_ID.apps.googleusercontent.com', scope: 'email profile openid', response_type: 'id_token permission' }
`callback`	リクエストの完了（正常に完了、または失敗した）後に `gapi.auth2.AuthorizeResponse` オブジェクトで呼び出される関数。

例

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 メソッドのさまざまな構成パラメータを表すインターフェース。

プロパティ
`client_id`	`string`	必須。Google Cloud コンソールで確認および作成されたアプリのクライアント ID。
`scope`	`string`	必須。リクエストするスコープ。スペース区切りの文字列で指定します。
`response_type`	`string`	スペース区切りのレスポンスタイプのリスト。デフォルトは `'permission'` です。可能な値は次のとおりです。 `id_token`: ID トークンを取得します。 `permission`（または `token`）: アクセストークンを取得します。 `code`: 認可コードを取得します。
`prompt`	`string`	同意フローで特定のモードを強制的に適用します。可能な値は次のとおりです。 `consent` 認可サーバーはアプリケーションに情報を返す前に、ユーザーに同意を求めます。 `select_account` 認可サーバーが、ユーザーに Google アカウントの選択を求めるプロンプトを表示します。これにより、複数のアカウントを持つユーザーは、現在セッションを行っている可能性のある複数のアカウントの中から選択できます。 `none` 認可サーバーでは、認証画面やユーザーの同意画面は表示されません。ユーザーがまだ認証されておらず、リクエストされたスコープに以前に同意されていない場合は、エラーが返されます。レスポンスタイプとして `code` をリクエストした場合、返されるコードは、`refresh_token` ではなく `access_token` とのみ交換できます。注 : ライブラリは内部で、最後に取得したアクセストークンをキャッシュに保存し、自動的に更新します。`prompt: 'none'` を使用すると、ほとんどの場合、有効なトークンを取得するためにバックエンドへの HTTP リクエストは必要ありません。
`cookie_policy`	`string`	ログイン Cookie を作成するドメイン。URI、`single_host_origin`、`none` のいずれか。指定しない場合のデフォルトは `single_host_origin` です。
`hosted_domain`	`string`	ユーザーがログインするために所属する必要がある G Suite ドメイン。これはクライアントによって変更される可能性があるため、返されたユーザーのホストドメインのプロパティを必ず確認してください。
`login_hint`	`string`	ログインフローで事前選択するユーザーのメールアドレスまたはユーザー ID。`prompt: "none"` が使用されない限り、ユーザーが変更しやすくなります。
`include_granted_scopes`	`boolean`	ユーザーが以前にアプリに付与したすべてのスコープを含むアクセストークンをリクエストするか、現在の呼び出しでリクエストされたスコープのみをリクエストするかを指定します。デフォルトは `true` です。
`plugin_name`	`string`	（省略可）設定すると、2022 年 7 月 29 日より前に作成されたクライアント ID で Google プラットフォームライブラリを使用できます。デフォルトでは、新しく作成されたクライアント ID はプラットフォームライブラリを使用できないため、代わりに新しい Google Identity Services ライブラリを使用する必要があります。任意の値を選択できます。識別しやすいように、プロダクト名やプラグイン名など、わかりやすい名前をおすすめします。例: `plugin_name: 'YOUR_STRING_HERE'`

gapi.auth2.AuthorizeResponse

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

プロパティ
`access_token`	`string`	付与されたアクセストークン。`response_type` で `permission` または `token` が指定されていた場合にのみ存在します。
`id_token`	`string`	付与された ID トークン。`response_type` で `id_token` が指定されていた場合にのみ存在します。
`code`	`string`	付与された認証コード。`response_type` で `code` が指定されていた場合にのみ存在します。
`scope`	`string`	アクセストークンで付与されるスコープ。`response_type` で `permission` または `token` が指定されていた場合にのみ存在します。
`expires_in`	`number`	アクセストークンの期限が切れるまでの秒数。`response_type` で `permission` または `token` が指定されていた場合にのみ存在します。
`first_issued_at`	`number`	リクエストされたスコープをユーザーが最初に付与した時点のタイムスタンプ。`response_type` で `permission` または `token` が指定されていた場合にのみ存在します。
`expires_at`	`number`	アクセストークンの有効期限が切れるタイムスタンプ。`response_type` で `permission` または `token` が指定されていた場合にのみ存在します。
`error`	`string`	リクエストが失敗した場合、エラーコードが記録されます。
`error_subtype`	`string`	リクエストが失敗した場合は、返されるエラーコードの追加情報が含まれる可能性があります。

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

Auth の設定

gapi.auth2.init（params）

GoogleAuth.then（onInit、onError）

エラーコード

gapi.auth2.ClientConfig

認証

gapi.auth2.getAuthInstance()

GoogleAuth.isSignedIn.get()

GoogleAuth.isSignedIn.listen(listener)

GoogleAuth.signIn()

エラーコード

GoogleAuth.signIn（options）

エラーコード

gapi.auth2.SignInOptions

GoogleAuth.signOut()

GoogleAuth.disconnect()

GoogleAuth.grantOfflineAccess（options）

エラーコード

gapi.auth2.OfflineAccessOptions

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

ユーザー数

GoogleAuth.currentUser.get()

GoogleAuth.currentUser.listen（listener）

GoogleUser.getId()

GoogleUser.isSignedIn()

GoogleUser.getHostedDomain()

GoogleUser.getGrantedScopes()

GoogleUser.getBasicProfile()

GoogleUser.getAuthResponse(includeAuthorizationData)

GoogleUser.reloadAuthResponse()

gapi.auth2.AuthResponse

GoogleUser.hasGrantedScopes（scopes）

GoogleUser.grant（options）

GoogleUser.grantOfflineAccess（options）

GoogleUser.disconnect()

UI 要素

gapi.signin2.render(id, options)

上級

gapi.auth2.authorize(params, callback)

例

エラーコード

gapi.auth2.AuthorizeConfig

gapi.auth2.AuthorizeResponse

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

gapi.auth2.init（`params`）

GoogleAuth.then（`onInit`、`onError`）

GoogleAuth.signIn（`options`）

GoogleAuth.grantOfflineAccess（`options`）

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

GoogleAuth.currentUser.listen（`listener`）

GoogleUser.hasGrantedScopes（`scopes`）

GoogleUser.grant（`options`）

GoogleUser.grantOfflineAccess（`options`）

gapi.signin2.render(`id`, `options`)

gapi.auth2.authorize(`params`, `callback`)