ربط الحساب من خلال الربط "سهل" لتسجيل الدخول إلى Google المستند إلى OAuth

يضيف نوع الربط المبسّط" لتسجيل الدخول بحساب Google" المستنِد إلى بروتوكول OAuth ميزة "تسجيل الدخول بحساب Google" إلى ميزة ربط الحسابات المستندة إلى بروتوكول OAuth. ويوفّر ذلك رابطًا سلسًا عبر الصوت لمستخدمي Google مع إتاحة إمكانية ربط الحساب للمستخدمين الذين سجّلوا في خدمتك بهوية غير تابعة لشركة Google.

يبدأ نوع الربط هذا بـ "تسجيل الدخول بحساب Google"، الذي يتيح لك التحقّق من توفُّر معلومات الملف الشخصي للمستخدم على Google في نظامك. إذا لم يتم العثور على معلومات المستخدم في نظامك، فسيبدأ تدفق OAuth قياسي. يمكن للمستخدم أيضًا اختيار إنشاء حساب جديد باستخدام معلومات الملف الشخصي في Google.

لإجراء عملية ربط الحساب باستخدام نوع الربط المبسّط، اتّبِع الخطوات العامة التالية:

1. أولاً، اطلب من المستخدم منح موافقته على الوصول إلى ملفه الشخصي في Google.
2. استخدام المعلومات الواردة في ملفه الشخصي لتحديد المستخدم
3. إذا لم تتمكن من العثور على مطابقة لمستخدم Google في نظام المصادقة لديك، يستمر تدفق العملية استنادًا إلى ما إذا كنت قد أعددت مشروع الإجراءات في وحدة تحكم المهام للسماح بإنشاء حساب المستخدم عبر الصوت أو على موقعك الإلكتروني فقط.
   • إذا سمحت بإنشاء الحساب عبر الصوت، فتحقق من الرمز المميز للمعرف الذي تتلقاه من Google. يمكنك بعد ذلك إنشاء مستخدم استنادًا إلى معلومات الملف الشخصي الواردة في الرمز المميز للمعرف.
   • إذا كنت لا تسمح بإنشاء الحساب عبر الصوت، سيتم نقل المستخدم إلى متصفّح يمكنه من خلاله تحميل صفحة التفويض وإكمال عملية إنشاء المستخدم.

دعم إنشاء الحساب عبر الصوت

إذا كنت تسمح بإنشاء حسابات المستخدمين من خلال الصوت، سيسأل "مساعد Google" المستخدم عمّا إذا كان يريد تنفيذ الإجراءات التالية:

• إنشاء حساب جديد على نظامك باستخدام معلومات حساب Google الخاص به، أو
• سجّل الدخول إلى نظام المصادقة باستخدام حساب مختلف إذا كان لديهم حساب حالي غير تابع لشركة Google.

ننصحك بالسماح بإنشاء الحساب عبر الصوت إذا كنت تريد تقليل أي صعوبات تعيق سير عملية إنشاء الحساب. لا يحتاج المستخدم إلى مغادرة مسار Voice إلا إذا أراد تسجيل الدخول باستخدام حساب حالي غير تابع لشركة Google.

عدم السماح بإنشاء الحساب عبر الصوت

إذا كنت لا تسمح بإنشاء حسابات المستخدمين من خلال الطلبات الصوتية، سيفتح "مساعد Google" عنوان URL على الموقع الإلكتروني الذي قدّمته للمصادقة. إذا كان التفاعل يحدث على جهاز لا يحتوي على شاشة، سيوجِّه "مساعد Google" المستخدم إلى هاتف لمواصلة عملية ربط الحساب.

ويُنصح بعدم السماح بالإنشاء في الحالات التالية:

• أنت لا تريد السماح للمستخدمين الذين لديهم حسابات غير تابعة لشركة Google بإنشاء حساب مستخدم جديد ولا تريد منهم الربط بحسابات المستخدمين الحالية في نظام المصادقة لديك، بدلاً من ذلك. على سبيل المثال، إذا كنت تقدّم برنامج ولاء، ننصحك بالتأكد من أنّ المستخدم لن يخسر النقاط المتراكمة في حسابه الحالي.

• يجب أن يكون لديك تحكّم كامل في عملية إنشاء الحساب. على سبيل المثال، يمكنك حظر إنشاء المحتوى إذا أردت عرض بنود الخدمة للمستخدم أثناء إنشاء الحساب.

تنفيذ الربط "المبسّط" لتسجيل الدخول بحساب Google المستند إلى بروتوكول OAuth

ترتبط الحسابات بمسارات بروتوكول OAuth 2.0 وفقًا للمعيار المتّبع في المجال. تتيح "المهام مع مساعد Google" العمليات الضمنية ورموز التفويض.

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.

ضبط المشروع

لإعداد مشروعك لاستخدام الربط السلس، اتبع الخطوات التالية:

1. افتح وحدة تحكّم الإجراءات واختَر المشروع الذي تريد استخدامه.
2. انقر على علامة التبويب تطوير واختر ربط الحساب.
3. فعِّل مفتاح التبديل بجانب ربط الحساب.
4. في القسم إنشاء الحساب، اختَر نعم.

5. في نوع الربط، اختَر OAuth وتسجيل الدخول بحساب Google وضمني.

   

6. في معلومات العميل، يُرجى تنفيذ ما يلي:

   • يجب تخصيص قيمة إلى معرّف العميل الذي يتم إصداره من خلال "المهام مع مساعد Google" لتحديد الطلبات الواردة من Google.
   • أدرِج عناوين URL لنقاط نهاية "التفويض" و"تبادل الرموز المميّزة".

