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

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

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

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

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

  1. أولاً، اطلب من المستخدم منح موافقته على الوصول إلى ملفه الشخصي في Google.
  2. استخدام المعلومات الواردة في ملفه الشخصي لتحديد المستخدم
  3. إذا لم تتمكن من العثور على مطابقة لمستخدم Google في نظام المصادقة لديك، يستمر تدفق العملية استنادًا إلى ما إذا كنت قد أعددت مشروع الإجراءات في وحدة تحكم المهام للسماح بإنشاء حساب المستخدم عبر الصوت أو على موقعك الإلكتروني فقط.
    • إذا سمحت بإنشاء الحساب عبر الصوت، فتحقق من الرمز المميز للمعرف الذي تتلقاه من Google. يمكنك بعد ذلك إنشاء مستخدم استنادًا إلى معلومات الملف الشخصي الواردة في الرمز المميز للمعرف.
    • إذا كنت لا تسمح بإنشاء الحساب عبر الصوت، سيتم نقل المستخدم إلى متصفّح يمكنه من خلاله تحميل صفحة التفويض وإكمال عملية إنشاء المستخدم.
إذا سمحت بإنشاء الحساب عبر الصوت ولم تتمكن من العثور على تطابق للملف الشخصي في Google في نظام المصادقة، تحتاج إلى التحقق من الرمز المميز لرقم التعريف الذي استلمته من Google. يمكنك بعد ذلك إنشاء مستخدم استنادًا إلى معلومات الملف الشخصي المضمَّنة في الرمز المميّز للمعرّف. في حال عدم السماح بإنشاء حساب المستخدم من خلال الصوت، سيتم نقل المستخدم إلى متصفّح يمكنه من خلاله تحميل صفحة التفويض وإكمال الخطوات.
الشكل 2. عرض مرئي لتدفق OAuth و"تسجيل الدخول بحساب 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

لدعم تدفق OAuth 2.0 الضمني، توفِّر الخدمة نقطة نهاية للتفويض من خلال HTTPS. نقطة النهاية هذه مسؤولة عن مصادقة والحصول على موافقة المستخدمين للوصول إلى البيانات. تعرض نقطة نهاية التفويض واجهة مستخدم لتسجيل الدخول للمستخدمين الذين لم يسبق لهم تسجيل الدخول، كما تسجِّل الموافقة على الوصول المطلوب.

عندما يحتاج الإجراء الخاص بك إلى استدعاء إحدى واجهات برمجة التطبيقات المعتمَدة في خدمتك، تستخدم Google نقطة النهاية هذه للحصول على إذن من المستخدمين لطلب واجهات برمجة التطبيقات هذه نيابةً عنهم.

في ما يلي الخطوات التي يجب اتّباعها في جلسة التدفق الضمني لبروتوكول OAuth 2.0 التي تبدأها Google:

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

معالجة طلبات التفويض

عندما يحتاج الإجراء الخاص بك إلى ربط الحساب من خلال مسار ضمني لبروتوكول OAuth 2.0، ترسل Google المستخدم إلى نقطة نهاية التفويض مع طلب يتضمّن المَعلمات التالية:

مَعلمات نقطة نهاية التفويض
client_id معرِّف العميل الذي حدّدته إلى Google.
redirect_uri عنوان URL الذي ترسل إليه الرد على هذا الطلب.
state يشير ذلك المصطلح إلى قيمة مسك الدفاتر التي يتم إرجاعها إلى Google بدون تغيير في معرّف الموارد المنتظم (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 يطابق معرِّف العميل الذي خصّصته لشركة Google.
    • تأكَّد من أنّ عنوان URL المحدَّد من خلال المَعلمة redirect_uri يحتوي على النموذج التالي: 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID هو رقم التعريف المتوفّر في صفحة إعدادات المشروع من "وحدة تحكّم المهام".

  2. تحقَّق مما إذا كان المستخدم قد سجّل الدخول إلى خدمتك. إذا لم يسجّل المستخدم الدخول، أكمِل عملية تسجيل الدخول أو الاشتراك في الخدمة.

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

  4. أرسِل استجابة HTTP تعيد توجيه متصفّح المستخدم إلى عنوان URL الذي حددته المعلَمة redirect_uri. أدرِج جميع المَعلمات التالية في جزء عنوان URL:

    • access_token: رمز الدخول الذي أنشأته للتو
    • token_type: السلسلة bearer
    • state: قيمة الحالة غير المُعدَّلة من الطلب الأصلي في ما يلي مثال على عنوان URL الناتج: 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

سيتلقّى معالِج إعادة التوجيه OAuth 2.0 من Google رمز الدخول ويتأكّد من عدم تغيير قيمة state. بعد أن تحصل Google على رمز دخول إلى خدمتك، سترفق Google الرمز المميّز في الطلبات اللاحقة إلى الإجراء الخاص بك كجزء من 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 令牌。

Handle account creation via Google Sign-In

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create, as in the following example:

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]

The assertion parameter contains A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address, which you can use to create a new account on your service.

To respond to account creation requests, your token exchange endpoint must do the following:

验证和解码 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。

Validate user information and create new account

Check whether either of the following conditions are true:

  • The Google Account ID, found in the assertion's sub field, is in your user database.
  • The email address in the assertion matches a user in your user database.

If either condition is true, prompt the user to link their existing account with their Google Account by responding to the request with an HTTP 401 error, specifying error=linking_error and the user's email address as the login_hint, as in the following example:

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

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

If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password for signing in on other platforms.

When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example: 

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

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

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

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

  1. انقر على رمز الإضافة ضِمن الشروط.
  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" يحتوي على رمز دخول، تحقّق أولاً من أنّ رمز الدخول صالح وغير منتهي الصلاحية، ثم استرِد حساب المستخدم المرتبط بالرمز المميّز من قاعدة بيانات حساب المستخدم.