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

عندما تريد إنشاء إضافة Google Workspace جديدة، اتّبِع هذا الإجراء العام:

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

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

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

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

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

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

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

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

مشاريع Google Cloud

وننصحك بإضافة متعاونين إلى مشروع Cloud للإضافة. يساعد ذلك في ضمان وصول شخص ما في فريقك دائمًا إلى إعدادات السحابة للإضافة.

لإنشاء مشروع على Google Cloud، يُرجى الاطّلاع على إنشاء مشروع على Google Cloud.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

طلب بناء

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

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

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

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

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

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

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

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

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

يُرجى الاطّلاع على النطاقات للحصول على مزيد من التفاصيل.

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

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

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

نشر الإضافة

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

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

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