7. انقر على حفظ.

تنفيذ خادم 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.

处理自动关联

用户同意您的 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 包含用户的 Google 帐号 ID、名称和电子邮件地址等信息。
consent_code	可选：如果存在，这是一个一次性代码，用于表明用户已同意您的 Action 访问指定范围。
scope	可选：您已配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，应执行以下操作：

验证和解码 JWT 断言

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

解码后，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": "jan@gmail.com", // 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 错误响应时，Google 会调用您的令牌交换端点，将 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 网络令牌 (JWT)，该令牌提供了 Google 用户身份的已签名断言。JWT 包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息，您可以使用这些信息在您的服务上创建新帐号。

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

验证和解码 JWT 断言

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

解码后，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": "jan@gmail.com", // 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，从而将其现有帐号与其 Google 帐号相关联，如以下示例所示：

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

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

如果两个条件都不满足，则使用 JWT 中提供的信息创建新的用户帐号。新帐号通常不会设置密码。建议您将 Google 登录功能添加到其他平台，让用户能够在应用的各种途径中通过 Google 登录。或者，您也可以通过电子邮件向用户发送用于启动密码恢复流程的链接，以便用户设置用于在其他平台上登录的密码。

创建完成后，发出访问令牌 ，然后返回 HTTPS 响应正文中 JSON 对象中的值，如以下示例所示：

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

تصميم واجهة مستخدم صوتي لتدفق المصادقة

التحقّق ممّا إذا كان قد تم إثبات هوية المستخدم، ثم ابدأ عملية ربط الحساب

1. افتح مشروع "أداة إنشاء الإجراءات" في وحدة تحكّم المهام.
2. أنشِئ مشهدًا جديدًا لبدء ربط الحساب في الإجراء الخاص بك:
   1. انقر على مشاهد.
   2. انقر على رمز الإضافة (+) لإضافة مشهد جديد.
3. في المشهد الذي تم إنشاؤه حديثًا، انقر على رمز الإضافة add لـ الشروط.
4. أضِف شرطًا يتحقّق مما إذا كان المستخدم المرتبط بالمحادثة مستخدمًا تم التحقّق من هويته وأهليته. وإذا تعذّر إكمال عملية التحقّق، لن يتمكّن الإجراء الخاص بك من ربط الحساب أثناء المحادثة، ويجب أن يعود متاحًا لإتاحة الوصول إلى الوظائف التي لا تتطلب ربط الحساب.
   1. في حقل Enter new expression ضمن الشرط، أدخِل المنطق التالي: user.verificationStatus != "VERIFIED"
   2. ضمن النقل، اختَر مشهدًا لا يتطلب ربط الحساب أو مشهدًا يمثّل نقطة الدخول إلى وظيفة وضع الضيف فقط.

1. انقر على رمز الإضافة add ضِمن الشروط.
2. أضِف شرطًا لبدء عملية ربط الحساب إذا لم يكن لدى المستخدم هوية مرتبطة.
   1. في حقل Enter new expression ضمن الشرط، أدخِل المنطق التالي: user.verificationStatus == "VERIFIED"
   2. ضمن النقل، اختر مشهد النظام ربط الحساب.
   3. انقر على حفظ.

بعد الحفظ، تتم إضافة مشهد جديد لنظام ربط الحسابات يسمى <SceneName>_AccountLinking إلى مشروعك.

تخصيص مشهد ربط الحسابات

1. ضمن المشاهد، اختَر مشهد نظام ربط الحساب.
2. انقر على إرسال إشعار وأضِف جملة قصيرة لتوضّح للمستخدم سبب حاجة الإجراء إلى الوصول إلى هويته (على سبيل المثال "لحفظ إعداداتك المفضّلة").
3. انقر على حفظ.

1. ضمن الشروط، انقر على في حال إكمال المستخدم ربط الحساب بنجاح.
2. اضبط كيفية سير التدفق إذا وافق المستخدم على ربط حسابه. على سبيل المثال، يمكنك الاتصال بالرد التلقائي على الويب لمعالجة أي منطق مخصص للنشاط التجاري مطلوب والرجوع إلى المشهد الأصلي.
3. انقر على حفظ.

1. ضمن الشروط، انقر على في حال إلغاء المستخدم ربط الحساب أو رفضه.
2. اضبط كيفية سير العملية إذا لم يوافق المستخدم على ربط حسابه. على سبيل المثال، أرسِل رسالة إقرار وإعادة التوجيه إلى المشاهد التي توفّر وظائف لا تتطلب ربط الحساب.
3. انقر على حفظ.

1. ضمن الشروط، انقر على في حال حدوث خطأ في النظام أو الشبكة.
2. اضبط كيفية سير التدفق إذا تعذّر إكمال عملية ربط الحساب بسبب أخطاء في النظام أو الشبكة. على سبيل المثال، أرسِل رسالة إقرار وإعادة التوجيه إلى المشاهد التي توفّر وظائف لا تتطلب ربط الحساب.
3. انقر على حفظ.

معالجة طلبات الوصول إلى البيانات

إذا كان طلب "مساعد Google" يحتوي على رمز دخول، تحقّق أولاً من أنّ رمز الدخول صالح وغير منتهي الصلاحية، ثم استرِد حساب المستخدم المرتبط بالرمز المميّز من قاعدة بيانات حساب المستخدم.