OAuth ile hesap bağlama

OAuth bağlama türü, sektör standardı olan iki OAuth 2.0 akışını (örtük ve yetkilendirme kod akışı) destekler.

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

OAuth hesap bağlamayı uygulayın

Not: Finansal bilgileri işlemek için hesap bağlama işlemi gerçekleştiriyorsanız İşleminiz için ek politikaların geçerli olabileceğini unutmayın. Finansal bilgiler için hesap bağlama içeren bir işlemi incelememiz altı haftaya kadar sürebilir. Bu nedenle, yayın planınızı planlarken bu süreyi de hesaba katın. İnceleme sürecini kolaylaştırmak için İşleminizi incelemeye göndermeden önce mali hizmetler politikalarına uyduğunuzdan emin olun.

Projeyi yapılandırma

Projenizi OAuth bağlantısını kullanacak şekilde yapılandırmak için aşağıdaki adımları uygulayın:

1. Actions Console'u açın ve kullanmak istediğiniz projeyi seçin.
2. Geliştirme sekmesini tıklayın ve Hesap bağlama'yı seçin.
3. Hesap bağlama'nın yanındaki anahtarı etkinleştirin.
4. Hesap oluşturma bölümünde Hayır, yalnızca web sitemde hesap oluşturulmasına izin vermek istiyorum'u seçin.

5. Bağlantı türü bölümünde OAuth ve Dolaylı'yı seçin.

   

