ربط الحساب باستخدام بروتوكول OAuth

يدعم نوع ربط OAuth تدفقين من تدفقات OAuth 2.0 المتوافقة مع المعيار المتّبع في المجال، وهما تدفقات الرموز الضمنية والتفويض.

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

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

ضبط المشروع

لضبط مشروعك على استخدام ربط OAuth، اتّبِع الخطوات التالية:

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

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

   

6. في معلومات العميل:

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

ملاحظة: إذا كنت تريد إرسال معرِّف العميل الخاص بك كسلسلة Base64 مرمّزة، انقر على سهم القائمة المنسدلة بجانب Configure your client (اختياري) وضَع علامة في المربّع Google لنقل clientID والرمز السري عبر عنوان مصادقة HTTP الأساسي.

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

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

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

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

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

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

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