google_sign_in 3.0.3

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 100

google_sign_in

pub package

A Flutter plugin for Google Sign In.

Note: This plugin is still under development, and some APIs might not be available yet. Feedback and Pull Requests are most welcome!

Android integration

To access Google Sign-In, you'll need to make sure to register your application.

You don't need to include the google-services.json file in your app unless you are using Google services that require it. You do need to enable the OAuth APIs that you want, using the Google Cloud Platform API manager. For example, if you want to mimic the behavior of the Google Sign-In sample app, you'll need to enable the Google People API.

iOS integration

  1. First register your application.
  2. Open Xcode. You'll have to paste this into Xcode to properly register GoogleServices-Info.plist.
  3. Select GoogleServices-Info.plist from the file manager and drag that file into the Runner directory, [my_project]/ios/Runner/GoogleServices-Info.plist.
  4. A dialog will show up and ask you to select the targets, select the Runner target.
  5. Then add the CFBundleURLTypes attributes below into the [my_project]/ios/Runner/Info.plist file.
<!-- Put me in the [my_project]/ios/Runner/Info.plist file -->
<!-- Google Sign-in Section -->
<key>CFBundleURLTypes</key>
<array>
	<dict>
		<key>CFBundleTypeRole</key>
		<string>Editor</string>
		<key>CFBundleURLSchemes</key>
		<array>
			<!-- TODO Replace this value: -->
			<!-- Copied from GoogleServices-Info.plist key REVERSE_CLIENT_ID -->
			<string>com.googleusercontent.apps.861823949799-vc35cprkp249096uujjn0vvnmcvjppkn</string>
		</array>
	</dict>
</array>
<!-- End of the Google Sign-in Section -->

Usage

Import the package

To use this plugin, follow the plugin installation instructions.

Use the plugin

Add the following import to your Dart code:

import 'package:google_sign_in/google_sign_in.dart';

Initialize GoogleSignIn with the scopes you want:

GoogleSignIn _googleSignIn = new GoogleSignIn(
  scopes: [
    'email',
    'https://www.googleapis.com/auth/contacts.readonly',
  ],
);

You can now use the GoogleSignIn class to authenticate in your Dart code, e.g.

Future<Null> _handleSignIn() async {
  try {
    await _googleSignIn.signIn();
  } catch (error) {
    print(error);
  }
}

Example

Find the example wiring in the Google sign-in example application.

API details

See the google_sign_in.dart for more API details.

Issues and feedback

Please file issues to send feedback or report a bug. Thank you!

3.0.3

  • Added support for games sign in on Android.

3.0.2

  • Updated Google Play Services dependency to version 15.0.0.

3.0.1

  • Simplified podspec for Cocoapods 1.5.0, avoiding link issues in app archives.

3.0.0

  • Breaking change. Set SDK constraints to match the Flutter beta release.

2.1.2

  • Added a Delegate interface (IDelegate) that can be implemented by clients in order to override the functionality (for testing purposes for example).

2.1.1

  • Fixed Dart 2 type errors.

2.1.0

  • Enabled use in Swift projects.

2.0.1

  • Simplified and upgraded Android project template to Android SDK 27.
  • Updated package description.

