Łączenie kont z łączeniem Logowania przez Google opartym na protokole OAuth

Typ połączenia „Uproszczone” logowanie przez Google oparte na OAuth dodaje logowanie przez Google do połączenia konta opartego na OAuth. Umożliwia to bezproblemowe łączenie kont za pomocą głosu dla użytkowników Google, a także łączenie kont użytkowników, którzy zarejestrowali się w Twojej usłudze za pomocą tożsamości innej niż Google.

Ten typ połączenia zaczyna się od logowania przez Google, które umożliwia sprawdzenie, czy informacje z profilu Google użytkownika znajdują się w Twoim systemie. Jeśli informacji o użytkowniku nie ma w Twoim systemie, rozpoczyna się standardowy proces OAuth. Użytkownik może też utworzyć nowe konto, korzystając z informacji z profilu Google.

Ilustracja 1. Po uzyskaniu przez Twoją czynność dostępu do profilu Google użytkownika możesz go użyć do znalezienia odpowiednika użytkownika w swoim systemie uwierzytelniania.

Aby połączyć konta za pomocą uproszczonego połączenia, wykonaj te ogólne czynności:

1. Najpierw poproś użytkownika o zgodę na dostęp do jego profilu Google.
2. Użyj informacji z profilu, aby zidentyfikować użytkownika.
3. Jeśli w systemie uwierzytelniania nie znajdziesz odpowiednika użytkownika Google, proces będzie przebiegać w zależności od tego, czy projekt działania został skonfigurowany w konsoli Actions tak, aby zezwalać na tworzenie kont użytkowników za pomocą głosu, czy tylko na stronie internetowej.
   • Jeśli zezwalasz na tworzenie konta za pomocą głosu, zweryfikuj token identyfikatora otrzymany od Google. Następnie możesz utworzyć użytkownika na podstawie informacji o profilu zawartych w tokenie identyfikatora.
   • Jeśli nie zezwalasz na tworzenie konta za pomocą głosu, użytkownik zostanie przekierowany do przeglądarki, w której może otworzyć stronę autoryzacji i dokończyć proces tworzenia konta.

Rysunek 2. Wizualizacja procesu OAuth i logowania przez Google, gdy informacji o użytkowniku nie ma w Twoim systemie.

Obsługa tworzenia konta za pomocą głosu

Jeśli zezwalasz na tworzenie kont użytkowników za pomocą głosu, Asystent pyta użytkownika, czy chce:

• utworzyć nowe konto w swoim systemie, używając informacji z konta Google użytkownika,
• Zaloguj się w systemie uwierzytelniania za pomocą innego konta, jeśli użytkownik ma już konto inne niż Google.

Jeśli chcesz zminimalizować trudności związane z procesem tworzenia konta, zalecamy włączenie tworzenia konta za pomocą głosu. Użytkownik musi opuścić przepływ głosowy tylko wtedy, gdy chce zalogować się za pomocą istniejącego konta innego niż Google.

Blokowanie tworzenia konta za pomocą głosu

Jeśli nie zezwolisz na tworzenie kont użytkowników za pomocą głosu, Asystent otworzy adres URL witryny, którą podasz na potrzeby uwierzytelniania użytkowników. Jeśli interakcja odbywa się na urządzeniu bez ekranu, Asystent kieruje użytkownika na telefon, aby kontynuować proces łączenia kont.

Zalecamy zablokowanie tworzenia, jeśli:

• Nie chcesz zezwalać użytkownikom z kontami innymi niż Google na tworzenie nowych kont użytkowników, ale chcesz, aby zamiast tego łączyli się z istniejącymi kontami użytkowników w Twoim systemie uwierzytelniania. Jeśli na przykład oferujesz program lojalnościowy, możesz chcieć mieć pewność, że użytkownik nie straci punktów zgromadzonych na dotychczasowym koncie.

• Musisz mieć pełną kontrolę nad procesem tworzenia konta. Możesz na przykład zablokować tworzenie konta, jeśli podczas tego procesu musisz wyświetlić użytkownikowi warunki usługi.

Uwaga: aby dowiedzieć się więcej o wdrażaniu wybranego procesu, wybierz jedną z opcji poniżej. W razie potrzeby zawartość przewodnika zostanie ponownie wczytana, aby dostosować się do Twojego wyboru.

Zezwalaj na tworzenie konta za pomocą głosu Nie zezwalaj na tworzenie konta za pomocą głosu

