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

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

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

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

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

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

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

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

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

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

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

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

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

أفضل الممارسات المتعلقة بإضافات Google Workspace

تنطبق أفضل الممارسات التالية فقط على إضافات Google Workspace واستخدامها لخدمة البطاقات

استخدام بضع بطاقات فقط

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

تجنَّب الدافع لإنشاء عدد أكبر من البطاقات.

استخدام وظائف إنشاء التطبيقات المصغّرة

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

إبقاء البطاقات بسيطة

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

استخدام بطاقات الخطأ

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

كتابة الاختبارات والرسائل التجريبية

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

عند استخدام دوال معاودة الاتصال للإجراءات، يجب عليك عادةً إنشاء كائن استجابة. يمكنك استخدام عبارات مثل ما يلي للتحقق من إنشاء الردود بشكل صحيح:

    Logger.log(response.printJson());

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

استخدِم بيانات الاختبار المناسبة لكل تطبيق مضيف توسِّع الإضافة الإضافة. بالنسبة على سبيل المثال، إذا كانت الإضافة توسِّع نطاق Gmail، من المحتمل أن تحتاج إلى بعض الرسائل الإلكترونية التجريبية ومعرّفات الرسائل الخاصة بهم لكي تتأكد من أن الإضافة تعمل كان متوقعًا عند تقديم محتوى مختلف للرسالة. يمكنك الحصول على معرّف الرسالة الرسالة المحددة عن طريق سرد الرسائل باستخدام User.messages.list في واجهة برمجة التطبيقات Gmail أو من خلال استخدام نماذج خدمة Gmail:

أفضل ممارسات مكالمات الفيديو في "تقويم Google"

إذا كانت الإضافة تتضمّن محتوى تابعًا لجهة خارجية اجتماع في "تقويم Google" الخيارات في "تقويم Google"، اتّبِع أفضل الممارسات الإضافية التالية:

إبقاء مصباح onCreateFunction

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

استخدام حقول ConferenceData المناسبة لبيانات مكالمة الفيديو

عند إنشاء ConferenceData فيمكنك تعبئتها بتفاصيل حول المؤتمر (الوصول إلى والرموز وأرقام الهواتف وأرقام التعريف الشخصي وأرقام تعريف الموارد المنتظمة، وما إلى ذلك). تأكد من استخدام العلامة حقل EntryPoint للحصول على هذه المعلومات. لا تضع هذه التفاصيل في ConferenceData الملاحظات.

عدم إلحاق تفاصيل مكالمات الفيديو بحدث "تقويم Google"

لا تحتاج إضافتك إلى إضافة معلومات حول الجهة الخارجية التي تم إنشاؤها. مكالمات الفيديو إلى وصف حدث "تقويم Google". ما يفعله "تقويم Google" هذا تلقائيًا عند الضرورة.