2.0.0

  • Breaking change. Upgraded to Gradle 4.1 and Android Studio Gradle plugin 3.0.1. Older Flutter projects need to upgrade their Gradle setup as well in order to use this version of the plugin. Instructions can be found here.
  • Relaxed GMS dependency to [11.4.0,12.0[

1.0.3

  • Add FLT prefix to iOS types

1.0.2

  • Support setting foregroundColor in the avatar.

1.0.1

  • Change GMS dependency to 11.+

1.0.0

  • Make GoogleUserCircleAvatar fade profile image over the top of placeholder
  • Bump to released version

0.3.1

  • Updated GMS to always use latest patch version for 11.0.x builds

0.3.0

  • Add a new GoogleIdentity interface, implemented by GoogleSignInAccount.
  • Move GoogleUserCircleAvatar to "widgets" library (exported by base library for backwards compatibility) and make it take an instance of GoogleIdentity, thus allowing it to be used by other packages that provide implementations of GoogleIdentity.

0.2.1

  • Plugin can (once again) be used in apps that extend FlutterActivity
  • signInSilently is guaranteed to never throw
  • A failed sign-in (caused by a failing init step) will no longer block subsequent sign-in attempts

0.2.0

  • Updated dependencies
  • Breaking Change: You need to add a maven section with the "https://maven.google.com" endpoint to the repository section of your android/build.gradle. For example:
allprojects {
    repositories {
        jcenter()
        maven {                              // NEW
            url "https://maven.google.com"   // NEW
        }                                    // NEW
    }
}

0.1.0

  • Update to use GoogleSignIn CocoaPod

0.0.6

  • Fix crash on iOS when signing in caused by nil uiDelegate

0.0.5

  • Require the use of support-v4 library on Android. This is an API change in that plugin users will need their activity class to be an instance of android.support.v4.app.FragmentActivity. Flutter framework provides such an activity out of the box: io.flutter.app.FlutterFragmentActivity
  • Ignore "Broken pipe" errors affecting iOS simulator
  • Update to non-deprecated application:openURL:options: on iOS

0.0.4

  • Prevent race conditions when GoogleSignIn methods are called concurrently (#94)

0.0.3

  • Fix signOut and disconnect (they were silently ignored)
  • Fix test (#10050)

0.0.2

  • Don't try to sign in again if user is already signed in

0.0.1

  • Initial Release

example/lib/main.dart

// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'dart:convert' show json;

import "package:http/http.dart" as http;
import 'package:flutter/material.dart';
import 'package:google_sign_in/google_sign_in.dart';

GoogleSignIn _googleSignIn = new GoogleSignIn(
  scopes: <String>[
    'email',
    'https://www.googleapis.com/auth/contacts.readonly',
  ],
);

void main() {
  runApp(
    new MaterialApp(
      title: 'Google Sign In',
      home: new SignInDemo(),
    ),
  );
}

class SignInDemo extends StatefulWidget {
  @override
  State createState() => new SignInDemoState();
}

class SignInDemoState extends State<SignInDemo> {
  GoogleSignInAccount _currentUser;
  String _contactText;

  @override
  void initState() {
    super.initState();
    _googleSignIn.onCurrentUserChanged.listen((GoogleSignInAccount account) {
      setState(() {
        _currentUser = account;
      });
      if (_currentUser != null) {
        _handleGetContact();
      }
    });
    _googleSignIn.signInSilently();
  }

  Future<Null> _handleGetContact() async {
    setState(() {
      _contactText = "Loading contact info...";
    });
    final http.Response response = await http.get(
      'https://people.googleapis.com/v1/people/me/connections'
          '?requestMask.includeField=person.names',
      headers: await _currentUser.authHeaders,
    );
    if (response.statusCode != 200) {
      setState(() {
        _contactText = "People API gave a ${response.statusCode} "
            "response. Check logs for details.";
      });
      print('People API ${response.statusCode} response: ${response.body}');
      return;
    }
    final Map<String, dynamic> data = json.decode(response.body);
    final String namedContact = _pickFirstNamedContact(data);
    setState(() {
      if (namedContact != null) {
        _contactText = "I see you know $namedContact!";
      } else {
        _contactText = "No contacts to display.";
      }
    });
  }

  String _pickFirstNamedContact(Map<String, dynamic> data) {
    final List<dynamic> connections = data['connections'];
    final Map<String, dynamic> contact = connections?.firstWhere(
      (dynamic contact) => contact['names'] != null,
      orElse: () => null,
    );
    if (contact != null) {
      final Map<String, dynamic> name = contact['names'].firstWhere(
        (dynamic name) => name['displayName'] != null,
        orElse: () => null,
      );
      if (name != null) {
        return name['displayName'];
      }
    }
    return null;
  }

  Future<Null> _handleSignIn() async {
    try {
      await _googleSignIn.signIn();
    } catch (error) {
      print(error);
    }
  }

  Future<Null> _handleSignOut() async {
    _googleSignIn.disconnect();
  }

  Widget _buildBody() {
    if (_currentUser != null) {
      return new Column(
        mainAxisAlignment: MainAxisAlignment.spaceAround,
        children: <Widget>[
          new ListTile(
            leading: new GoogleUserCircleAvatar(
              identity: _currentUser,
            ),
            title: new Text(_currentUser.displayName),
            subtitle: new Text(_currentUser.email),
          ),
          const Text("Signed in successfully."),
          new Text(_contactText),
          new RaisedButton(
            child: const Text('SIGN OUT'),
            onPressed: _handleSignOut,
          ),
          new RaisedButton(
            child: const Text('REFRESH'),
            onPressed: _handleGetContact,
          ),
        ],
      );
    } else {
      return new Column(
        mainAxisAlignment: MainAxisAlignment.spaceAround,
        children: <Widget>[
          const Text("You are not currently signed in."),
          new RaisedButton(
            child: const Text('SIGN IN'),
            onPressed: _handleSignIn,
          ),
        ],
      );
    }
  }

  @override
  Widget build(BuildContext context) {
    return new Scaffold(
        appBar: new AppBar(
          title: const Text('Google Sign In'),
        ),
        body: new ConstrainedBox(
          constraints: const BoxConstraints.expand(),
          child: _buildBody(),
        ));
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  google_sign_in: ^3.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:google_sign_in/google_sign_in.dart';
  
Version Uploaded Documentation Archive
3.2.4 Nov 10, 2018 Go to the documentation of google_sign_in 3.2.4 Download google_sign_in 3.2.4 archive
3.2.2 Oct 24, 2018 Go to the documentation of google_sign_in 3.2.2 Download google_sign_in 3.2.2 archive
3.2.1 Oct 3, 2018 Go to the documentation of google_sign_in 3.2.1 Download google_sign_in 3.2.1 archive
3.0.5 Aug 21, 2018 Go to the documentation of google_sign_in 3.0.5 Download google_sign_in 3.0.5 archive
3.0.4 Jun 1, 2018 Go to the documentation of google_sign_in 3.0.4 Download google_sign_in 3.0.4 archive
3.0.3+1 May 23, 2018 Go to the documentation of google_sign_in 3.0.3+1 Download google_sign_in 3.0.3+1 archive
3.0.3 May 1, 2018 Go to the documentation of google_sign_in 3.0.3 Download google_sign_in 3.0.3 archive
3.0.2 Apr 18, 2018 Go to the documentation of google_sign_in 3.0.2 Download google_sign_in 3.0.2 archive
3.0.1 Apr 11, 2018 Go to the documentation of google_sign_in 3.0.1 Download google_sign_in 3.0.1 archive
3.0.0 Mar 9, 2018 Go to the documentation of google_sign_in 3.0.0 Download google_sign_in 3.0.0 archive

All 27 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
100
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
100
Learn more about scoring.

We analyzed this package on Dec 6, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.7
  • Flutter: 1.0.0

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.28.0 <3.0.0
flutter 0.0.0
meta ^1.0.4 1.1.6
Transitive dependencies
collection 1.14.11
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test