Google Sign-In for the Assistant provides the simplest and easiest user experience to users and developers both for account linking and account creation. Your Action can request access to your user's Google profile during a conversation, including the user's name, email address, and profile picture.
The profile information can be used to create a personalized user experience in your Action. If you have apps on other platforms and they use Google Sign-In, you can also find and link to an existing user's account, create a new account, and establish a direct channel of communication to the user.
To perform account linking with Google Sign-In, you ask the user to give consent to access their Google profile. You then use the information in their profile, for example their email address, to identify the user in your system.
Implement Google Sign-In account linking
Follow the steps in the following sections to add Google Sign-In account linking to your Action.
Configure the project
To configure your project to use Google Sign-In account linking, follow these steps:
- Open the Actions Console and select a project.
- Click the Developtab and choose Account linking.
- Enable the switch next to Account linking.
- In the Account creationsection, select Yes .
-
In Linking type, select Google Sign In .
-
Open Client Informationand take note of the value of Client ID issued by Google to your Actions.
-
Click Save.
Start the authentication flow
Use the Account Sign-in helper intent to start the authentication flow.
After the user authorizes your action to access their Google profile, you will receive a Google ID token that contains the user's Google profile information in every subsequent request to your action.
To access the user's profile information, you need to first validate and decode the token by doing the following:
- Use a JWT-decoding library for your language to decode the token, and use Google's public keys (available in JWK or PEM format) to verify the token's signature.
- Verify that the token's issuer (
issfield in the decoded token) is https://accounts.google.com and that the audience (audfield in the decoded token) is the value of Client ID issued by Google to your Actions, which is assigned to your project in the Actions on Google console.
The following is an example of a decoded token:
{ "sub" : 1234567890 , // The unique ID of the user's Google Account "iss" : "https://accounts.google.com" , // The token's issuer "aud" : "123-abc.apps.googleusercontent.com" , // Client ID assigned to your Actions project "iat" : 233366400 , // Unix timestamp of the token's creation time "exp" : 233370000 , // Unix timestamp of the token's expiration time "name" : "Jan Jansen" , "given_name" : "Jan" , "family_name" : "Jansen" , "email" : "jan@gmail.com" , // If present, the user's email address "locale" : "en_US" }
If you use the Actions on Google client library for Node.js or the Java client library , it takes care of validating and decoding the token for you, and gives you access to the profile content, as shown in the following code snippets. Note that the JSON below describes a webhook request for Dialogflow and Actions SDK respectively.
The following snippets use Dialogflow for sign-in:
const { dialogflow , SignIn } = require ( 'actions-on-google' ); const app = dialogflow ({ // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT clientId : CLIENT_ID , }); // Intent that starts the account linking flow . app . intent ( 'Start Signin' , ( conv ) = > { conv . ask ( new SignIn ( 'To get your account details' )); }); // Create a Dialogflow intent with the ` actions_intent_SIGN_IN ` event . app . intent ( 'Get Signin' , ( conv , params , signin ) = > { if ( signin . status === 'OK' ) { const payload = conv . user . profile . payload ; conv . ask ( ` I got your account details , $ { payload . name } . What do you want to do next ?` ); } else { conv . ask ( ` I won 't be able to save your data, but what do you want to do next?`); } });
private String clientId = "<your_client_id>" ; @ ForIntent ( "Start Signin" ) public ActionResponse text ( ActionRequest request ) { ResponseBuilder rb = getResponseBuilder ( request ); return rb . add ( new SignIn () . setContext ( "To get your account details" )) . build (); } @ ForIntent ( "actions.intent.SIGN_IN" ) public ActionResponse getSignInStatus ( ActionRequest request ) { ResponseBuilder responseBuilder = getResponseBuilder ( request ); if ( request . isSignInGranted ()) { GoogleIdToken . Payload profile = getUserProfile ( request . getUser () . getIdToken ()); responseBuilder . add ( "I got your account details, " + profile . get ( "given_name" ) + ". What do you want to do next?" ); } else { responseBuilder . add ( "I won't be able to save your data, but what do you want to do next?" ); } return responseBuilder . build (); } private GoogleIdToken . Payload getUserProfile ( String idToken ) { GoogleIdToken . Payload profile = null ; try { profile = decodeIdToken ( idToken ); } catch ( Exception e ) { LOGGER . error ( "error decoding idtoken" ); LOGGER . error ( e . toString ()); } return profile ; } private GoogleIdToken . Payload decodeIdToken ( String idTokenString ) throws GeneralSecurityException , IOException { HttpTransport transport = GoogleNetHttpTransport . newTrustedTransport (); JacksonFactory jsonFactory = JacksonFactory . getDefaultInstance (); GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier . Builder ( transport , jsonFactory ) // Specify the CLIENT_ID of the app that accesses the backend : . setAudience ( Collections . singletonList ( clientId )) . build (); GoogleIdToken idToken = verifier . verify ( idTokenString ); return idToken . getPayload (); }
{ "responseId" : "" , "queryResult" : { "queryText" : "" , "action" : "" , "parameters" : {}, "allRequiredParamsPresent" : true , "fulfillmentText" : "" , "fulfillmentMessages" : [], "outputContexts" : [], "intent" : { "name" : "Get Signin" , "displayName" : "Get Signin" }, "intentDetectionConfidence" : 1 , "diagnosticInfo" : {}, "languageCode" : "" }, "originalDetectIntentRequest" : { "source" : "google" , "version" : "2" , "payload" : { "isInSandbox" : true , "surface" : { "capabilities" : [ { "name" : "actions.capability.SCREEN_OUTPUT" }, { "name" : "actions.capability.AUDIO_OUTPUT" }, { "name" : "actions.capability.MEDIA_RESPONSE_AUDIO" }, { "name" : "actions.capability.WEB_BROWSER" } ] }, "inputs" : [ { "rawInputs" : [], "intent" : "" , "arguments" : [ { "name" : "SIGN_IN" , "extension" : { "@type" : "type.googleapis.com/google.actions.v2.SignInValue" , "status" : "OK" } } ] } ], "user" : { "idToken" : "peJaCGci..." }, "conversation" : {}, "availableSurfaces" : [ { "capabilities" : [ { "name" : "actions.capability.SCREEN_OUTPUT" }, { "name" : "actions.capability.AUDIO_OUTPUT" }, { "name" : "actions.capability.MEDIA_RESPONSE_AUDIO" }, { "name" : "actions.capability.WEB_BROWSER" } ] } ] } }, "session" : "" }
The following snippets use Actions SDK for sign-in:
const { actionssdk , SignIn } = require ( 'actions-on-google' ); const app = actionssdk ({ // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT clientId : CLIENT_ID , }); // Intent that starts the account linking flow . app . intent ( 'actions.intent.TEXT' , ( conv ) = > { conv . ask ( new SignIn ( 'To get your account details' )); }); // Create an Actions SDK intent with the ` actions_intent_SIGN_IN ` event . app . intent ( 'actions.intent.SIGN_IN' , ( conv , params , signin ) = > { if ( signin . status === 'OK' ) { const payload = conv . user . profile . payload ; conv . ask ( ` I got your account details , $ { payload . name } . What do you want to do next ?` ); } else { conv . ask ( ` I won 't be able to save your data, but what do you want to do next?`); } });
private String clientId = "<your_client_id>" ; @ ForIntent ( "actions.intent.TEXT" ) public ActionResponse text ( ActionRequest request ) { ResponseBuilder rb = getResponseBuilder ( request ); return rb . add ( new SignIn () . setContext ( "To get your account details" )) . build (); } @ ForIntent ( "actions.intent.SIGN_IN" ) public ActionResponse getSignInStatus ( ActionRequest request ) { ResponseBuilder responseBuilder = getResponseBuilder ( request ); if ( request . isSignInGranted ()) { GoogleIdToken . Payload profile = getUserProfile ( request . getUser () . getIdToken ()); responseBuilder . add ( "I got your account details, " + profile . get ( "given_name" ) + ". What do you want to do next?" ); } else { responseBuilder . add ( "I won't be able to save your data, but what do you want to do next?" ); } return responseBuilder . build (); } private GoogleIdToken . Payload getUserProfile ( String idToken ) { GoogleIdToken . Payload profile = null ; try { profile = decodeIdToken ( idToken ); } catch ( Exception e ) { LOGGER . error ( "error decoding idtoken" ); LOGGER . error ( e . toString ()); } return profile ; } private GoogleIdToken . Payload decodeIdToken ( String idTokenString ) throws GeneralSecurityException , IOException { HttpTransport transport = GoogleNetHttpTransport . newTrustedTransport (); JacksonFactory jsonFactory = JacksonFactory . getDefaultInstance (); GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier . Builder ( transport , jsonFactory ) // Specify the CLIENT_ID of the app that accesses the backend : . setAudience ( Collections . singletonList ( this . clientId )) . build (); GoogleIdToken idToken = verifier . verify ( idTokenString ); return idToken . getPayload (); }
{ "user" : { "idToken" : "peJaCGci..." }, "device" : {}, "surface" : { "capabilities" : [ { "name" : "actions.capability.SCREEN_OUTPUT" }, { "name" : "actions.capability.AUDIO_OUTPUT" }, { "name" : "actions.capability.MEDIA_RESPONSE_AUDIO" }, { "name" : "actions.capability.WEB_BROWSER" } ] }, "conversation" : {}, "inputs" : [ { "rawInputs" : [], "intent" : "actions.intent.SIGN_IN" , "arguments" : [ { "name" : "SIGN_IN" , "extension" : { "@type" : "type.googleapis.com/google.actions.v2.SignInValue" , "status" : "OK" } } ] } ], "availableSurfaces" : [ { "capabilities" : [ { "name" : "actions.capability.SCREEN_OUTPUT" }, { "name" : "actions.capability.AUDIO_OUTPUT" }, { "name" : "actions.capability.MEDIA_RESPONSE_AUDIO" }, { "name" : "actions.capability.WEB_BROWSER" } ] } ] }
Handle data access requests
To handle data access request, just verify that the user asserted by the Google ID token is already present in your database. The following snippet of code shows an example of how to check if a user account already exists in a Firestore database.
const admin = require ( 'firebase-admin' ); const functions = require ( 'firebase-functions' ); admin . initializeApp (); const auth = admin . auth (); const db = admin . firestore (); // Save the user in the Firestore DB after successful signin app . intent ( 'Get Sign In' , async ( conv , params , signin ) => { if ( signin . status !== 'OK' ) { return conv . close ( ` Let 's try again next time.`); } const color = conv . data [ Fields . COLOR ]; const { email } = conv . user ; if ( ! conv . data . uid && email ) { try { conv . data . uid = ( await auth . getUserByEmail ( email )) . uid ; } catch ( e ) { if ( e . code !== 'auth/user-not-found' ) { throw e ; } // If the user is not found , create a new Firebase auth user // using the email obtained from the Google Assistant conv . data . uid = ( await auth . createUser ({ email })) . uid ; } } if ( conv . data . uid ) { conv . user . ref = db . collection ( 'users' ) . doc ( conv . data . uid ); } conv . close ( ` I saved $ { color } as your favorite color for next time . ` ); }); // Retrieve the user 's favorite color if an account exists, ask if it doesn' t . app . intent ( 'Default Welcome Intent' , async ( conv ) => { const { payload } = conv . user . profile ; const name = payload ? ` $ { payload . given_name } ` : '' ; conv . ask ( ` Hi $ { name } ! ` ); // conv . user . ref contains the id of the record for the user in a Firestore DB if ( conv . user . ref ) { const doc = await conv . user . ref . get (); if ( doc . exists ) { const color = doc . data ()[ Fields . COLOR ]; return conv . ask ( ` Your favorite color was $ { color } . ` + 'Tell me a color to update it.' ); } } conv . ask ( ` What 's your favorite color?`); });
private class FirestoreManager { private final Firestore db ; private final DocumentReference userDocRef ; private final String uid ; public FirestoreManager ( String databaseUrl , String email ) throws IOException , FirebaseAuthException { if ( FirebaseApp . getApps () . isEmpty ()) { // Use the application default credentials ( works on GCP based hosting ) . FirebaseOptions options = new FirebaseOptions . Builder () . setCredentials ( GoogleCredentials . getApplicationDefault ()) . setDatabaseUrl ( databaseUrl ) . build (); FirebaseApp . initializeApp ( options ); } this . db = FirestoreClient . getFirestore (); UserRecord userRecord ; try { userRecord = FirebaseAuth . getInstance () . getUserByEmail ( email ); } catch ( FirebaseAuthException e ) { if ( e . getErrorCode () == FIREBASE_USER_NOT_FOUND_ERROR ) { UserRecord . CreateRequest createRequest = new UserRecord . CreateRequest () . setEmail ( email ); userRecord = FirebaseAuth . getInstance () . createUser ( createRequest ); } else { throw e ; } } uid = userRecord . getUid (); userDocRef = db . collection ( FIRESTORE_USERS_PATH ) . document ( uid ); } public String readUserColor () throws ExecutionException , InterruptedException { ApiFuture<DocumentSnapshot> future = userDocRef . get (); // future . get () blocks on response DocumentSnapshot document = future . get (); if ( document . exists ()) { return document . get ( COLOR_KEY ) . toString (); } else { return "" ; } } public Timestamp writeUserColor ( String color ) throws ExecutionException , InterruptedException { Map<String , Object > docData = new HashMap <> (); docData . put ( COLOR_KEY , color ); ApiFuture<WriteResult> future = userDocRef . set ( docData ); // future . get () blocks on response return future . get () . getUpdateTime (); } } @ ForIntent ( "Get Sign In" ) public ActionResponse getSignIn ( ActionRequest request ) { LOGGER . info ( "Get sign in intent start." ); ResponseBuilder responseBuilder = getResponseBuilder ( request ); if ( request . isSignInGranted ()) { String color = request . getConversationData () . get ( COLOR_KEY ) . toString (); GoogleIdToken . Payload profile = getUserProfile ( request . getUser () . getIdToken ()); try { FirestoreManager firestoreManager = new FirestoreManager ( DATABASE_URL , profile . getEmail ()); saveColor ( firestoreManager , color ); } catch ( Exception e ) { LOGGER . error ( e . toString ()); } responseBuilder . add ( "I saved " + color + " as your favorite color for next time." ) . endConversation (); } else { responseBuilder . add ( "Let's try again next time" ); } LOGGER . info ( "Get sign in intent end." ); return responseBuilder . build (); } private void saveColor ( FirestoreManager firestoreManager , String color ) { try { Timestamp updateTime = firestoreManager . writeUserColor ( color ); LOGGER . info ( String . format ( "Update time: %s " , updateTime . toString ())); } catch ( Exception e ) { LOGGER . error ( e . toString ()); } }
