إنشاء إضافات Google Workspace

تقدّم هذه الصفحة نظرة عامة حول كيفية تصميم "إضافات Google Workspace" وإنشائها ونشرها. توضّح هذه النظرة العامة الخطوات التالية:

  1. حدِّد تطبيقات Google Workspace التي تريد إتاحة الإضافة للمستخدمين عليها.
  2. إعداد مشاريع الإضافة واختيار مالك ومتعاونين
  3. تصميم مظهر الإضافة وسلوكها
  4. قم بتهيئة بيان مشروع الإضافة أو مورد النشر.
  5. اكتب رمزًا لتحديد مظهر الإضافة وسلوكها.
  6. تحقَّق من نطاقات OAuth الخاصة بإضافتك.
  7. اختبِر الإضافة في تطبيق واحد أو أكثر من تطبيقات Google Workspace.
  8. انشر الإضافة.

اختيار تطبيقات مضيفة في Google Workspace

يمكنك ضبط إضافات Google Workspace لتظهر في التطبيقات التالية المضيفة في Google Workspace:

  • Gmail
  • تقويم Google
  • مستندات Google
  • Google Drive
  • جداول بيانات Google
  • العروض التقديمية من Google

للتعرّف على طريقة إنشاء تطبيقات Google Workspace، يُرجى الاطّلاع على مقالة توسيع واجهة مستخدم Google Workspace.

إعداد مشاريع الإضافة واختيار مالك ومتعاونين

إذا أنشأت الإضافة في Apps Script، ستُنشئ مشروع Apps Script ومشروع Google Cloud. في حال إنشاء الإضافة بلغة غير "برمجة التطبيقات"، ستحتاج فقط إلى إنشاء مشروع على Google Cloud.

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

مشاريع "برمجة تطبيقات Google"

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

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

لإنشاء مشروع "برمجة تطبيقات Google"، يُرجى الاطّلاع على مشاريع النص البرمجي.

مشاريع Google Cloud

ننصحك بإضافة متعاونين إلى مشروع الإضافة في سحابة Google. يساعد ذلك في ضمان إمكانية وصول أحد أفراد فريقك في أي وقت إلى إعدادات "سحابة Google" في الإضافة.

لإنشاء مشروع على Google Cloud، اطّلِع على مقالة إنشاء مشروع على Google Cloud.

تصميم مظهر الإضافة وسلوكها

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

راجِع دليل تنسيق إضافات Google Workspace للاطّلاع على إرشادات حول كيفية تصميم تجربت مستخدمي الإضافة.

ضبط بيان مشروع الإضافة

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

يمكنك الاطّلاع على ملفات البيانات للحصول على تفاصيل حول كيفية ضبط بيان الإضافة في "برمجة تطبيقات Google".

أثناء إضافة الرموز البرمجية والميزات إلى الإضافة، عدِّل البيان حسب الحاجة لإنشاء المظهر والسلوك المطلوبَين للإضافة.

ترميز الإضافة

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

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

بطاقات الإنشاء

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

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

بعد إضافة جميع الأقسام والتطبيقات المصغّرة إلى بطاقتك من خلال CardBuilder، عليك استدعاء CardBuilder.build() لإنشاء عنصر Card المقابل.

يمكنك استخدام خدمات Apps Script المضمّنة الأخرى، مثل CalendarApp لاسترداد المعلومات لعرضها في البطاقات الإضافية التي تنشئها. يمكنك استخدام البيانات التي يتم جلبها من خدمات غير تابعة لشركة Google.

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

أمر الإنشاء

عند إنشاء بطاقة، يجب البدء من أعلى الصفحة. وهذا يعني أنّه عليك استخدام أسلوب الإنشاء التالي:

  1. أنشئ التطبيق المصغّر.
  2. إضافة التطبيق المصغّر إلى قسم البطاقة
  3. كرِّر هذه الخطوة إلى أن يتضمّن قسم البطاقة جميع التطبيقات المصغّرة.
  4. أضِف قسم البطاقة إلى البطاقة.

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

الإجراءات العامة

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

اطّلِع على الإجراءات الشاملة للحصول على مزيد من التفاصيل.

التحقّق من نطاقات OAuth الإضافية

تحدِّد النطاقات الإجراءات التي يُسمح للإضافة باتخاذها نيابةً عن المستخدم. من أفضل الممارسات أن يكون للإضافات نطاقات للإجراءات التي يجب أن تعمل بها فقط وليس أكثر من ذلك.

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

اطّلِع على النطاقات لمزيد من التفاصيل.

اختبار الإضافة

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

لمزيد من التفاصيل، يُرجى الاطّلاع على مقالة اختبار إضافات Google Workspace.

نشر الإضافة

يؤدي نشر إضافتك إلى جعلها متاحة للآخرين، إما بشكل علني أو للمستخدمين في نطاقك فقط. قبل بدء عملية النشر، يُرجى مراجعة نظرة عامة على النشر. يُعد النشر عملية معقدة تتطلب التحضير والوقت لإكمالها.

يتم نشر إضافات Google Workspace في Google Workspace Marketplace. يجب على الإضافات المتاحة للجميع إكمال مراجعة التطبيق قبل نشرها.

اطّلِع على مقالة نشر إضافة Google Workspace للحصول على مزيد من التفاصيل.