Associer un compte avec OAuth (Dialogflow)

Le type d'association OAuth est compatible avec deux flux OAuth 2.0 standards dans l'industrie : le flux implicite et les flux de code d'autorisation.

在隐式代码流程中，Google 会在用户浏览器中打开您的授权端点。成功登录后，系统会向 Google 返回长期访问令牌。现在，从 Google 助理向你的 Action 发送的每个请求中都包含此访问令牌。

在授权代码流程中，您需要两个端点：

• 授权端点，该端点负责向尚未登录的用户显示登录界面，并以短期授权代码的形式记录所请求的访问。
• 令牌交换端点，负责两种类型的交换：
  1. 将授权代码交换为长期刷新令牌和短期访问令牌。用户完成帐号关联流程后，系统会进行这种交换。
  2. 将长期刷新令牌换成短期访问令牌。Google 需要新访问令牌时，由于此令牌已过期，因此会进行此交换。

虽然隐式代码流程的实现更简单，但 Google 建议通过隐式流程发出的访问令牌永远不会过期，因为将令牌过期与隐式流程一起使用会强制用户再次关联其帐号。如果出于安全考虑需要令牌到期，强烈建议您考虑使用身份验证代码流程。

注意 ：请选择您希望实现的 OAuth2 流程。如果需要，本指南的内容会根据您的选择重新加载。

身份验证代码 隐式流程

Implémenter l'association de comptes OAuth

Remarque :Si vous implémentez l'association de comptes pour gérer les informations financières, des règles supplémentaires peuvent s'appliquer à votre action. Il peut nous falloir jusqu'à six semaines pour examiner une action avec l'association de compte afin d'obtenir des informations financières. tenez compte de ce temps dans la planification de votre calendrier de publication. Pour faciliter l'examen assurez-vous de respecter les règles relatives aux services financiers avant de soumettre votre action pour examen.

Configurer le projet

Pour configurer votre projet afin d'utiliser l'association de compte OAuth, procédez comme suit:

1. Ouvrez la console Actions et sélectionnez le projet que vous souhaitez utiliser.
2. Cliquez sur l'onglet Développer, puis sélectionnez Association de comptes.
3. Activez le bouton bascule à côté de l'option Association de comptes.
4. Dans la section Création de compte, sélectionnez Non, je souhaite seulement autoriser la création de comptes sur mon site Web.

5. Dans Type d'association, sélectionnez OAuth et Implicit.

   

6. Dans Informations sur le client:

   • Attribuez une valeur à Numéro client attribué par le programme Actions à Google pour identifier émanent de Google.
   • Insérez les URL de vos points de terminaison Autorisation et Échange de jetons.

Remarque :Si vous souhaitez que votre ID client soit envoyé sous forme encodée en base64 chaîne, cliquez sur la flèche du menu déroulant à côté de Configure your client (optional) (Configurer votre client (facultatif)). et cochez la case Google pour transmettre l'ID client et le code secret via le protocole en-tête auth.

6. Cliquez sur Enregistrer.

Implémenter votre serveur 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 OAuth2 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.

Démarrer le flux d'authentification

Avertissement :N'envoyez pas d'invite obligatoire pour associer un compte aux utilisateurs au début de la conversation avec votre action. Proposez plutôt un parcours invité aux utilisateurs non authentifiés pour leur montrer comment fonctionne votre action, puis ne demandez l'association de comptes que si cela est nécessaire pour continuer. Si les utilisateurs quittent régulièrement l'action en raison de problèmes d'association de comptes, Google ne promouvoira pas activement l'action, ce qui risque de réduire le trafic utilisateur associé.

Utiliser l'intent d'assistance à la connexion au compte pour démarrer le flux d'authentification. Les extraits de code suivants décrivent comment envoyer une réponse dans Dialogflow et le SDK Actions pour utiliser cet outil d'aide.

Dialogflow:

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph>

Node.js

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'));
});

<ph type="x-smartling-placeholder">

</ph>

Java

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

<ph type="x-smartling-placeholder">

</ph>

JSON

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "PLACEHOLDER"
            }
          }
        ]
      },
      "userStorage": "{\"data\":{}}",
      "systemIntent": {
        "intent": "actions.intent.SIGN_IN",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
          "optContext": "To get your account details"
        }
      }
    }
  },
  "outputContexts": [
    {
      "name": "/contexts/_actions_on_google",
      "lifespanCount": 99,
      "parameters": {
        "data": "{}"
      }
    }
  ]
}

SDK Actions:

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph>

Node.js

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'));
});

<ph type="x-smartling-placeholder">

</ph>

Java

@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();
}

<ph type="x-smartling-placeholder">

</ph>

JSON

{
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "inputPrompt": {
        "richInitialPrompt": {
          "items": [
            {
              "simpleResponse": {
                "textToSpeech": "PLACEHOLDER"
              }
            }
          ]
        }
      },
      "possibleIntents": [
        {
          "intent": "actions.intent.SIGN_IN",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
            "optContext": "To get your account details"
          }
        }
      ]
    }
  ],
  "conversationToken": "{\"data\":{}}",
  "userStorage": "{\"data\":{}}"
}

Gérer les requêtes d'accès aux données

Si la requête Assistant contient un jeton d'accès, commencez par vérifier que le jeton d'accès est valide (et qu'il n'a pas expiré), puis récupérez le compte utilisateur associé dans votre base de données.