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

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

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

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

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

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

الشكل 2. تمثيل مرئي لمسار التفويض المفتوح (OAuth) و"تسجيل الدخول باستخدام Google" عندما لا يتم العثور على معلومات المستخدم في نظامك

إتاحة إنشاء حساب من خلال الصوت

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

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

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

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

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

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

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

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

ملاحظة: اختَر أحد خيارات مسار الإحالة أدناه لمعرفة المزيد حول تنفيذ المسار المحدّد. إذا لزم الأمر، ستتم إعادة تحميل محتوى الدليل ليتناسب مع اختيارك.

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

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

يتم ربط الحسابات بمسارات 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.

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

ضبط إعدادات المشروع

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

1. افتح "وحدة تحكّم الإجراءات" (Actions console) واختَر المشروع الذي تريد استخدامه.
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.

التعامل مع عمليات الربط التلقائي

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

إذا كان حساب 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 المميّز للويب (JWT) ويقدِّم تأكيدًا موقَّعًا على بيانات وهوية المستخدم. ويحتوي JWT على معلومات تتضمن عنوان البريد الإلكتروني للمستخدم رقم تعريف الحساب والاسم وعنوان البريد الإلكتروني
consent_code	اختياري: عند وجود رمز يُستخدم لمرة واحدة، وهو يشير إلى أن منح المستخدم موافقته على وصول الإجراء الخاص بك إلى النطاقات المحدّدة.
scope	اختياري: أي نطاقات ضبطتها Google لطلبها من المستخدمين.

عندما تتلقّى نقطة نهاية تبادل الرموز المميّزة طلب الربط، يجب إجراء ما يلي: التالي:

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.

Note: The keys should not be hardcoded. Instead, follow OpenID connect discovery protocol and check the cache-control header to decide how long the key should be cached.

When decoded, the JWT assertion looks like the following example:

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

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com and that the audience (aud field) is the client ID assigned to your Action.

التأكّد من توفّر حساب Google في نظام المصادقة

تحقق مما إذا كان أي من الشروط التالية صحيحًا:

• رقم تعريف حساب Google، الوارد في حقل sub للتأكيد، موجود في قاعدة بيانات المستخدم لديك.
• يتطابق عنوان البريد الإلكتروني الوارد في التأكيد مع مستخدم في قاعدة بيانات المستخدم الخاصة بك.

في حال استيفاء أيٌّ من الشروط، يعني هذا أنّ المستخدم قد اشترك من قبل ويمكنك إصدار .

إذا لم يكن رقم تعريف حساب Google أو عنوان البريد الإلكتروني المحدّدين في التأكيد يطابق مستخدمًا في قاعدة البيانات الخاصة بك، لم يشترك المستخدم بعد. في هذه الحالة، يجب أن ترد نقطة نهاية تبادل الرمز المميز برسالة الخطأ HTTP 401 التي تحدد error=user_not_found، كما في المثال التالي:

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

{
  "error":"user_not_found",
}

عندما تتلقى Google استجابة الخطأ 401 مع الخطأ user_not_found، تطلب Google يستدعي نقطة نهاية تبادل الرمز المميز قيمة المعلمة intent يتم ضبطها على إنشاء وإرسال رمز مميّز للمعرّف يحتوي على معلومات الملف الشخصي للمستخدم. مع الطلب.

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:

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.

Note: The keys should not be hardcoded. Instead, follow OpenID connect discovery protocol and check the cache-control header to decide how long the key should be cached.

When decoded, the JWT assertion looks like the following example:

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

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com and that the audience (aud field) is the client ID assigned to your Action.

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":"[e-mail]"
}

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
}

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

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

ملاحظة: يجب استخدام أداة إنشاء الإجراءات لإنشاء إجراء ينفّذ ربط الحساب.

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

1. افتح مشروعك في Actions Builder في Actions Console.
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. اضبط كيفية سير العملية إذا وافق المستخدم على ربط حسابه. على سبيل المثال، يمكنك استدعاء Webhook لمعالجة أي منطق مخصّص للنشاط التجاري مطلوب والعودة إلى المشهد الأصلي.
3. انقر على حفظ.

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

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

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

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