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