ربط الحساب من خلال الربط "سهل" لتسجيل الدخول إلى 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" العمليات الضمنية ورموز التفويض.

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

في مسار رمز التفويض، ستحتاج إلى نقطتَي نهاية:

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

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

ضبط المشروع

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

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.

Handle automatic linking

After the user gives your Action consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google account is already present in your authentication system, your token exchange endpoint returns a token for the user. If the Google account doesn't match an existing user, your token exchange endpoint returns a user_not_found error.

The request has the following form:

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

Your token exchange endpoint must be able to handle the following parameters:

Token endpoint parameters
grant_type	The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	For these requests, the value of this parameter is `get`.
assertion	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.
consent_code	Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
scope	Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should 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.

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": "jan@gmail.com", // 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.

Check if the Google account is already present in your authentication system

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, the user has already signed up and you can issue an access token.

If neither the Google Account ID nor the email address specified in the assertion matches a user in your database, the user hasn't signed up yet. In this case, your token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

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

{
  "error":"user_not_found",
}

When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

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.

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