google/googlesignin-ios

Installation

Google Sign-In is distributed with Swift Package Manager.

In Xcode, choose File > Add Package Dependencies…, enter https://github.com/google/GoogleSignIn-iOS, and add the product you need to your target:

• GoogleSignIn — the core SDK (Swift and Objective-C).
• GoogleSignInSwift — the SwiftUI GoogleSignInButton.

Or add it to your Package.swift:

dependencies: [
  .package(url: "https://github.com/google/GoogleSignIn-iOS", from: "10.0.0")
]

and depend on .product(name: "GoogleSignIn", package: "GoogleSignIn-iOS") (and, for SwiftUI, .product(name: "GoogleSignInSwift", package: "GoogleSignIn-iOS")) in your target.

If you currently use CocoaPods, see Migrating from CocoaPods to Swift Package Manager.

Getting Started

Try either the Objective-C or Swift sample app. For example, to demo the Objective-C sample project:

git clone https://github.com/google/GoogleSignIn-iOS
open GoogleSignIn-iOS/Samples/ObjC/SignInSample/SignInSample.xcodeproj

If you would like to see a Swift example, take a look at Samples/Swift/DaysUntilBirthday.

• Add Google Sign-In to your own app by following our

getting started guides.

• Take a look at the

API reference.

Google Sign-In on macOS

Google Sign-In allows your users to sign-in to your native macOS app using their Google account and default browser. When building for macOS, the signInWithConfiguration: and addScopes: methods take a presentingWindow: parameter in place of presentingViewController:. Note that in order for your macOS app to store credentials via the Keychain on macOS, you will need to add $(AppIdentifierPrefix)$(CFBundleIdentifier) as the first item in its keychain access group.

Mac Catalyst

Google Sign-In also supports iOS apps that are built for macOS via Mac Catalyst. In order for your Mac Catalyst app to store credentials via the Keychain on macOS, you will need to add $(AppIdentifierPrefix)$(CFBundleIdentifier) as the first item in the keychain access group.

Using the Google Sign-In Button

There are several ways to add a 'Sign in with Google' button to your app, which path you choose will depend on your UI framework and target platform.

SwiftUI (iOS and macOS)

Creating a 'Sign in with Google' button in SwiftUI can be as simple as this:

GoogleSignInButton {
  GIDSignIn.sharedInstance.signIn(withPresenting: yourViewController) { signInResult, error in
      // check `error`; do something with `signInResult`
  }
}

This example takes advantage of the initializer's default argument for the view model. The default arguments for the view model will use the light scheme, the standard button style, and the normal button state. You can supply an instance of GoogleSignInButtonViewModel with different values for these properties to customize the button. This convenience initializer provides parameters that you can use to set these values as needed.

UIKit (iOS)

If you are not using SwiftUI to build your user interfaces, you can either create GIDSignInButton programmatically, or in a Xib/Storyboard. If you are writing programmatic UI code, it will look something like this:

let button = GIDSignInButton(frame: CGRect(<YOUR_RECT>))

AppKit (macOS)

Given that GIDSignInButton is implemented as a subclass of UIControl, it will not be available on macOS. You can instead use the SwiftUI Google sign-in button. Doing so will require that you wrap the SwiftUI button in a hosting view so that it will be available for use in AppKit.

let signInButton = GoogleSignInButton {
  GIDSignIn.sharedInstance.signIn(withPresenting: yourViewController) { signInResult, error in
      // check `error`; do something with `signInResult`
  }
}
let hostedButton = NSHostingView(rootView: signInButton)

A Note on iOS Keychain Access Groups

GSI uses your default (first listed) keychain access group. If you don't add a custom keychain access group, the default keychain access group is provided by Xcode and looks like $(AppIdentifierPrefix)$(CFBundleIdentifier).

GSI removes keychain items upon fresh install to ensure that stale credentials from previous installs of your app are not mistakenly used. If your app uses a shared access group by default this may lead to new installs of apps sharing the same keychain access group to remove keychain credentials for apps already installed.

To prevent unintentional credential removal, you can explicitly list the typical default access group (or whatever you prefer so long as it is not shared) in your list first. GSI, will then use that default access group.

Package Metadata

Repository: google/googlesignin-ios

Default branch: main

README: README.md