Collegamento dell'account con OAuth

Il tipo Collegamento OAuth supporta due flussi OAuth 2.0 standard di settore, i flussi implicito e codice di autorizzazione.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• The token exchange endpoint, which is responsible for two types of exchanges:
  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

Implementare il collegamento all'account OAuth

Nota :se implementi il collegamento degli account per gestire le informazioni finanziarie, tieni presente che potrebbero essere applicate norme aggiuntive alla tua Azione. Potremmo impiegare fino a sei settimane per esaminare un'azione con collegamento dell'account per le informazioni finanziarie, quindi tieni conto di questo tempo quando pianifichi il programma di rilascio. Per semplificare la procedura di revisione, assicurati di rispettare le norme relative ai servizi finanziari prima di inviare l'azione per la revisione.

Configurare il progetto

Per configurare il progetto in modo che utilizzi il collegamento OAuth:

1. Apri la console Actions e seleziona il progetto che vuoi utilizzare.
2. Fai clic sulla scheda Sviluppa e scegli Collegamento dell'account.
3. Attiva l'opzione accanto a Collegamento degli account.
4. Nella sezione Creazione account, seleziona No, voglio consentire la creazione di account solo sul mio sito web.

5. In Tipo di collegamento, seleziona OAuth e Implicito.

   

6. In Informazioni sul cliente:

   • Assegna un valore a ID client emesso da Actions on Google per identificare le richieste provenienti da Google.
   • Inserisci gli URL per gli endpoint di autorizzazione e scambio di token.

Nota: se vuoi che l'ID client venga inviato come stringa codificata in Base64, fai clic sulla freccia del menu a discesa accanto a Configura il client (facoltativo) e seleziona la casella Google trasmetta l'ID client e il secret tramite l'intestazione di autenticazione di base HTTP.

6. Fai clic su Salva.

Implementa il server OAuth

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth 2.0 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The client ID you assigned to Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type	The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

   • Confirm that the client_id matches the client ID you assigned to Google.
   • Confirm that the URL specified by the redirect_uri parameter has the following form:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

   • access_token: the access token you just generated
   • token_type: the string bearer
   • state: the unmodified state value from the original request The following is an example of the resulting URL:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Progettare l'interfaccia utente vocale per il flusso di autenticazione

Avviso:non mostrare agli utenti un prompt di collegamento dell'account obbligatorio all'inizio della conversazione con la tua Azione. Invece, offri agli utenti non autenticati un flusso ospite per mostrare come funziona la tua azione e chiedi il collegamento dell'account solo se è necessario per procedere. Se gli utenti abbandonano l'azione in modo coerente a causa di problemi di collegamento dell'account, Google non promuoverà attivamente l'azione, il che potrebbe ridurre il traffico di utenti dell'azione.

Nota: devi utilizzare Actions Builder per creare un'azione che implementi il collegamento dell'account.

Verifica se l'utente è verificato e avvia il flusso di collegamento degli account

1. Apri il progetto Actions Builder nella console Actions.
2. Crea una nuova scena per avviare il collegamento dell'account nella tua azione:
   1. Fai clic su Scene.
   2. Fai clic sull'icona Aggiungi (+) per aggiungere una nuova scena.
3. Nella scena appena creata, fai clic sull'icona Aggiungi per Condizioni.
4. Aggiungi una condizione che verifichi se l'utente associato alla conversazione è un utente verificato. Se il controllo non va a buon fine, l'Azione non può eseguire il collegamento dell'account durante la conversazione e deve ripiegare sull'accesso a funzionalità che non richiedono il collegamento dell'account.
   1. Nel campo Enter new expression in Condizione, inserisci la seguente logica: user.verificationStatus != "VERIFIED"
   2. In Transizione, seleziona una scena che non richiede il collegamento dell'account o una scena che è il punto di accesso alla funzionalità solo per gli ospiti.

1. Fai clic sull'icona di aggiunta per Condizioni.
2. Aggiungi una condizione per attivare un flusso di collegamento dell'account se l'utente non ha un'identità associata.
   1. Nel campo Enter new expression in Condizione, inserisci la seguente logica: user.verificationStatus == "VERIFIED"
   2. Nella sezione Transizione, seleziona la scena di sistema Collegamento dell'account.
   3. Fai clic su Salva.

Dopo il salvataggio, al progetto viene aggiunta una nuova scena del sistema di collegamento degli account chiamata <SceneName>_AccountLinking.

Personalizzare la scena di collegamento degli account

1. Nella sezione Scene, seleziona la scena del sistema di collegamento degli account.
2. Fai clic su Invia prompt e aggiungi una breve frase per descrivere all'utente perché l'azione deve accedere alla sua identità (ad esempio "Per salvare le tue preferenze").
3. Fai clic su Salva.

1. In Condizioni, fai clic su Se l'utente completa correttamente il collegamento degli account.
2. Configura la modalità di avanzamento del flusso se l'utente accetta di collegare il proprio account. Ad esempio, chiama il webhook per elaborare qualsiasi logica di business personalizzata richiesta e torna alla scena di origine.
3. Fai clic su Salva.

1. Nella sezione Condizioni, fai clic su Se l'utente annulla o ignora il collegamento all'account.
2. Configura la modalità di procedere del flusso se l'utente non accetta di collegare il proprio account. Ad esempio, invia un messaggio di conferma e reindirizza alle scene che forniscono funzionalità che non richiedono il collegamento dell'account.
3. Fai clic su Salva.

1. Nella sezione Condizioni, fai clic su Se si verifica un errore di sistema o di rete.
2. Configura la modalità di procedere del flusso se il flusso di collegamento dell'account non può essere completato a causa di errori di sistema o di rete. Ad esempio, invia un messaggio di conferma e reindirizza alle scene che forniscono funzionalità che non richiedono il collegamento dell'account.
3. Fai clic su Salva.

Gestire le richieste di accesso ai dati

Se la richiesta dell'assistente contiene un token di accesso, verifica innanzitutto che il token di accesso sia valido (e non scaduto), quindi recupera l'account utente associato dal tuo database.