Wdrożenie uproszczonego łączenia kont za pomocą logowania przez Google opartego na OAuth

Konta są łączone za pomocą standardowych przepływów OAuth 2.0. Actions on Google obsługuje procesy niejawne i z kodem autoryzacji.

Uwaga: jeśli wdrażasz łączenie kont w celu obsługi informacji finansowych, pamiętaj, że Twoja czynność może podlegać dodatkowym zasadom. Sprawdzenie działania z połączeniem konta pod kątem informacji finansowych może potrwać do 6 tygodni, więc uwzględnij ten czas w harmonogramie publikacji. Aby ułatwić proces sprawdzania, przed przesłaniem działania do sprawdzenia upewnij się, że jest ono zgodne z zasadami dotyczącymi usług finansowych.

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

Konfigurowanie projektu

Aby skonfigurować projekt pod kątem uproszczonego łączenia, wykonaj te czynności:

1. Otwórz konsolę Actions i wybierz projekt, którego chcesz użyć.
2. Kliknij kartę Tworzenie i wybierz Łączenie kont.
3. Włącz przełącznik obok opcji Łączenie kont.
4. W sekcji Tworzenie konta wybierz Tak.

5. W sekcji Typ połączenia wybierz OAuth i logowanie przez Google oraz Pośredni.

   

6. W sekcji Informacje o kliencie wykonaj te czynności:

   • Przypisz wartość do pola Identyfikator klienta wydany przez Twoje działania w Google, aby identyfikować żądania pochodzące z Google.
   • Wstaw adresy URL punktów końcowych autoryzacji i wymiany tokenów.

7. Kliknij Zapisz.

Wdrażanie serwera OAuth

为了支持 OAuth 2.0 隐式流程，您的服务会进行授权 端点。此端点负责 就数据访问征得用户同意。授权端点 向尚未登录的用户显示登录界面，并记录 同意所请求的访问。

当您的 Action 需要调用您的某项授权的 API 时，Google 会使用 此端点来获得用户许可，以在其上调用这些 API 。

由 Google 发起的典型 OAuth 2.0 隐式流会话具有以下特征： 以下流程：

1. Google 会在用户的浏览器中打开您的授权端点。通过 如果用户尚未登录，则可以登录，并且授予 Google 访问 通过您的 API 访问其数据（如果尚未授予权限）。
2. 您的服务会创建一个访问令牌并将其返回给 通过使用访问令牌将用户的浏览器重定向回 Google， 附件。
3. Google 调用您的服务的 API，并使用 。您的服务会验证访问令牌是否向 Google 授予 访问 API 的授权，然后完成 API 调用。

处理授权请求

当您的 Action 需要通过 OAuth 2.0 隐式流程执行账号关联时， Google 会通过包含以下内容的请求将用户发送到您的授权端点： 以下参数：

授权端点参数
client_id	您分配给 Google 的客户 ID。
redirect_uri	此请求的响应发送到的网址。
state	将一个在 重定向 URI。
response_type	要在响应中返回的值的类型。对于 OAuth 2.0 隐式 则响应类型始终为 token。

例如，如果您的授权端点可通过 https://myservice.example.com/auth 访问， 请求可能如下所示：

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

为了让授权端点能够处理登录请求，请执行以下步骤：

1. 验证 client_id 和 redirect_uri 值， 防止向意外或配置错误的客户端应用授予访问权限：

   • 确认 client_id 是否与您的客户端 ID 匹配 分配给 Google。
   • 确认 redirect_uri 指定的网址 参数的格式如下：

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

     YOUR_PROJECT_ID 是项目设置页面上的 ID Actions 控制台界面。

2. 检查用户是否已登录您的服务。如果用户未登录 中，完成服务的登录或注册流程。

3. 生成 Google 将用于访问您的 API 的访问令牌。通过 访问令牌可以是任何字符串值，但必须唯一地表示 令牌对应的用户和客户端，且不得被猜到。

4. 发送 HTTP 响应，将用户浏览器重定向到相应网址 由 redirect_uri 参数指定。添加所有 以下参数：

   • access_token：您刚刚生成的访问令牌
   • token_type：字符串 bearer
   • state：原始状态的未修改状态值 请求 以下是生成的网址示例：

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

Google 的 OAuth 2.0 重定向处理程序将收到访问令牌并确认 state 值没有更改。在 Google 获得 访问令牌，则 Google 会将该令牌附加到后续调用 作为 AppRequest 的一部分添加到您的 Action。

