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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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