Package google.apps.script.type.gmail

الفهرس

ComposeTrigger

عامل تشغيل يتم تفعيله عندما يُنشئ المستخدم رسالة إلكترونية.

الحقول
actions[]

MenuItemExtensionPoint

تحدِّد مجموعة الإجراءات لإضافة وقت الإنشاء. هذه هي الإجراءات التي يمكن للمستخدمين تفعيلها في إضافة وقت الإنشاء.

draftAccess

DraftAccess

يحدِّد مستوى الوصول إلى البيانات عند بدء إحدى الإضافات الخاصة بوقت الكتابة.

DraftAccess

تعداد يحدد مستوى الوصول إلى البيانات الذي يتطلبه مشغل الإنشاء.

عمليات التعداد
UNSPECIFIED القيمة التلقائية عند عدم ضبط أيّ قيمة لـ draftAccess
NONE لا يمكن لعامل تشغيل الإنشاء الوصول إلى أي بيانات من المسودة عند بدء إحدى الإضافات الخاصة بالإنشاء.
METADATA يمنح عامل تشغيل الإنشاء الإذن بالوصول إلى البيانات الوصفية للمسودة عند تشغيل إضافة إنشاء. يشمل ذلك قائمة المستخدمين، مثل قائمة "إلى" و"نسخة إلى" لمسودة رسالة.

ContextualTrigger

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

الحقول
onTriggerFunction

string

مطلوب. اسم نقطة النهاية المطلوب الاتصال بها عندما تتطابق رسالة مع عامل التفعيل.

حقل الربط trigger يحدِّد نوع عامل التفعيل الشروط التي يستخدمها Gmail لعرض الإضافة. يمكن أن يكون trigger واحدًا فقط مما يلي:
unconditional

UnconditionalTrigger

يتم تنفيذ عوامل التفعيل غير المشروطة عند فتح أي رسالة بريد إلكتروني.

GmailAddOnManifest

المواقع التي تُخصِّص مظهر إضافة Gmail وتنفيذها.

الحقول
homepageTrigger

HomepageExtensionPoint

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

وفي حال توفّره، سيؤدي ذلك إلى إلغاء الإعدادات من addOns.common.homepageTrigger.

contextualTriggers[]

ContextualTrigger

يتم تحديد مجموعة الشروط التي تؤدي إلى تشغيل الإضافة.

universalActions[]

UniversalAction

تُحدِّد مجموعة من الإجراءات العامة للإضافة. يشغّل المستخدم الإجراءات الشاملة من قائمة شريط أدوات الإضافة.

composeTrigger

ComposeTrigger

يحدِّد عامل التفعيل الخاص بوقت إنشاء الرسالة لإضافة وقت إنشاء الرسالة. هذا هو العامل المشغِّل الذي يدفع الإضافة إلى اتّخاذ إجراء عندما يُنشئ المستخدم رسالة إلكترونية. يجب أن يكون لكل الإضافات في وقت الكتابة نطاق gmail.addons.current.action.compose حتى لو لم تكن قابلة لتعديل المسودة.

authorizationCheckFunction

string

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

UnconditionalTrigger

لا يحتوي هذا النوع على أي حقول.

عامل تشغيل يتم تفعيله عند فتح أي رسالة إلكترونية.

UniversalAction

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

الحقول
text

string

مطلوب. نص مرئي للمستخدم يصف الإجراء، على سبيل المثال، "إضافة جهة اتصال جديدة".

حقل الاتحاد action_type. يحدِّد نوع الإجراء سلوك Gmail عندما ينفّذ المستخدم الإجراء. يمكن أن يكون action_type واحدًا فقط مما يلي:
runFunction

string

نقطة نهاية يتم طلبها عندما يشغّل المستخدم الإجراء. اطّلِع على دليل الإجراءات العامة للاطّلاع على التفاصيل.