处理自动关联

在用户同意你的 Action 访问他们的 Google 个人资料后，Google 发送请求，其中包含 Google 用户身份的已签名断言。 该断言包含的信息包括用户的 Google 账号 ID、姓名、 和电子邮件地址。为项目配置的令牌交换端点处理 请求。

如果您的身份验证系统中已经存在相应的 Google 账号， 您的令牌交换端点为用户返回令牌。如果 Google 账号没有 匹配现有用户，您的令牌交换端点会返回 user_not_found 错误。

请求的格式如下：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

您的令牌交换端点必须能够处理以下参数：

令牌端点参数
grant_type	所交换的令牌的类型。对于这类请求 参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer。
intent	对于这些请求，此参数的值为 `get`。
assertion	一个 JSON Web 令牌 (JWT)，提供 Google 用户身份。JWT 包含的信息包括 账号 ID、名称和电子邮件地址。
consent_code	可选：一个一次性代码（如果存在）用于表明 用户已同意你的 Action 访问指定范围。
scope	可选：您配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，它应该 以下：

验证和解码 JWT 断言

您可以使用适用于您语言的 JWT 解码库来验证和解码 JWT 断言。 使用 Google 的公钥（适用于 JWK 或 PEM 格式）来验证令牌的 签名。

注意 ：不得对键进行硬编码。而应按照 OpenID Connect Discovery 协议 并检查 cache-control 标头，以确定应将密钥缓存多长时间。

解码后，JWT 断言如以下示例所示：

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，还要验证断言的颁发者 （iss 字段）为 https://accounts.google.com，且受众群体（aud 字段） 是分配给您的 Action 的客户端 ID。

检查您的身份验证系统中是否已存在该 Google 账号

请检查以下任一条件是否成立：

• Google 账号 ID 可在断言的 sub 字段中找到，也可位于您的用户数据库中。
• 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，则表明用户已经注册，您可以发出 访问令牌。

如果断言中指定的 Google 账号 ID 和电子邮件地址都没有 与您数据库中的用户匹配，表示该用户尚未注册。在这种情况下，您的 令牌交换端点应回复 HTTP 401 错误，指定 error=user_not_found， 如以下示例中所示：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}

当 Google 收到包含 user_not_found 错误的 401 错误响应时， 使用 intent 参数的值调用您的令牌交换端点 设置为 create 并发送包含用户个人资料信息的 ID 令牌 一起发送。

通过 Google 登录功能处理账号创建

当用户需要在您的服务中创建账号时，Google 会 向令牌交换端点发送的请求 intent=create，如以下示例所示：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

assertion 参数包含 JSON Web 令牌 (JWT)，可提供 Google 用户的身份的已签名断言。JWT 包含 其中包含用户的 Google 账号 ID、姓名和电子邮件地址 为您的服务创建一个新账号。

如需响应账号创建请求，您的令牌交换端点必须执行以下操作 以下：

验证和解码 JWT 断言

您可以使用适用于您语言的 JWT 解码库来验证和解码 JWT 断言。 使用 Google 的公钥（适用于 JWK 或 PEM 格式）来验证令牌的 签名。

注意 ：不得对键进行硬编码。而应按照 OpenID Connect Discovery 协议 并检查 cache-control 标头，以确定应将密钥缓存多长时间。

解码后，JWT 断言如以下示例所示：

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，还要验证断言的颁发者 （iss 字段）为 https://accounts.google.com，且受众群体（aud 字段） 是分配给您的 Action 的客户端 ID。

验证用户信息并创建新账号

请检查以下任一条件是否成立：

• Google 账号 ID 可在断言的 sub 字段中找到，也可位于您的用户数据库中。
• 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，则提示用户将其现有账号关联 通过使用 HTTP 401 错误响应请求 error=linking_error，并将用户的电子邮件地址为 login_hint，如 示例：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"[e-mail]"
}

如果以上两个条件都不满足，请使用相应信息创建一个新的用户账号 。新账号通常不会设置密码。时间是 建议您将 Google 登录功能添加到其他平台，以便用户能够 在您的应用的各个界面上通过 Google 投放广告。或者，您也可以 通过电子邮件向用户发送链接，启动密码恢复流程，以便用户设置 密码，以便在其他平台上登录。

