CapacitorGoogleAuthのダウンロードCapacitorGoogleAuthソースコードのダウンロード

CapacitorGoogleAuth

ウェブサイトデータ

v3.3.6

ダウンロード

警告

このプラグインは、資格情報マネージャーやプライバシーマニフェストなどの新機能の場合は、https：//github.com/cap-go/capacitor-social-loginを使用してください。

コンデンソグルー

@codetrix-studio/capacitor-google-auth

コンデンサ6

Google Authのコンデンサプラグイン。

V6の変化を破る

V6バージョンでは、初期化方法のclientId 、セットアップできる他の場所よりも優先されて使用されます。これをWebでのみ使用する前に、モバイルで設定してください。または、古い動作を複製するために条件付きで設定します。

貢献

このプラグインをコンデンサと公式のGoogle Auth Platform Library機能のパリティで最新の状態に保つPRを大歓迎します。

良いコードプラクティスに従ってください。付属のデモを更新するのを支援することもできます。

Google Auth Libraryの公式に整合していない機能のPRSは落胆しています。

（私たちはここで初心者に優しいです）

インストール

1.パッケージをインストールします

npm i --save @codetrix-studio/capacitor-google-auth

# pnpm 
pnpm add @codetrix-studio/capacitor-google-auth

# yarn 
yarn add @codetrix-studio/capacitor-google-auth

2。コンデンサDEPSを更新します

npx cap update

更新

さまざまなコンデンサバージョンに移行する必要がある場合は、プラグインを新しいバージョンに移行する命令を参照してください。

使用法

ウェブ

プラグインを登録し、手動で初期化します

 import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth' ;

// use hook after platform dom ready
GoogleAuth . initialize ( {
  clientId : 'CLIENT_ID.apps.googleusercontent.com' ,
  scopes : [ 'profile' , 'email' ] ,
  grantOfflineAccess : true ,
} ) ;

または、必要な場合はメタタグを使用します（オプション）：

 < meta name =" google-signin-client_id " content =" {your client id here} " />
< meta name =" google-signin-scope " content =" profile email " />

オプション

clientId -Google Developers Consoleで見つけて作成されたアプリのクライアントID。
scopes - スコープの構成と同じ
grantOfflineAccess - ブール、デフォルトのfalse 、アプリケーションがブラウザに存在しないときにアプリケーションがアクセストークンを更新する必要がある場合は設定します。

使用してください

 GoogleAuth . signIn ( ) ;

角度

initフック

 // app.component.ts
constructor ( ) {
  this . initializeApp ( ) ;
}

initializeApp ( ) {
  this . platform . ready ( ) . then ( ( ) => {
    GoogleAuth . initialize ( )
  } )
}

サインイン機能

 import { GoogleAuth } from "@codetrix-studio/capacitor-google-auth" ;
import { Auth , GoogleAuthProvider , signInWithCredential } from '@angular/fire/auth' ;

async googleSignIn ( ) {
  let googleUser = await GoogleAuth . signIn ( ) ;

  /*
    If you use Firebase you can forward and use the logged in Google user like this:
  */
  constructor ( private auth : Auth ) { }

  const googleUser = await GoogleAuth . signIn ( ) ;
  const _credential = GoogleAuthProvider . credential ( googleUser . authentication . idToken ) ;
  return signInWithCredential ( this . auth , _credential ) ;
}

Vue 3

< script setup lang="ts">
import { defineComponent , onMounted } from ' vue ' ;
import { GoogleAuth } from ' @codetrix-studio/capacitor-google-auth ' ;

onMounted (() => {
  GoogleAuth . initialize ();
});

async function logIn() {
  const response = await GoogleAuth . signIn ();
  console . log ( response );
}
</ script >

または、より多くのCabeGoOgLeauth-Vue3-Exampleを参照してください

iOS

iOS用のGoogle Cloud Console資格認定IDを作成し、クライアントIDとiOS URLスキームを取得する
iOS URLスキームからInfo.plistにurlスキームとしてREVERSED_CLIENT_IDをroversed_client_idを追加する
（xcode：app-ターゲット/アプリ - 情報 - urlタイプ、クリックプラスアイコン）
クライアントIDを1つの方法の1つを設定します（プラグインで重要な順序によって）：
1. 初期化メソッドでclientId設定します
2. capacitor.config.jsonにiosClientId設定します
3. capacitor.config.jsonでclientIdを設定します
4. GoogleService-Info.plistでCLIENT_ID設定します

アンドロイド

クライアントIDを設定します（プラグインで重要な順序によって）：

初期化メソッドでclientId設定します
capacitor.config.jsonのandroidClientId設定します
capacitor.config.jsonでclientIdを設定します
strings.xmlでserver_client_idを設定します

< resources >
  < string name = " server_client_id " >Your Web Client Key</ string >
</ resources >

Play Services Authバージョンの変更（オプション）：

このプラグインはcom.google.android.gms:play-services-auth:21.2.0 gmsPlayServicesAuthVersion使用しますvariables.gradle

更新方法

このメソッドは、ユーザーが現在ログインしているかどうかを確立するためにアプリが初期化されたときに呼び出されます。真の場合、メソッドはAccessToken、Idtoken、および空の爽快なものを返します。

 checkLoggedIn ( ) {
    GoogleAuth . refresh ( )
        . then ( ( data ) => {
            if ( data . accessToken ) {
                this . currentTokens = data ;
            }
        } )
        . catch ( ( error ) => {
            if ( error . type === 'userLoggedOut' ) {
                this . signin ( )
            }
        } ) ;
}

設定します

