Getting Started

このプラグインのインストール手順と全体のマークダウンガイドを含むセットアップコマンドをコピーできます。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-social-login`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/social-login/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。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.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください:

パッケージをインストール
ターミナル画面
```
npm install @capgo/capacitor-social-login
```
ネイティブプロジェクトと同期
ターミナル画面
```
npx cap sync
```

アプリ起動時に初期化

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,
    },
  },
});

コアフロー例

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 オフラインモード

google.mode: 'offline' 戻り値 serverAuthCode __CAPGO_KEEP_0__

このモードでは、ログアウト、isLoggedIn、getAuthorizationCode、およびrefreshは利用できません。 serverAuthCode 使用 SocialLogin.refresh() あなたのバックエンドのトークン交換にのみ入力として使用してください。アプリ内で呼び出す必要がある場合は、使用してください。 google.mode: 'online' 代わりに。

Apple

Set useProperTokenExchange: true __CAPGO_KEEP_0__の厳格なトークン処理と useBroadcastChannel: true __CAPGO_KEEP_0__のAndroidの簡略化されたセットアップ

OAuth2 Webリダイレクトフロー

使用 OAuth2LoginOptions.flow: 'redirect' __CAPGO_KEEP_0__のページから離れるWebフロー

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

ネイティブアプリサイズを削減するために、使用するプロバイダを選択できます。この機能は、必要なプロバイダのみを使用するアプリでは特に便利です。

プロバイダの設定を追加する 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;

プロバイダの値の意味は次のとおりです:

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

重要な詳細:

Run npx cap sync プロバイダの設定を変更した後実行してください。
プロバイダの設定が指定されない場合、すべてのプロバイダは true のバックグラウンド互換性のためにデフォルトで有効になります。
プロバイダを無効にすると false 実行時には利用できなくなる可能性があります。
この設定はiOSとAndroidのみに影響します。Webには影響しません。
Apple Sign-In on Android uses OAuth without external SDK dependencies.
Twitter/X uses standard OAuth 2.0 without external SDK dependencies.

Google Sign-InとApple Sign-Inのみを含めるには:

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

Getting Started から続ける

あなたが使用している場合 Getting Started 認証とアカウントフローの計画に使用し、 Cloudflareの@capgo/capacitor-social-loginを使用する Cloudflareの@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要素認証 2要素認証の実装詳細について