---

📋 Table of Contents

- ✨ Features
- 📦 Installation
- ⚙️ Setup
- 📱 Step 1: Enable New Architecture
- ☁️ Step 2: Google Cloud Console Setup
- 🚀 Usage
- 🎯 One Tap Sign-In
- 👤 Sign-In with Account Chooser
- 🔐 Legacy OAuth Sign-In
- 📝 API Reference
- 🛠️ Troubleshooting
- 📄 License

---

✨ Features

$3 - ✅ One Tap Sign-In (Credential Manager) - ✅ Account Chooser UI - ✅ Legacy OAuth Support

$3 - ✅ TurboModule (New Architecture) - ✅ Codegen Type Safety - ✅ Android Only (for now)

$3

| Method | Description | Use Case |
| ---------------- | ---------------------------- | ----------------------------------------- |
| oneTap() | One Tap / Credential Manager | Quick sign-in for returning users |
| signIn() | Account Chooser UI | First-time sign-in, account selection |
| legacySignIn() | Legacy OAuth with scopes | Advanced features (Drive, Calendar, etc.) |
| signOut() | Sign out current user | Logout, clear session |

---

📦 Installation

``bash

Using npm

npm install @react-native-auth/google

Using yarn

yarn add @react-native-auth/google
`

---

⚙️ Setup

$3

Show details

Add to your android/gradle.properties:

`properties
newArchEnabled=true
kotlin.version=2.1.20
`



$3

Show details

$3

Go to Google Cloud Console and create/select your project.

$3

1. Navigate to APIs & Services → Library
2. Search for "Google Sign-In API" or "Google Identity"
3. Click Enable

$3

You need TWO client IDs:

#### a) 📱 Android Client ID

For app verification (SHA-1 fingerprint required)

1. Go to APIs & Services → Credentials
2. Click Create Credentials → OAuth 2.0 Client ID
3. Select Android
4. Fill in:
- Name: Your App (Android)
- Package name: com.yourapp (from android/app/build.gradle)
- SHA-1 fingerprint: Get it by running:

`bash
# Debug
keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

# Release
keytool -list -v -keystore /path/to/release.keystore -alias your-alias
`

5. Click Create

#### b) 🌐 Web Client ID

For authentication (USE THIS IN YOUR CODE)

1. Click Create Credentials → OAuth 2.0 Client ID again
2. Select Web application
3. Fill in:
- Name: Your App (Web)
- Authorized redirect URIs: Leave empty
4. Click Create
5. Copy the Web Client ID → xxxxx.apps.googleusercontent.com

> 💡 Pro Tip: The Android Client ID verifies your app. The Web Client ID is used for authentication.



---

🚀 Usage

$3

`typescript
import { oneTap, signIn, legacySignIn, signOut } from '@react-native-auth/google';
``

$3

Quick authentication for returning users with saved credentials.

`typescript
const CLIENT_ID = 'YOUR_WEB_CLIENT_ID.apps.googleusercontent.com';

try {
const result = await oneTap({ clientId: CLIENT_ID });
console.log('✅ Signed in:', result.idToken);
console.log('📧 Email:', result.email);
} catch (error) {
console.error('❌ Sign-in failed:', error);
}
`

$3

Display account picker UI for first-time users or account switching.

`typescript
const result = await signIn({
clientId: CLIENT_ID,
});
`

$3

Advanced authentication with custom OAuth scopes (Drive, Calendar, etc.)

`typescript
const result = await legacySignIn({
clientId: CLIENT_ID,
scopes: [
'https://www.googleapis.com/auth/drive.readonly',
'https://www.googleapis.com/auth/calendar.readonly',
],
prompt: 'consent', // Optional: Force consent screen
});
`

#### 📍 prompt Parameter

Controls the authentication flow behavior:

| Value | Behavior |
| ---------------- | -------------------------------------------------- |
| undefined | Default behavior - no forced interaction |
| 'consent' | Always show consent screen, even for existing app |
| 'login' | Always show login screen, force account selection |
| 'select_account' | Always show account selection screen |
| 'none' | Silent authentication (may fail if no session) |

Example - Force Consent Screen:

`typescript
const result = await legacySignIn({
clientId: CLIENT_ID,
scopes: ['https://www.googleapis.com/auth/calendar'],
prompt: 'consent', // Useful when updating permissions
});
`

Example - Force Account Selection:

`typescript
const result = await legacySignIn({
clientId: CLIENT_ID,
prompt: 'select_account', // Always show account picker
});
`

Example - Force Login:

`typescript
const result = await legacySignIn({
clientId: CLIENT_ID,
prompt: 'login', // Useful for switching accounts
});
`

$3

Sign out the current user and clear the session.

`typescript
try {
await signOut();
console.log('✅ Signed out successfully');
} catch (error) {
console.error('❌ Sign-out failed:', error);
}
`

---

📝 API Reference

$3

`typescript
type GoogleAuthOptions = {
clientId: string; // Your Web Client ID
scopes?: string[]; // OAuth scopes (legacySignIn only)
prompt?: string; // Consent behavior: 'consent', 'login', 'none'
};

type GoogleAuthResult = {
idToken: string; // JWT ID token
email?: string; // User email (if available)
};
``

---

🛠️ Troubleshooting

Common Issues

$3

- ✅ Verify you're using the Web Client ID, not Android Client ID
- ✅ Check SHA-1 fingerprint is correctly added for Android Client ID
- ✅ Ensure Google Sign-In API is enabled in Console

$3

- ✅ Test on Android 9+ (API level 28+)
- ✅ Ensure Google Play Services is updated
- ✅ Test on a physical device (emulators may have issues)

---

📄 License


---