メインコンテンツへスキップ

スタートガイド

GitHub

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください:

ターミナル
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

次に、以下のプロンプトを使用します:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-social-login` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください:

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

    ターミナル
    bun add @capgo/capacitor-social-login
  2. ネイティブプロジェクトと同期

    ターミナル
    bunx cap sync
  3. アプリ起動時に初期化

    import { SocialLogin } from '@capgo/capacitor-social-login';
    await SocialLogin.initialize({
    google: {
    webClientId: 'your-google-web-client-id',
    iOSClientId: 'your-google-ios-client-id',
    iOSServerClientId: 'your-google-web-client-id',
    mode: 'online',
    },
    apple: {
    clientId: 'your-apple-service-id',
    useProperTokenExchange: true,
    useBroadcastChannel: true,
    },
    facebook: {
    appId: 'your-facebook-app-id',
    },
    twitter: {
    clientId: 'your-twitter-client-id',
    redirectUrl: 'myapp://oauth/twitter',
    },
    oauth2: {
    github: {
    appId: 'your-github-client-id',
    authorizationBaseUrl: 'https://github.com/login/oauth/authorize',
    accessTokenEndpoint: 'https://github.com/login/oauth/access_token',
    redirectUrl: 'myapp://oauth/github',
    scope: 'read:user user:email',
    pkceEnabled: true,
    },
    },
    });

チームがこのプラグインを選ぶとき

セクション「このプラグインを選ぶチーム」
  • Google、Apple、Facebook、Twitter/X、カスタム OAuth2 または OIDC プロバイダーを 1 つのパッケージで対応。
  • 非推奨のコミュニティプラグインではなく、Credential Manager 経由で Android の Google Sign-In を利用。
  • ドキュメント化された互換性レイヤーを通じて、Ionic Auth Connect スタイルのプロバイダーに対応。
  • モバイルと Web ビルド間でログイン code を共有する必要があるアプリ。
await SocialLogin.login({
provider: 'google',
options: { scopes: ['profile', 'email'] },
});
await SocialLogin.login({
provider: 'oauth2',
options: {
providerId: 'github',
scope: 'read:user user:email',
},
});
const status = await SocialLogin.isLoggedIn({ provider: 'google' });
await SocialLogin.logout({ provider: 'google' });
// For providers that support this mode
const authCodeResult = await SocialLogin.getAuthorizationCode({ provider: 'google' });
await SocialLogin.refresh({ provider: 'google', options: {} as never });
const jwt = await SocialLogin.decodeIdToken({
idToken: 'eyJhbGciOi...',
});
const { date } = await SocialLogin.getAccessTokenExpirationDate({
accessTokenExpirationDate: Date.now() + 3600 * 1000,
});
const expired = await SocialLogin.isAccessTokenExpired({
accessTokenExpirationDate: Date.now() + 1000,
});
const active = await SocialLogin.isRefreshTokenAvailable({ refreshToken: 'a-token' });

google.mode: 'offline' を返します serverAuthCode ログイン時とは異なります。このモードでは、logout、isLoggedIn、getAuthorizationCode、refresh は利用できません。

使用する serverAuthCode バックエンドでのトークン交換の入力としてのみ使用してください。呼び出す必要がある場合は SocialLogin.refresh() アプリ内で使うには、 google.mode: 'online' こちらを読んでください。

設定 useProperTokenExchange: true 厳格なトークン処理のために useBroadcastChannel: true Android の簡易セットアップのために。

使用する OAuth2LoginOptions.flow: 'redirect' ページから離れる Web フローのために。

プロバイダーの動的依存関係

「動的プロバイダー依存関係」セクション

ネイティブアプリのサイズを削減するために、含めるプロバイダーを設定できます。アプリが特定のプロバイダーのみを必要とする場合に最も役立ちます。

プロバイダー設定を追加 capacitor.config.ts:

import type { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
appId: 'com.example.app',
appName: 'MyApp',
webDir: 'dist',
plugins: {
SocialLogin: {
providers: {
google: true,
facebook: true,
apple: true,
twitter: false,
},
logLevel: 1,
},
},
};
export default config;

Provider の値の意味:

  • true: プロバイダーが有効で、ネイティブ依存関係がバンドルされています。
  • false: プロバイダーが無効で、ネイティブ依存関係はバンドルされていません。

重要なポイント:

  • 実行 bunx cap sync プロバイダー設定の変更後。
  • プロバイダー設定が指定されていない場合、すべてのプロバイダーはデフォルトで true 後方互換性のために。
  • プロバイダーを false 無効にすると、そのプロバイダーがシステムAPIのみを使用している場合でも、実行時に利用できなくなります。
  • この設定はiOSとAndroidにのみ影響し、Webには影響しません。
  • AndroidでのApple Sign-Inは、外部の SDK 依存関係なしでOAuthを使用します。
  • Twitter/X は、外部の SDK 依存関係なしに標準的な OAuth 2.0 を使用します。

Google Sign-In と Apple Sign-In のみをインクルードするには:

plugins: {
SocialLogin: {
providers: {
google: true,
facebook: false,
apple: true,
twitter: false,
},
},
}

Getting Startedの続きを進める

「Getting Started からの続き」セクション

使用している場合 スタートガイド 認証とアカウントフローを計画するには、これを次と連携させてください @capgo/capacitor-social-login の使用 「@capgo/capacitor-social-login の使用」のネイティブ機能のために、 @capgo/capacitor-social-login @capgo/capacitor-social-login の実装の詳細については、 @capgo/capacitor-passkey @capgo/capacitor-passkey の実装詳細については、 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric の実装の詳細、および 2要素認証 二要素認証の実装の詳細については。