ضبط OAuth

عند نشر تطبيقك، هناك 4 مهام رئيسية يجب إكمالها للمصادقة والترخيص:

  1. ملء شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
  2. أنشئ بيانات اعتماد OAuth 2.0.
  3. ضبط جميع النطاقات التي يحتاج التطبيق إلى تشغيلها في حزمة تطوير البرامج (SDK) الخاصة بـ Google Workspace Marketplace
  4. أرسِل تطبيقك للتحقّق من OAuth.

يجب أن تتطابق النطاقات التي تضيفها إلى كل مكان ويتم استخدامها بالطرق التالية:

  • تُستخدم النطاقات المُضافة إلى شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth في عملية التحقّق من بروتوكول OAuth.
  • يتم استخدام النطاقات المُضافة إلى حزمة تطوير البرامج (SDK) في Google Workspace Marketplace لعمليات التثبيت الفردية على مستوى النطاق وعمليات التثبيت الفردية للسماح بتطبيقك عند تثبيته من Google Workspace Marketplace.
  • النطاقات التي تتم إضافتها إلى البيان ضرورية حتى يعمل التطبيق بشكلٍ صحيح.

على سبيل المثال، إذا نشرت تطبيقًا يتضمّن إحدى الإضافات لـ "جداول بيانات Google" وإضافة لمستندات Google، سيتضمن بيان "برمجة تطبيقات Google" في كل إضافة النطاقات الخاصة بالإضافة فقط. في مشروعك على Google Cloud، تتضمّن شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth وحزمة تطوير البرامج (SDK) لـ Google Workspace Marketplace نطاقات كلتا الإضافتَين.

المتطلبات الأساسية

شاشة موافقة OAuth هي عبارة عن طلب تخبر المستخدمين الذين يطلبون الوصول إلى بياناتهم ونوع البيانات التي يسمح المستخدمون لتطبيقك بالوصول إليها.

  1. في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات والخدمات > شاشة موافقة OAuth.

    الانتقال إلى شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

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

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

    • اختَر النطاقات التي توفّر الحد الأدنى من مستوى الوصول الذي يتطلبه تطبيقك. للحصول على قائمة بالنطاقات المتاحة، يُرجى الاطّلاع على نطاقات OAuth 2.0 لواجهات Google APIs.
    • راجِع النطاقات المدرَجة في كل قسم من الأقسام الثلاثة: النطاقات غير الحساسة، والنطاقات الحساسة، والنطاقات المحظورة. بالنسبة إلى أي نطاقات مدرَجة في قسم "النطاقات الحساسة" أو "النطاقات المحظورة"، حاوِل تحديد نطاقات بديلة غير حسّاسة لتجنُّب المراجعات الإضافية غير الضرورية.
    • تتطلّب بعض النطاقات مراجعات إضافية من قِبل Google. بالنسبة إلى التطبيقات التي تستخدمها مؤسستك في Google Workspace فقط، لا تُدرَج النطاقات في شاشة الموافقة، ولا يتطلب استخدام النطاقات المحدودة أو الحسّاسة مراجعة إضافية من قِبل Google. لمزيد من المعلومات، راجِع فئات النطاق.
  5. بعد اختيار النطاقات التي يتطلبها تطبيقك، انقر على حفظ ومتابعة.
  6. إذا اخترت خارجي لنوع المستخدم، أضِف مستخدمي المختبِرين:
    1. ضمن المستخدمون التجريبيون، انقر على إضافة مستخدمين.
    2. أدخِل عنوان بريدك الإلكتروني وأي مستخدمين مختبِرين معتمَدين آخرين، ثم انقر على حفظ ومتابعة.
  7. مراجعة ملخص تسجيل التطبيق لإجراء تغييرات، انقر على تعديل. إذا كان تسجيل التطبيق يبدو جيدًا، انقر على الرجوع إلى لوحة البيانات.

2- إنشاء بيانات اعتماد OAuth 2.0

بناءً على كيفية إنشاء تطبيقك، هناك طريقتان مختلفتان لإنشاء بيانات اعتماد OAuth 2.0.

في حال إنشاء تطبيقك باستخدام لغة "برمجة تطبيقات Google"

بدِّل مشروع "برمجة التطبيقات" من المشروع التلقائي على Google Cloud إلى مشروعك العادي الجديد. يُرجى الاطّلاع على التبديل إلى مشروع عادي مختلف.

بعد ربط مشروع "برمجة تطبيقات Google" بمشروع Google Cloud، يتم إنشاء بيانات اعتماد OAuth 2.0 تلقائيًا.

في حال عدم استخدام لغة "برمجة تطبيقات Google" لإنشاء تطبيقك

لإنشاء بيانات اعتماد OAuth 2.0، يمكنك الاطّلاع على بيانات اعتماد معرِّف عميل OAuth.

3- ضبط النطاقات

قدِّم قائمة كاملة بنطاقات OAuth التي يتطلبها تطبيقك. استخدم دائمًا أضيق النطاقات الممكنة.

لتحديد مستوى الوصول الممنوح لتطبيقك، عليك تحديد نطاقات التفويض وتوضيحها. نطاق التفويض هو سلسلة معرّف موارد منتظم (URI) لـ OAuth 2.0 تحتوي على اسم تطبيق Google Workspace ونوع البيانات التي يصل إليها ومستوى الوصول. النطاقات هي طلبات تطبيقك للعمل مع بيانات Google Workspace، بما في ذلك بيانات حسابات المستخدمين على Google.

عند تثبيت تطبيقك، يُطلب من المستخدم التحقّق من صحة النطاقات التي يستخدمها التطبيق. وبصفة عامة، عليك اختيار نطاق التطبيق الأكثر تركيزًا وتجنُّب طلب النطاقات التي لا يتطلبها تطبيقك. يمنح المستخدمون بسهولة الوصول نطاقات محدودة موصوفة بوضوح.

4. الإرسال للتحقق من OAuth (التطبيقات المتاحة للجميع فقط)

إذا كان التطبيق العام يستخدم نطاقات حساسة أو مشروطة، يجب أن يخضع لعملية مراجعة التحقّق من خلال OAuth.

  • للتحقق من بروتوكول OAuth، يجب إرسال فيديو توضيحي يوضح الرحلة أو التدفق يوضح استخدام النطاقات أو البيانات المطلوبة للمستخدمين.
  • وإذا كان تطبيقك يستخدم نطاقات مقيّدة، قد يحتاج أيضًا إلى الخضوع لتقييم أمان. يمكنك الاطّلاع على لماذا يجب تقييم الأمان.

لإرسال طلب لإثبات الهوية، يُرجى اتّباع الخطوات التالية:

  1. في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات والخدمات > شاشة موافقة OAuth.

    الانتقال إلى شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

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

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

أوجه الاختلاف بين عملية التحقّق من OAuth ومراجعة التطبيق

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

تركّز مراجعة التطبيقات على المعلومات التي تقدّمها في Google Workspace Marketplace API وعلى وظائف تطبيقك وسهولة استخدامه. لمزيد من المعلومات حول معايير مراجعة التطبيقات، يمكنك الاطّلاع على لمحة عن مراجعة التطبيق.