عند إنشاء إضافة Google Workspace جديدة، يُرجى اتّباع الإجراء العام التالي:
- ابدأ إعداد مشاريع الإضافات واختَر المالك والمتعاونين معه.
- تصميم مظهر الإضافة وسلوكها
- قم بتهيئة بيان المشروع أو مورد النشر للإضافة.
- كتابة التعليمات البرمجية لتحديد مظهر الوظيفة الإضافية وسلوكها.
- تحقَّق من نطاقات OAuth الخاصة بإضافتك.
- اختبِر الإضافة ضمن تطبيقات المضيف التي تتضمّنها هذه الإضافة.
- انشر الإضافة.
إعداد مشاريع الإضافات واختيار المالك والمتعاونين
إذا أنشأت الإضافة في "برمجة تطبيقات Google"، ستنشئ مشروعًا لبرمجة التطبيقات ومشروعًا على Google Cloud. في حال إنشاء الإضافة بلغة غير "برمجة التطبيقات"، ستحتاج فقط إلى إنشاء مشروع على Google Cloud.
قبل البدء في تطوير الإضافات، اختَر حساب مستخدم فردي لامتلاك المشاريع وحدِّد الحسابات الأخرى للتعاون. يقوم مالك المشروعات بإنشاء وإدارة ملفات المشروع والإعدادات المرتبطة بها، بينما يمكن للمتعاونين المساعدة في الترميز والاختبار.
مشاريع برمجة التطبيقات
يمكنك إنشاء ملفات مشروع "برمجة تطبيقات Google" الخاصة بإضافتك في مساحة تخزين سحابي مشتركة كي لا يكون لأي حساب واحد الملكية الفردية. يضمن وضع ملف النص البرمجي للإضافة في مساحة تخزين سحابي مشتركة إمكانية وصول العديد من المتعاونين إلى مشروع النص البرمجي.
عند نشر إضافة، يعمل حساب مستخدم فرد كناشر. يجب أن يحصل حساب النشر على صلاحيات تعديل مشروع النص البرمجي، ولكن ليس من الضروري أن يكون المالك.
لإنشاء مشروع "برمجة تطبيقات Google"، يُرجى الاطّلاع على مشاريع النص البرمجي.
مشاريع Google Cloud
ننصحك بإضافة متعاونين إلى مشروع الإضافة على Cloud. يساعد هذا في ضمان وصول أي شخص في فريقك دائمًا إلى إعدادات Cloud الإضافية.
لإنشاء مشروع على Google Cloud، يُرجى الاطّلاع على مقالة إنشاء مشروع على Google Cloud.
تصميم مظهر الإضافة وسلوكها
حدد الشكل الذي تريد أن تبدو عليه الإضافة وكيف يجب أن تتصرف قبل البدء في إنشائها. ضع في اعتبارك حالات الاستخدام التي يجب أن تحاول الإضافة تقديم حلول لها. ابدأ بتصميم بسيط للعمل أولاً، ثم أضف المزيد من التحسينات.
راجِع دليل تصميم إضافة Google Workspace للحصول على إرشادات حول كيفية تصميم تجربة مستخدم الإضافات.
ضبط بيان مشروع الإضافة
في مشاريع "برمجة تطبيقات Google"، يكون بيان المشروع عبارة عن ملف JSON خاص. حيث تحدد مجموعة متنوعة من التفاصيل حول المشروع، مثل تبعيات المكتبة. بالنسبة إلى "إضافات Google Workspace"، يوفّر البيان أيضًا المعلومات الأساسية التي يحتاجها التطبيق المضيف لعرض الإضافة بشكل صحيح.
يمكنك الاطّلاع على البيانات للحصول على تفاصيل حول كيفية ضبط بيان الإضافة في "برمجة تطبيقات Google".
أثناء إضافة رمز وميزات إلى الإضافة، عدِّل البيان حسب الحاجة لإنتاج مظهر وسلوك الإضافة المطلوبَين.
ترميز الإضافة
يجب تنفيذ واجهة مستندة إلى البطاقة للإضافة. يمكنك استخدام خدمة البطاقات في "برمجة تطبيقات Google" أو إذا كنت تكتب بلغة رمز برمجي أخرى، يمكنك عرض رمز JSON بالتنسيق الصحيح للواجهة لعرضها كبطاقات.
عليك أيضًا تنفيذ أي دوال عامل تشغيل محدّدة في بيان الإضافة. وإذا كانت الإضافة تتصل بخدمة تابعة لجهة خارجية وغير تابعة لـ Google باستخدام بروتوكول OAuth، يجب ضبط OAuth لتلك الخدمة أيضًا.
إنشاء البطاقات
يمكنك تعريف واجهة مستخدم الإضافة من خلال إنشاء عناصر Card وملؤها بالأدوات. يجب أن تعرض وظائف التشغيل المحدّدة في
البيان عنصر Card واحدًا أو مصفوفة من
كائنات Card التي تمثّل "صفحات" مختلفة لواجهة الإضافة. وبإمكان الإضافة أيضًا إنشاء بطاقات جديدة وعرضها استجابةً لإجراءات المستخدم.
في "برمجة تطبيقات Google"، يمكنك إنشاء بطاقات باستخدام الفئة CardBuilder. وتتطلّب كل
بطاقة CardHeader
ورمز واحد أو أكثر
CardSections. يجب عليك تعبئة كل قسم في البطاقة بالأدوات الفردية التي تشكل واجهة الإضافة. عادةً ما تكون أدوات التفاعل مرتبطة بالإجراءات لتحديد سلوك التفاعل لديها.
بعد إضافة جميع الأقسام والتطبيقات المصغّرة إلى بطاقتك من خلال CardBuilder، عليك طلب CardBuilder.build() لإنشاء عنصر Card المقابل.
يمكنك استخدام خدمات برمجة تطبيقات مضمّنة أخرى، مثل CalendarApp، لاسترداد المعلومات لعرضها في البطاقات الإضافية التي تنشئها.
يمكنك استخدام البيانات التي تم استرجاعها من الخدمات غير التابعة لشركة Google.
إذا كانت إضافات Google Workspace تحتاج إلى الوصول إلى واجهات برمجة تطبيقات غير تابعة لـ Google والتي تتطلب بروتوكول OAuth، عليك إعداد تلك الخدمة والاتصال بها. راجِع دليل الاتصال بخدمات غير تابعة لـ Google للحصول على مزيد من التفاصيل.
أمر الإنشاء
عند إنشاء بطاقة، يجب إنشاؤها من الأعلى. أي، يجب عليك استخدام ترتيب البناء هذا:
- إنشاء التطبيق المصغّر.
- إضافة التطبيق المصغّر إلى قسم البطاقة
- كرِّر هذه الخطوات إلى أن يحتوي قسم البطاقة على جميع تطبيقاته المصغَّرة.
- أضِف قسم البطاقة إلى البطاقة.
هذا الإجراء مطلوب لأنّه عند إضافة تطبيق مصغّر إلى بطاقة أو قسم من البطاقات، تتم إضافة نسخة من هذا التطبيق المصغّر. أي تغييرات تجريها على كائن الأداة بعد إضافته لا تظهر في البطاقة النهائية.
الإجراءات العامة
يمكنك استخدام الإجراءات العامة لتوفير وظائف مستقلة عن السياق. الإجراءات العامة هي عناصر قائمة متوفرة في واجهة مستخدم الإضافة بغض النظر عن البطاقة التي يتم عرضها. تظهر جميع الإجراءات العامة المحددة دائمًا في قائمة البطاقة الإضافية.
يمكنك الاطّلاع على الإجراءات الشاملة لمزيد من التفاصيل.
التحقّق من نطاقات OAuth الإضافية
تحدد النطاقات الإجراءات المسموح للإضافة باتخاذها نيابةً عن المستخدم. من أفضل الممارسات أن يكون للإضافات نطاقات للإجراءات التي يجب أن تكون لها فقط من أجل وظائف الوظائف وليس أكثر من ذلك.
في مشاريع الإضافات، حدِّد النطاقات الإضافية بصراحة للتأكّد من أنّ الإضافة تستخدم مجموعة النطاقات الأقل منحًا للأذونات. ويمكنك تحديد النطاقات التي تستخدمها الإضافة في بيان الإضافة.
راجع النطاقات لمزيد من التفاصيل.
اختبار الإضافة
يمكنك اختبار الإضافات غير المنشورة من خلال تثبيت الإضافة غير المنشورة أولاً. بعد تثبيت الإضافة واعتمادها، يمكنك استخدامها في حسابك واختبار مظهرها وسلوكها في التطبيقات المضيفة التي تشملها هذه الإضافة. عليك التحقّق من أنّ الإضافة تعمل على النحو المتوقّع للسياقات وإجراءات المستخدم.
لمزيد من التفاصيل، يُرجى الاطّلاع على مقالة اختبار إضافات Google Workspace.
نشر الإضافة
يؤدي نشر إضافتك إلى جعلها متاحة للآخرين، إما بشكل علني أو للمستخدمين في نطاقك فقط. قبل بدء عملية النشر، احرص على مراجعة نظرة عامة على جهة النشر يُعد النشر عملية معقدة تتطلب التحضير والوقت لإكمالها.
يتم نشر إضافات Google Workspace على Google Workspace Marketplace. يجب على الإضافات المتاحة للجميع إكمال مراجعة التطبيق قبل نشرها.
راجِع نشر إضافة Google Workspace لمزيد من التفاصيل.