Skip to content

[google_sign_in] Add troubleshooting to Android README #9581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auto-submit merged 1 commit into from
Jul 10, 2025
Merged

[google_sign_in] Add troubleshooting to Android README #9581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/google_sign_in/google_sign_in_android/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 7.0.2

* Adds a README note about potentially confusing error returns from
`CredentialManager`.

## 7.0.1

* Passes an activity context when requesting credentials, fixing an issue that
Expand Down
25 changes: 22 additions & 3 deletions packages/google_sign_in/google_sign_in_android/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,30 @@ To use Google Sign-In, you'll need to register your application, either
ID of the *web* application you registered as the `serverClientId` when
initializing the `GoogleSignIn` instance.

If you encounter `APIException` errors, double-check that you have followed all
of the registration steps in the instructions above.

You will also need to enable any OAuth APIs that you want, using the
[Google Cloud Platform API manager](https://console.developers.google.com/). For
example, if you want to mimic the behavior of the Google Sign-In example app,
you'll need to enable the
[Google People API](https://developers.google.com/people/).

### Troubleshooting

If you encounter persistent errors, check that you have followed all of the
registration steps in the instructions above. Common signs of configuration
errors include:
* `GoogleSignInException`s with a code of
`GoogleSignInExceptionCode.clientConfigurationError`.
* Unexpected `GoogleSignInException`s with a code of
`GoogleSignInExceptionCode.canceled` after selecting an account during the
authentication process.
* Some configuration errors will cause the underlying
Android `CredentialManager` SDK to return a "canceled" error in this flow,
and unfortunately the `google_sign_in` plugin has no way to distinguish this
case from the user canceling sign-in, so cannot return a more accurate error
message.
* Sign-in working in one build configuration but not another.

Common sources of configuration errors include:
* Missing or incorrect `serverClientId`.
* Missing or incorrect signing SHA for one or more build configurations.
* Incorrect Android package name on the server side.
2 changes: 1 addition & 1 deletion packages/google_sign_in/google_sign_in_android/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: google_sign_in_android
description: Android implementation of the google_sign_in plugin.
repository: https://github.com/flutter/packages/tree/main/packages/google_sign_in/google_sign_in_android
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+google_sign_in%22
version: 7.0.1
version: 7.0.2

environment:
sdk: ^3.6.0
Expand Down