创建完成后，发出一个访问令牌 并在 HTTPS 响应的正文，如以下示例所示：

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",
  
  "expires_in": SECONDS_TO_EXPIRATION
}

Zaprojektuj interfejs głosowy dla procesu uwierzytelniania.

Ostrzeżenie: nie wyświetlaj użytkownikom na początku rozmowy z Twoją akcją monitu o połączenie konta. Zamiast tego udostępnij nieuwierzytelnionym użytkownikom przepływ gościa, aby pokazać, jak działa Twoja akcja, a potem poproś o połączenie konta tylko wtedy, gdy jest to konieczne do dalszego działania. Jeśli użytkownicy stale opuszczają działanie z powodu problemów z łączeniem kont, Google nie będzie aktywnie promować tego działania, co może zmniejszyć ruch użytkowników.

Uwaga: aby utworzyć działanie, które implementuje łączenie kont, musisz użyć narzędzia Actions Builder.

Sprawdź, czy użytkownik jest zweryfikowany, i rozpocznij proces łączenia konta.

1. Otwórz projekt w Actions Builder w konsoli Actions.
2. Utwórz nową scenę, aby rozpocząć łączenie kont w swojej akcji:
   1. Kliknij Sceny.
   2. Kliknij ikonę dodawania (+), aby dodać nową scenę.
3. W nowo utworzonej scenie kliknij ikonę dodawania  obok Warunków.
4. Dodaj warunek, który sprawdza, czy użytkownik powiązany z rozmową jest zweryfikowany. Jeśli weryfikacja się nie powiedzie, Akcja nie będzie mogła połączyć kont podczas rozmowy i powinna wrócić do udostępniania funkcji, które nie wymagają łączenia kont.
   1. W polu Enter new expression w sekcji Warunek wpisz tę logikę: user.verificationStatus != "VERIFIED"
   2. W sekcji Przejście wybierz scenę, która nie wymaga połączenia konta, lub scenę, która jest punktem wejścia do funkcji dostępnych tylko dla gości.

1. Kliknij ikonę dodawania  obok pozycji Warunki.
2. Dodaj warunek, który uruchomi proces łączenia kont, jeśli użytkownik nie ma powiązanej tożsamości.
   1. W polu Enter new expression w sekcji Warunek wpisz tę logikę:user.verificationStatus == "VERIFIED"
   2. W sekcji Przejście wybierz scenę systemową Łączenie kont.
   3. Kliknij Zapisz.

Po zapisaniu do projektu zostanie dodana nowa scena systemu łączenia kont o nazwie <SceneName>_AccountLinking.

Dostosowywanie sceny łączenia kont

1. W sekcji Sceny wybierz scenę systemu łączenia kont.
2. Kliknij Wyślij prompt i dodaj krótkie zdanie, aby wyjaśnić użytkownikowi, dlaczego działanie potrzebuje dostępu do jego tożsamości (np. „Aby zapisać Twoje ustawienia”).
3. Kliknij Zapisz.

1. W sekcji Warunki kliknij Jeśli użytkownik pomyślnie połączy konta.
2. Skonfiguruj, jak ma przebiegać proces, jeśli użytkownik zgodzi się na połączenie konta. Możesz na przykład wywołać webhooka, aby przetworzyć dowolną niestandardową logikę biznesową i wrócić do pierwotnej sceny.
3. Kliknij Zapisz.

1. W sekcji Warunki kliknij Jeśli użytkownik anuluje połączenie konta lub je odrzuci.
2. Skonfiguruj, jak ma przebiegać proces, jeśli użytkownik nie zgodzi się na połączenie konta. Możesz na przykład wysłać wiadomość z potwierdzeniem i przekierować użytkownika do scen, które zapewniają funkcje niewymagające połączenia kont.
3. Kliknij Zapisz.

1. W sekcji Warunki kliknij Jeśli wystąpi błąd systemu lub sieci.
2. Skonfiguruj, jak ma przebiegać proces, jeśli nie można go ukończyć z powodu błędów systemu lub sieci. Możesz na przykład wysłać wiadomość z potwierdzeniem i przekierować użytkownika do scen, które zapewniają funkcje niewymagające połączenia kont.
3. Kliknij Zapisz.

Obsługa próśb o dostęp do danych

Jeśli żądanie Asystenta zawiera token dostępu, najpierw sprawdź, czy jest on ważny i nie wygasł, a potem pobierz z bazy danych kont użytkowników konto powiązane z tym tokenem.