Kontoverknüpfung mit OAuth (Dialogflow)

Der Verknüpfungstyp OAuth unterstützt zwei branchenübliche OAuth 2.0-Abläufe: der implizite und Autorisierungscode-Abläufe.

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 OAuth2 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

OAuth-Kontoverknüpfung implementieren

Hinweis :Wenn du eine Kontoverknüpfung zur Verarbeitung von Finanzdaten einrichtest, Beachte, dass für deine Aktion möglicherweise zusätzliche Richtlinien gelten. Bis zu sechs Wochen, um eine Aktion mit Kontoverknüpfung auf Finanzdaten zu überprüfen. diese Zeit bei der Planung des Veröffentlichungszeitplans mit ein. Um die Überprüfung zu erleichtern müssen Sie die Richtlinien für Finanzdienstleistungen einhalten. bevor du deine Aktion zur Überprüfung einreichst.

Projekt konfigurieren

So konfigurieren Sie Ihr Projekt für die Verwendung der OAuth-Kontoverknüpfung:

1. Öffnen Sie die Actions Console und wählen Sie das Projekt aus, das Sie verwenden möchten.
2. Klicken Sie auf den Tab Entwickeln und wählen Sie Kontoverknüpfung aus.
3. Aktivieren Sie den Schalter neben Kontoverknüpfung.
4. Wählen Sie im Abschnitt Kontoerstellung die Option Nein, ich möchte nur die Kontoerstellung auf meiner Website zulassen aus.

5. Wählen Sie unter Verknüpfungstyp die Option OAuth und Implizit aus.

   

6. Gehen Sie unter Client Information (Kundeninformationen) folgendermaßen vor:

   • Weisen Sie der Client-ID, die von Ihren Aktionen an Google ausgegeben wird einen Wert zu, um von Google stammen.
   • Fügen Sie die URLs für Ihre Autorisierungs- und Tokenaustausch-Endpunkte ein.

Hinweis: Wenn Sie Ihre Client-ID als Base64-codierte String auf den Drop-down-Pfeil neben Client konfigurieren (optional) und aktiviere das Kästchen Google zur Übertragung der Client-ID und des Client-Secrets über HTTP Basic auth-Header.

6. Klicken Sie auf Speichern.

OAuth-Server implementieren

Ihr Dienst führt eine Autorisierung durch, um den impliziten OAuth 2.0-Vorgang zu unterstützen. Endpunkt verfügbar über HTTPS. Dieser Endpunkt ist für die Authentifizierung und Einholen der Einwilligung der Nutzer für den Datenzugriff Den Autorisierungsendpunkt Nutzern, die noch nicht angemeldet sind, wird eine Anmeldeoberfläche angezeigt und die Daten werden aufgezeichnet. Zustimmung zum angeforderten Zugriff geben.

Wenn deine Aktion eine der autorisierten APIs deines Dienstes aufrufen muss, verwendet Google an diesen Endpunkt, um die Berechtigung von Ihren Nutzern zu erhalten, diese APIs auf ihrem

Eine typische von Google initiierte Sitzung im impliziten OAuth 2.0-Vorgang hat den folgenden Ablauf:

1. Google öffnet Ihren Autorisierungsendpunkt im Browser des Nutzers. Die Der Nutzer meldet sich an, wenn er noch nicht angemeldet ist, und gewährt Google Zugriff auf die Datei ihre Daten mit Ihrer API verwenden, sofern sie nicht bereits die Berechtigung erteilt haben.
2. Ihr Dienst erstellt ein Zugriffstoken und gibt es an Google, indem der Browser des Nutzers mit dem Zugriffstoken zurück zu Google weitergeleitet wird an die Anfrage angehängt.
3. Google ruft die APIs Ihres Dienstes auf und hängt das Zugriffstoken mit für jede Anfrage. Ihr Dienst überprüft, ob das Zugriffstoken Google autorisiert, auf die API zuzugreifen und dann den API-Aufruf abzuschließen.

Autorisierungsanfragen verarbeiten

Wenn deine Aktion die Kontoverknüpfung über einen impliziten OAuth2-Vorgang durchführen muss, Google sendet den Nutzer mit einer Anfrage, die Folgendes enthält, an Ihren Autorisierungsendpunkt folgende Parameter:

Parameter des Autorisierungsendpunkts
client_id	Die Client-ID, die Sie Google zugewiesen haben.
redirect_uri	Die URL, an die Sie die Antwort auf diese Anfrage senden.
state	Buchhaltungswert, der unverändert an Google zurückgegeben wird Weiterleitungs-URI.
response_type	Der Werttyp, der in der Antwort zurückgegeben werden soll. Für den impliziten OAuth 2.0-Code ist der Antworttyp immer token.

Wenn Ihr Autorisierungsendpunkt beispielsweise unter https://myservice.example.com/auth verfügbar ist, könnte eine Anfrage so aussehen:

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

Führe die folgenden Schritte aus, damit der Autorisierungsendpunkt Anmeldeanfragen verarbeiten kann:

1. Prüfen Sie die Werte client_id und redirect_uri, um So verhindern Sie, dass unbeabsichtigte oder falsch konfigurierte Client-Apps Zugriff gewährt werden:

   • Prüfen Sie, ob die client_id mit Ihrer Client-ID übereinstimmt die Google zugewiesen sind.
   • Prüfen Sie, ob die in redirect_uri angegebene URL hat das folgende Format:

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

     YOUR_PROJECT_ID ist die ID auf der Seite Projekteinstellungen. der Actions Console.

2. Prüfen Sie, ob der Nutzer in Ihrem Dienst angemeldet ist. Wenn der Nutzer nicht angemeldet ist angemeldet haben, müssen Sie den Anmelde- bzw. Anmeldevorgang für den Dienst abschließen.

3. Generieren Sie ein Zugriffstoken, das Google für den Zugriff auf Ihre API verwendet. Die Zugriffstoken kann ein beliebiger Stringwert sein, muss aber den Wert Nutzer und den Client, für den das Token bestimmt ist, und darf nicht erraten werden.

4. Eine HTTP-Antwort senden, die den Browser des Nutzers an die URL weiterleitet redirect_uri wird angegeben. Schließen Sie alle folgende Parameter im URL-Fragment:

   • access_token: das Zugriffstoken, das Sie gerade generiert haben
   • token_type: der String bearer
   • state: der unveränderte Statuswert aus dem Original Anfrage Hier ein Beispiel für die resultierende URL:

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

Der OAuth 2.0-Weiterleitungs-Handler von Google empfängt das Zugriffstoken und bestätigt, dass sich der Wert für state nicht geändert hat. Nachdem Google eine Zugriffstoken für Ihren Dienst erhalten, hängt Google das Token an nachfolgende Aufrufe an. als Teil des AppRequest an Ihre Aktion.

Authentifizierungsvorgang starten

Achtung :Gib Nutzern zu Beginn der Unterhaltung mit deiner Aktion nicht die erforderliche Aufforderung zur Kontoverknüpfung. Biete nicht authentifizierten Nutzern stattdessen einen Gastablauf, um die Funktionsweise deiner Aktion zu demonstrieren. Fordere dann nur dann die Kontoverknüpfung an, wenn dies erforderlich ist. Wenn Nutzer die Aktion aufgrund von Problemen mit der Kontoverknüpfung immer wieder verlassen, wird die Aktion nicht aktiv von Google beworben. Dadurch kann sich die Anzahl der Nutzerzugriffe der Aktion verringern.

Den Intent „Account Sign-in Helper“ (Kontoanmeldung) verwenden um den Authentifizierungsvorgang zu starten. Die folgenden Code-Snippets beschreiben, wie Sie Antwort in Dialogflow und im Actions SDK senden, um diesen Hilfsprogramm-Assistenten zu verwenden.

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": "{}"
      }
    }
  ]
}

Actions-SDK:

<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\":{}}"
}

Datenzugriffsanfragen verarbeiten

Wenn die Assistant-Anfrage ein Zugriffstoken enthält, gehen Sie so vor: Überprüfen Sie zunächst, ob das Zugriffstoken gültig (und nicht abgelaufen) ist, und rufen Sie dann das zugehörige Nutzerkonto aus Ihrer Datenbank ab.