6. Müşteri Bilgileri bölümünde:

   • Google'dan gelen istekleri tanımlamak için Actions to Google'a (İşlemleriniz tarafından Google'a gönderilen) bir değer atayın.
   • Yetkilendirme ve Jeton Değişimi uç noktalarınızın URL'lerini ekleyin.

Not: İstemci kimliğinizin base64 olarak kodlanmış dize olarak gönderilmesini istiyorsanız İstemcinizi yapılandırın (isteğe bağlı) seçeneğinin yanındaki açılır oku tıklayın ve Google, istemci kimliğini ve gizli anahtarı HTTP temel kimlik doğrulama üst bilgisi üzerinden iletmek için kutusunu işaretleyin.

6. Kaydet'i tıklayın.

OAuth sunucunuzu uygulama

为了支持 OAuth 2.0 隐式流程，您的服务会通过 HTTPS 提供授权端点。此端点负责验证数据访问并从用户那里获得同意。授权端点会向尚未登录的用户呈现登录界面，并记录用户同意所请求的访问。

当您的 Action 需要调用某项服务的已授权 API 时，Google 会使用此端点从您的用户处获取权限，以便代表他们调用这些 API。

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

1. Google 会在用户的浏览器中打开您的授权端点。用户如果尚未登录，则登录；如果用户尚未授予权限，则授予 Google 使用您的 API 访问其数据的权限。
2. 您的服务会创建访问令牌，并使用附加到请求的访问令牌将用户的浏览器重定向回 Google，从而将其返回给 Google。
3. Google 会调用您的服务的 API，并为每个请求附加访问令牌。您的服务会验证访问令牌是否授予 Google 访问 API 的授权，然后完成 API 调用。

处理授权请求

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

授权端点参数
client_id	您分配给 Google 的客户端 ID。
redirect_uri	您要将该请求的响应发送到的网址。
state	在重定向 URI 中原封不动地传回 Google 的簿记值。
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 与您分配给 Google 的客户端 ID 匹配。
   • 确认 redirect_uri 参数指定的网址采用以下格式：

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

     YOUR_PROJECT_ID 是在 Actions 控制台的 Project settings 页面上找到的 ID。

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 为您的服务获取访问令牌后，会将该令牌作为 AppRequest 的一部分附加到对您的 Action 的后续调用。

Kimlik doğrulama akışı için ses kullanıcı arayüzünü tasarlama

Uyarı: İşleminizle görüşmenin başında kullanıcılara zorunlu bir hesap bağlama istemi vermeyin. Bunun yerine, kimliği doğrulanmamış kullanıcılara İşleminizin nasıl çalıştığını göstermek için misafir akışı sağlayın ve yalnızca devam etmek için gerekliyse hesap bağlama işlemini isteyin. Kullanıcılar, hesap bağlama sorunları nedeniyle İşlem'den sürekli olarak ayrılıyorsa Google, İşlemi etkin bir şekilde tanıtmaz. Bu da işlemin kullanıcı trafiğini azaltabilir.

Not: Hesap bağlamanın uygulandığı bir İşlem oluşturmak için Actions Builder'ı kullanmanız gerekir.

Kullanıcının doğrulanıp doğrulanmadığını kontrol etme ve hesap bağlama akışını başlatma

1. Actions Console'da Actions Builder projenizi açın.
2. İşleminizde hesap bağlamayı başlatmak için yeni bir sahne oluşturun:
   1. Sahneler'i tıklayın.
   2. Yeni bir sahne eklemek için ekle (+) simgesini tıklayın.
3. Yeni oluşturulan sahnede Koşullar için ekle simgesini tıklayın.
4. Görüşmeyle ilişkilendirilen kullanıcının doğrulanmış bir kullanıcı olup olmadığını kontrol eden bir koşul ekleyin. Kontrol başarısız olursa İşleminiz görüşme sırasında hesap bağlama işlemi gerçekleştiremez ve hesap bağlamayı gerektirmeyen işlevlere erişim sağlamaya devam etmelidir.
   1. Koşul bölümündeki Enter new expression alanına aşağıdaki mantığı girin: user.verificationStatus != "VERIFIED"
   2. Geçiş bölümünde, hesap bağlama gerektirmeyen bir düzen veya yalnızca konuklara özel işleve giriş noktası olan bir düzen seçin.

1. Koşullar için ekle simgesini tıklayın.
2. Kullanıcının ilişkili bir kimliği yoksa hesap bağlama akışını tetiklemek için bir koşul ekleyin.
   1. Koşul bölümündeki Enter new expression alanına aşağıdaki mantığı girin: user.verificationStatus == "VERIFIED"
   2. Geçiş bölümünde, Hesap Bağlama sistem sahnesini seçin.
   3. Kaydet'i tıklayın.

Kaydettikten sonra projenize <SceneName>_AccountLinking adlı yeni bir hesap bağlama sistemi düzeni eklenir.

Hesap bağlama sahnesini özelleştirin

1. Sahneler bölümünde, hesap bağlama sistemi sahnesini seçin.
2. İstem gönder'i tıklayın ve işlemin neden kimliğine erişmesi gerektiğini kullanıcıya açıklamak için kısa bir cümle ekleyin (örneğin, "Tercihlerinizi kaydetmek için").
3. Kaydet'i tıklayın.

1. Koşullar bölümünde, Kullanıcı hesap bağlamayı başarıyla tamamlarsa'yı tıklayın.
2. Kullanıcı, hesabını bağlamayı kabul ederse akışın nasıl devam edeceğini yapılandırın. Örneğin, gerekli olan özel iş mantığını işlemesi ve kaynak sahneye geri dönmesi için webhook'u çağırın.
3. Kaydet'i tıklayın.

1. Koşullar bölümünde, Kullanıcı hesap bağlamayı iptal eder veya reddederse'yi tıklayın.
2. Kullanıcı, hesabını bağlamayı kabul etmezse akışın nasıl devam edeceğini yapılandırın. Örneğin, onaylama mesajı gönderin ve kullanıcıları, hesap bağlamayı gerektirmeyen işlevler sunan sahnelere yönlendirin.
3. Kaydet'i tıklayın.

1. Koşullar bölümünde, Sistem veya ağ hatası oluşursa'yı tıklayın.
2. Hesap bağlama akışı sistem veya ağ hataları nedeniyle tamamlanamıyorsa akışın nasıl devam edeceğini yapılandırın. Örneğin, onaylama mesajı gönderin ve kullanıcıları, hesap bağlamayı gerektirmeyen işlevler sunan sahnelere yönlendirin.
3. Kaydet'i tıklayın.

Veri erişim isteklerini işleme

Asistan isteği erişim jetonu içeriyorsa öncelikle erişim jetonunun geçerli olduğundan (ve süresinin dolmamış olduğundan) emin olun, ardından veritabanınızdan ilişkili kullanıcı hesabını alın.