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

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

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

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

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

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

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

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

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

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

مشاريع Google Cloud

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

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

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

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

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

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

يمكنك الاطّلاع على البيان للحصول على تفاصيل حول كيفية ضبط بيان الإضافة&#99، في برمجة التطبيقات.

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

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

يجب تنفيذ واجهة مستندة إلى البطاقة للإضافة. استخدِم خدمة البطاقة في "برمجة تطبيقات Google" أو إذا كنت تكتب بلغة أخرى، اعرض رمز 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 النشرة للحصول على مزيد من التفاصيل.

Google Workspace مثال على الإضافة

 l10n-placeholder41=

لمساعدتك في فهم كيفية Google Workspace إنشاء الإضافات، توضّح Google Workspace "Cats" add-onquickstart كيفية إنشاء ميزة Google Workspace بسيطة، بما في ذلك عمليات التواصل مع الصفحة الرئيسية واتصال البطاقة. بعد "البدء السريع"، يمكنك تثبيت الإضافة وتجربة الرمز.