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

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

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

نشجعك على اتباع أفضل الممارسات التالية لجميع الإضافات التي تقوم بتطويرها.

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

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

توسيع نطاق Google Workspace وعدم تكراره

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

تضييق النطاقات

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

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

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

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

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

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

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

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

الاختبار جيدًا في أوضاع التفويض المختلفة

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