يمكنك تحسين التجربة العامة للمستخدمين من خلال اتّباع هذه الأدلة لتصميم الإضافات.
أفضل الممارسات العامة
ننصحك باتّباع أفضل الممارسات التالية لجميع الإضافات التي تطوّرها.
تحديد ملكية الإضافة قبل البدء
يتم تحديد الإضافات من خلال مشاريع "برمجة التطبيقات"، والتي يجب أن يملكها حساب معيّن أو يتم وضعها في مساحة تخزين سحابي مشتركة. قبل كتابة رمز الإضافة، حدِّد الحساب الذي يجب أن يملك المشروع والحساب الذي يعمل كناشر له. حدِّد أيضًا الحسابات التي ستعمل كمساهمين، وتأكَّد من أنّ هذه الحسابات يمكنها الوصول إلى مشروع النص البرمجي والمشروع المرتبط به على Google Cloud.
توسيع نطاق Google Workspace وليس تكراره
تهدف الإضافات إلى توفير إمكانات جديدة لتطبيقات Google Workspace التي توسّع نطاقها، أو أتمتة المهام المعقّدة. من غير المرجّح أن تجتاز الإضافات التي تكرّر ببساطة الوظائف المتوفّرة حاليًا في التطبيق أو التي لا تُجري تحسينات كبيرة على سير العمل مراجعة الإضافة للنشر.
الحفاظ على النطاقات ضيقة
عند تحديد نطاقاتك
بشكلٍ صريح، اختَر دائمًا مجموعة النطاقات
الأقل تساهلاً الممكنة. على سبيل المثال، لا تطلب إضافتك الوصول الكامل إلى "تقويم" المستخدم باستخدام النطاق https://www.googleapis.com/auth/calendar إذا كانت تحتاج فقط إلى إذن بالقراءة. للحصول على إذن بالقراءة فقط، استخدِم النطاق https://www.googleapis.com/auth/calendar.readonly.
تجنُّب الاعتماد بشكلٍ كبير على المكتبات
يمكن أن يؤدي استخدام مكتبات "برمجة التطبيقات" إلى تشغيل إضافتك ببطء أكبر مما لو كان كل رمز "برمجة التطبيقات" مضمّنًا في مشروع نص برمجي واحد. على الرغم من أنّ مكتبات "برمجة التطبيقات" تعمل في الإضافات، قد تواجه انخفاضًا في الأداء إذا استخدمتها. تجنَّب تضمين مكتبات غير ضرورية في مشروعك، وفكِّر في طرق لتقليل اعتماد إضافتك عليها.
لا ينطبق وقت الاستجابة الموضّح أعلاه إلا على مشاريع "برمجة التطبيقات" التي يتم استخدامها كمكتبات من جهة الخادم. يمكنك استخدام مكتبات JavaScript من جهة العميل، مثل jQuery، بحرية بدون مواجهة وقت الاستجابة هذا.
أفضل الممارسات لإضافات المحرّر
لا تنطبق أفضل الممارسات التالية إلا على إضافات المحرّر.
وضع واجهة HTML وJavaScript من جهة العميل في ملفات النصوص البرمجية الخاصة بها
يمكنك إنشاء ملفات نصوص برمجية متعددة في مشروع "برمجة التطبيقات". من الأسهل إدارة إضافة معقّدة إذا وضعت ملفات HTML وJavaScript التي تحدّد الأشرطة الجانبية ومربّعات الحوار الخاصة بالإضافة في ملفات نصوص برمجية مخصّصة لها.
إجراء اختبار شامل في أوضاع التفويض المختلفة
عند اختبار إضافتك، احرص على تجربة الإعدادات التي تتضمّن ملفات مختلفة وحالات تفويض مختلفة للإذن.