名前	タイプ	説明
clientid	弦	Google Developers Consoleで見つけて作成されたアプリのクライアントID。
iosclientid	弦	iOSの特定のクライアントIDキー
AndroidClientID	弦	Androidの特定のクライアントIDキー
スコープ	弦[]	Google APIにアクセスするためにリクエストする必要があるかもしれないスコープ https://developers.google.com/identity/protocols/oauth2/scopes
serverClientID	弦	オフラインアクセスとサーバーサイドの取り扱いに使用されるこのclientID
forcodeforrefreshtoken	ブール	ユーザーに電子メールアドレスを選択して、AuthCodeを再生成します有効なRefreshtoken（iOSとAndroidの作業）を取得するために使用されます

root capacitor.config.jsonで構成を提供します

{
  "plugins" : {
    "GoogleAuth" : {
      "scopes" : [ " profile " , " email " ],
      "serverClientId" : " xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com " ,
      "forceCodeForRefreshToken" : true
    }
  }
}

またはcapacitor.config.tsで

 /// <reference types="'@codetrix-studio/capacitor-google-auth'" />

const config : CapacitorConfig = {
  plugins : {
    GoogleAuth : {
      scopes : [ 'profile' , 'email' ] ,
      serverClientId : 'xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com' ,
      forceCodeForRefreshToken : true ,
    } ,
  } ,
} ;

export default config ;

注：スコープは、 `initialize`機能の下で構成できます。

API

initialize(...)
signIn()
refresh()
signOut()
インターフェイス

初期化（...）

 initialize ( options ?: InitOptions ) = > void

GoogleAuthPluginを初期化し、GAPIライブラリをロードしてプラグインを設定します。

パラメーション	タイプ	説明
`options`	`InitOptions`	- オプションの初期化オプション。

以来： 3.1.0

サインイン（）

 signIn ( ) = > Promise < User >

サインインプロセスを開始し、ユーザー情報で解決する約束を返します。

返品： Promise<User>

REFRESH（）

 refresh ( ) = > Promise < Authentication >

認証トークンを更新し、更新された認証の詳細で解決する約束を返します。

返品： Promise<Authentication>

サインアウト（）

 signOut ( ) = > Promise < any >

ユーザーにサインアウトし、約束を返します。

返品： Promise<any>

インターフェイス

initoptions

小道具	タイプ	説明	デフォルト	以来
`clientId`	`string`	Google Developers Consoleで見つけて作成されたアプリのクライアントID。 AndroidまたはiOSで一般的です。デフォルトは構成で定義されています。		3.1.0
`scopes`	`string[]`	Google APIへのアクセスに必要なスコープを指定します。デフォルトは構成で定義されています。		3.4.0-RC.4
`grantOfflineAccess`	`boolean`	ユーザーがブラウザに存在しない場合、アプリケーションがアクセストークンを更新する必要があるかどうかを設定します。応答して、 `serverAuthCode`キーを使用します	`false`	3.1.0

ユーザー

小道具	タイプ	説明
`id`	`string`	ユーザーの一意の識別子。
`email`	`string`	ユーザーに関連付けられたメールアドレス。
`name`	`string`	ユーザーのフルネーム。
`familyName`	`string`	ユーザーの姓（姓）。
`givenName`	`string`	ユーザーの指定された名前（名）。
`imageUrl`	`string`	ユーザーのプロフィール写真のURL。
`serverAuthCode`	`string`	サーバー認証コード。
`authentication`	`Authentication`	アクセス、更新、IDトークンなどの認証の詳細。

認証

小道具	タイプ	説明
`accessToken`	`string`	認証中に取得したアクセストークン。
`idToken`	`string`	認証中に取得したIDトークン。
`refreshToken`	`string`	リフレッシュトークン。

移行ガイド

3.3.xから3.4.xに移動します

バージョン3.4.xをインストール：

npm i --save @codetrix-studio/capacitor-google-auth@^3.4

Project Conapacitor 6へのプロジェクトの更新をフォローしてください。

3.2.xから3.3.xに移動します

バージョン3.3.xをインストール：

npm i --save @codetrix-studio/capacitor-google-auth^3.3

コンデンサ4からコンデンサ5へのプロジェクトの更新に従ってください。

3.2.1から3.2.2に移動します

ファイルMainActivity.onCreateのAndroidの場合

 - this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
-   add(GoogleAuth.class);
- }});
+ this.registerPlugin(GoogleAuth.class);

3.1.xから3.2.xに移動します

バージョン3.2.xをインストール：

npm i --save @codetrix-studio/capacitor-google-auth^3.2

コンデンサ3からコンデンサ4へのプロジェクトの更新に従ってください。

3.0.2から3.1.0に移動します

 - GoogleAuth.init()
+ GoogleAuth.initialize()

2から3に移動します

バージョン3.xxをインストール：

npm i --save @codetrix-studio/capacitor-google-auth^3.0

Capcitor 3に移行した後、プロジェクトを更新してください。Diffを参照してください。

ウェブ

 - import "@codetrix-studio/capacitor-google-auth";
- import { Plugins } from '@capacitor/core';
+ import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth'

- Plugins.GoogleAuth.signIn();
+ GoogleAuth.init()
+ GoogleAuth.signIn()

1から2に移動します

バージョン2.xxをインストール：

npm i --save @codetrix-studio/capacitor-google-auth@2

コンデンサ2.xxの場合、命令を使用します

ライセンス

mit

拡大する

追加情報

バージョン v3.3.6
タイプウェブサイトデータ
更新時間 2025-06-28
サイズ 894.15KB
から Github

CapacitorGoogleAuth