أفضل الممارسات

يمكنك تحسين تجربة المستخدمين بشكل عام من خلال اتّباع أدلة تصميم الإضافات التالية.

أفضل الممارسات العامة

ننصحك باتّباع أفضل الممارسات التالية لجميع الإضافات التي تطوّرها.

تحديد ملكية الإضافة قبل البدء

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

توسيع نطاق Google Workspace، وليس تكراره

تهدف الإضافات إلى توفير إمكانات جديدة لتطبيقات Google Workspace التي توسّعها، أو إلى تشغيل المهام المعقّدة آليًا. من غير المرجّح أن تجتاز الإضافات مراجعة الإضافات للنشر إذا كانت تكرّر ببساطة وظائف متوفّرة في التطبيق أو إذا لم تُحدث تحسينات كبيرة في سير العمل.

الحفاظ على نطاق الأذونات محدودًا

عند تحديد نطاقاتك بشكل صريح، اختَر دائمًا مجموعة النطاقات الأقل تساهلاً الممكنة. على سبيل المثال، لا تطلب من الإضافة الحصول على إذن بالوصول الكامل إلى تقويم المستخدم باستخدام النطاق https://www.googleapis.com/auth/calendar إذا كانت تحتاج إلى إذن بالقراءة فقط. للحصول على إذن بالقراءة فقط، استخدِم النطاق https://www.googleapis.com/auth/calendar.readonly.

تجنُّب الاعتماد بشكل كبير على المكتبات

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

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

أفضل الممارسات المتعلّقة بإضافة المحرّر

تنطبق أفضل الممارسات التالية على إضافة "المحرّر" فقط.

وضع HTML الخاص بالواجهة وJavaScript من جهة العميل في ملفات نصوص برمجية منفصلة

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

الاختبار بدقة في أوضاع ترخيص مختلفة

عند اختبار الإضافة، احرص على تجربة الإعدادات التي تتضمّن ملفات مختلفة وحالات ترخيص مختلفة.