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

يمكنك تحسين تجربة المستخدمين الإجمالية من خلال اتّباع هذه الأدلة المتعلّقة بتصميم التطبيقات الملحقة.

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

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

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

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

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

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

إبقاء النطاقات ضيّقة

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

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

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

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

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

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

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

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

إجراء اختبار شامل في أوضاع التفويض المختلفة

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