Google アカウント認証 JavaScript API リファレンス

このリファレンスでは、Google から認証コードまたはアクセス トークンを取得するために使用される Google アカウント認証 JavaScript API について説明します。

メソッド: google.accounts.oauth2.initCodeClient

initCodeClient メソッドは、パラメータの構成を使用してコード クライアントを初期化して返します。

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

データ型: CodeClientConfig

次の表に、CodeClientConfig データ型のプロパティを示します。

データ型: CodeClient

このクラスには、OAuth 2.0 コード UX フローを開始する requestCode というパブリック メソッドが 1 つだけあります。

interface CodeClient {
  requestCode(): void;
}

データ型: CodeResponse

ポップアップ UX の callback メソッドには、CodeResponse JavaScript オブジェクトが渡されます。リダイレクト UX では、CodeResponse は URL パラメータとして渡されます。

次の表に、CodeResponse データ型のプロパティを示します。

メソッド: google.accounts.oauth2.initTokenClient

initTokenClient メソッドは、パラメータの構成でトークン クライアントを初期化して返します。

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

データ型: TokenClientConfig

次の表に、TokenClientConfig データ型のプロパティを示します。

データ型: TokenClient

このクラスには、OAuth 2.0 トークン UX フローを開始する 1 つの公開メソッド requestAccessToken のみがあります。

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}

データ型: OverridableTokenClientConfig

次の表に、OverridableTokenClientConfig データ型のプロパティを示します。

データ型: TokenResponse

ポップアップ UX のコールバック メソッドには、TokenResponse JavaScript オブジェクトが渡されます。

次の表に、TokenResponse データ型のプロパティを示します。

メソッド: google.accounts.oauth2.hasGrantedAllScopes

ユーザーが指定されたすべてのスコープを付与したかどうかを確認します。

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;

メソッド: google.accounts.oauth2.hasGrantedAnyScope

ユーザーが指定されたスコープのいずれかを付与したかどうかを確認します。

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;

メソッド: google.accounts.oauth2.revoke

revoke メソッドは、ユーザーがアプリに付与したすべてのスコープを取り消します。権限を取り消すには、有効なアクセス トークンが必要です。

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;

データ型: RevocationResponse

コールバック メソッドには RevocationResponse JavaScript オブジェクトが渡されます。

次の表に、RevocationResponse データ型のプロパティを示します。