مورد بيان Gmail

إعداد المورد الذي يتم استخدامه لتحديد محتوى إضافة Google Workspace والسلوك ضمن Gmail. يجب أن تحتوي بيانات إضافة Google Workspace على جميع المكوّنات التي تم وضع علامة مطلوبة عليها في حال توسيع Gmail.

Gmail

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

تمثيل JSON 
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
الحقول
authorizationCheckFunction

string

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

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

composeTrigger

object (ComposeTrigger)

مطلوب لإجراءات الإنشاء. تحدد مجموعة من واجهات المستخدم المتاحة للمستخدم أثناء إنشاء رسالة إلكترونية.

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

contextualTriggers[]

object (ContextualTrigger)

يجب ملء هذا الحقل. قائمة بالمشغلات التي يتم تنشيطها عند فتح رسالة في Gmail. عندما يتم تنشيط العامل المشغِّل، ينفّذ وظيفة "برمجة تطبيقات Google" معيّنة، ويتم ذلك عادةً لإنشاء بطاقات جديدة وتعديل واجهة المستخدِم.
homepageTrigger

object (HomepageTrigger)

مواصفات دالة التشغيل لإنشاء الصفحة الرئيسية للإضافة في مضيف Gmail. يؤدي هذا الإجراء إلى إلغاء addOns.common.homepageTrigger.

عامل تشغيل الإنشاء

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

تمثيل JSON 
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
الحقول
draftAccess

string

يحدد مستوى الوصول إلى البيانات المتاح لدالة مشغِّل الإنشاء. في ما يلي الخيارات الصالحة:

  • NONE، الإعداد التلقائي. ويؤدي ذلك إلى أن يكون كائن الحدث الذي تم تمريره إلى دالة مشغِّل الإنشاء فارغًا غالبًا.
  • METADATA، الذي يملأ كائن الحدث الذي تم تمريره إلى دالة مشغِّل الإنشاء مع قوائم مستلمي الرسالة. يتطلب هذا الإعداد أن تتضمّن الإضافة النطاق gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

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

عامل التشغيل السياقي

تهيئة المشغِّل الذي يتم تنشيطه عندما يفتح المستخدم رسالة Gmail وتلبي هذه الرسالة معايير معينة. راجع توسيع واجهة مستخدم الرسالة للحصول على مزيد من المعلومات.

تمثيل JSON 
{
  "onTriggerFunction": string,
  "unconditional": {},
}
الحقول
onTriggerFunction

string

مطلوبة لكل مشغّل سياقي تمثّل هذه السمة اسم دالة "برمجة تطبيقات Google" التي يتم تنفيذها عند تنشيط المشغِل.

اطّلِع على وظيفة مشغِّل المحتوى للحصول على تفاصيل حول كيفية تعريف هذه الدالة.

unconditional

object

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

الاختيار

إنّ إعدادات إجراء الإنشاء التي تحدّد الدالة المطلوب تشغيلها عندما يختار المستخدم إجراء الإنشاء.

تمثيل JSON 
{
  "runFunction": string,
  "text": string
}
الحقول
runFunction

string

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

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

text

string

مطلوب لإجراءات الإنشاء. أدخِل وصفًا نصيًا قصيرًا لإجراء الإنشاء هذا.