Google Account

Before You Start

• Enable Auth Service in AppGallery Connect.
• Integrate the Auth Service SDK into your app.

Development Process

Auth Service allows you to integrate Google account sign-in in either of the following methods:

• Unified sign-in (recommended)
• Traditional sign-in, which is retained for compatibility

Unified Sign-in

1. Add the SDK dependency.
   • Android Studio
     • Managing dependencies using Version Catalog
       1. Open the libs.versions.toml file in the project-level gradle directory of Android Studio and declare the version number of the Google SDK in [versions].
          Collapse

          Word wrap

          Dark theme

          Copy code

          [versions]
          googleVersion = "16.0.1"  # 16.0.1 is used as an example.

       2. Declare the Huawei Auth Service SDK and Google SDK in [libraries] of the libs.versions.toml file.
          Collapse

          Word wrap

          Dark theme

          Copy code

          [libraries]
          agconnect-auth-google = { module = "com.huawei.agconnect:agconnect-auth-google", version.ref = "agcVersion" }  # For details about agcVersion declaration, please refer to Declaring the AppGallery Connect Plugin and SDKs.
          google-sdk = { module = "com.google.android.gms:play-services-auth", version.ref = "googleVersion" }

       3. Add dependencies for the Huawei Auth Service SDK and Google SDK to the dependencies block in the app-level build.gradle file.
          Collapse

          Word wrap

          Dark theme

          Copy code

          dependencies {      
               implementation libs.agconnect.auth.google
               implementation libs.google.sdk
          }

     • Managing dependencies not using Version Catalog

       Open the app-level build.gradle file (usually in the app directory) and add dependencies for the Huawei Auth Service SDK and Google SDK to the dependencies block.

       Collapse

       Word wrap

       Dark theme

       Copy code

       dependencies {
           implementation "com.huawei.agconnect:agconnect-auth-google:1.9.4.300"     
           implementation "com.google.android.gms:play-services-auth:{version}"
       }

   • Eclipse
     Open the build.gradle file in the aar2eclipse/aar directory and add dependencies for the Huawei Auth Service SDK and Google SDK to the dependencies block. The procedure is similar to that for integrating the AppGallery Connect SDK in Eclipse.

     Collapse

     Word wrap

     Dark theme

     Copy code

     dependencies {
         embed "com.huawei.agconnect:agconnect-auth-google:1.9.4.300"
         embed "com.google.android.gms:play-services-auth:{version}"
     }

   NOTE

   • Replace googleVersion and {version} in the sample code with the latest version number of the Google SDK. Huawei is not responsible for the update.
   • Since Huawei does not provide the required Google SDK, you can manually integrate it by downloading the latest version from the Google open platform (Google for Developers).
2. Set parameters required for users to sign in with a Google account.
   Set google_app_id and google_client_id in the /app/res/values/strings.xml file.

   NOTE

   Set google_client_id to the client ID that you have configured when enabling the Google authentication mode. The number (typically 12 or more digits) at the beginning of the client ID is the value of google_app_id.

   Collapse

   Word wrap

   Dark theme

   Copy code

   <string name="google_app_id">
   5758********</string>
   <string name="google_client_id">
   5758********.apps.googleusercontent.com</string>

3. Add the lifecycle callback.
4. Call AGConnectAuth.signIn for a user to sign in with a Google account.
   Java

   Kotlin

   Collapse

   Word wrap

   Dark theme

   Copy code

   AGConnectAuth.getInstance().signIn(this,AGConnectAuthCredential.Google_Provider).addOnSuccessListener(new OnSuccessListener<SignInResult>() {
           @Override
           public void onSuccess(SignInResult signInResult) {
                   // onSuccess
                   AGConnectUser user =  signInResult.getUser();
           }
   })
   .addOnFailureListener(new OnFailureListener() {
           @Override
           public void onFailure(Exception e) {
                   // onFail
           }
   });

   Collapse

   Word wrap

   Dark theme

   Copy code

   AGConnectAuth.getInstance().signIn(this, AGConnectAuthCredential.Google_Provider).addOnSuccessListener {
       // Update the UI.
   }.addOnFailureListener {
       // onFailure
   }

Traditional Sign-in

1. Initialize the AGConnectAuth instance on the app sign-in page, obtain user information from AppGallery Connect, and check whether a user has signed in. If so, display the app's home page to the user. If not, display the sign-in page.
   Java

   Kotlin

   Collapse

   Word wrap

   Dark theme

   Copy code

   AGConnectUser user = AGConnectAuth.getInstance().getCurrentUser();

   Collapse

   Word wrap

   Dark theme

   Copy code

   val user = AGConnectAuth.getInstance().currentUser

2. After a user requests to sign in using a Google account, obtain the user's authorization.
   NOTE

   This step is for reference only. For details, please refer to Google documentation.

   1. Obtain authorization for Google account sign-in.
      Java

      Collapse

      Word wrap

      Dark theme

      Copy code

      GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
               .requestIdToken(CLIENT_ID)
               .requestProfile()
               .build();
      client = GoogleSignIn.getClient(this, gso);
      
      Intent signInIntent = client.getSignInIntent();
      startActivityForResult(signInIntent, RC_SIGN_IN);

   2. Add a callback to obtain the ID token upon successful authorization.
      Java

      Collapse

      Word wrap

      Dark theme

      Copy code

      @Override
      protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          super.onActivityResult(requestCode, resultCode, data);
      
       if (requestCode == RC_SIGN_IN) {
           Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data);
           task.addOnSuccessListener(new OnSuccessListener<GoogleSignInAccount>(){
               @Override
               public void onSuccess(GoogleSignInAccount googleSignInAccount) {
                   String idToken = googleSignInAccount.getIdToken();
               }
           }).addOnFailureListener(new OnFailureListener(){
               @Override
               public void onFailure(@NonNull Exception e) {
               }
           });
       }
      }

3. Call GoogleAuthProvider.credentialWithToken to generate a credential using the obtained ID token, and then call AGConnectAuth.signIn to implement sign-in.
   Java

   Kotlin

   Collapse

   Word wrap

   Dark theme

   Copy code

   AGConnectAuthCredential credential = GoogleAuthProvider.credentialWithToken(idToken);
   AGConnectAuth.getInstance().signIn(credential)
   .addOnSuccessListener(new OnSuccessListener<SignInResult>() {
       @Override
       public void onSuccess(SignInResult signInResult) {
           // onSuccess
           AGConnectUser user = signInResult.getUser();
       }
   })
   .addOnFailureListener(new OnFailureListener() {
       @Override
       public void onFailure(Exception e) {
           // onFail
       }
   });

   Collapse

   Word wrap

   Dark theme

   Copy code

   val credential = GoogleAuthProvider.credentialWithToken(idToken)
   AGConnectAuth.getInstance().signIn(credential).addOnSuccessListener {
       // onSuccess
       val user = it.user
   }.addOnFailureListener {
       // onFail
   }

More You May Need to Know

• If you want to allow a user to use multiple accounts to sign in to your app, you can link these accounts.
• If a user wants to exit the current account or switch to another account, you need to sign this user out.
• You can deregister an account as required.
• Users can perform sensitive operations, such as deregistration, password change, account linking, and mobile number and email address resetting, only within 5 minutes after sign-in. If more than 5 minutes have passed since the user signed in and they try to perform such operations, you need to reauthenticate the account first.
• You can implement your own exception handling logic to provide a better experience for users.
• You can use Cloud Functions triggers to receive key events, such as user registration, sign-in, and deregistration, to extend the capabilities of Auth Service.
• You can unlock or disable a user by referring to Managing Users.