By adding the Google Sign-In button to your web site, you can automatically prompt your users to download your Android app over the air to their Android devices. To enable this feature, you must use the same Google API Console project for your Web and Android clients, and configure your web app's sign-in button.
For your app to be eligible for this feature, it must be published in the Google Play store, be free, and it must meet a quality threshold. This threshold is determined by Google and is subject to change. New apps might take some time to meet the quality threshold.
Configure your Google API Console project
Google uses the Google API Console to configure access for apps to communicate with the Google APIs. For direct app installs, you must use the same project for your Web and Android apps.
- Go to the Credentials page of the API Console.
- Create credentials for each app into which
you want to integrate direct app installs. If you have
multiple Android apps, the order that you define your client IDs determine
which app is installed.
- For the Android app that you want your users to be prompted to download, click Add credentials > OAuth 2.0 client ID, select Android, and complete the form.
- For your web app, click Add credentials > OAuth 2.0 client ID, select Web application, and complete the form.
- If you have additional clients, such as a paid version of your Android app or an iOS app, create OAuth 2.0 client IDs for those apps as well. This grouping enables deep linking to work across your mobile apps if you enable it for your client IDs.
Configure your web app
Your web app must use the Google Sign-In button to prompt your
web site users to download your app the first time that they sign in. This
feature is enabled by adding the
parameter to your sign-in
- Add a sign-in button to your app.
- Add the
data-app_package_nameparameter to your HTML button or the
app_package_nameparameter to the
render()methods. Specify your Android app's package name as the value. This value should be the same as the value that you entered in the Google API Console for the Android app that you want your users to download.
- If you previously authorized the app for your account, you need to disconnect the app before you can try out the direct app install.
- Refresh your web app to pick up the change to the
- Test your automatic app install by visiting your web app and clicking the sign-in button. First, you should see the authorization dialog. After accepting the authorization dialog, you will see the direct app install prompt.
Testing Android app installs for your web site
If your app meets the eligibility requirements, you can test the over-the-air install feature by signing in to your app for the first time with your account. If you want to test subsequent app installs, you will need to follow these steps:
- Revoke your accounts access tokens for the app. It is recommended that your app provide users with an option to revoke access from within your app. You can also manually disconnect and revoke tokens.
- Uninstall the app from all of the Android devices where you use the app and signed into it with this account.
- Wait for at least 30 minutes to test the sign-in flow from your web app to try to trigger the app install prompt.