Package google.apps.script.type

الفهرس

• AddOnWidgetSet (رسالة)
• AddOnWidgetSet.WidgetType (تعداد)
• CommonAddOnManifest (رسالة)
• CreateActionExtensionPoint (رسالة)
• GranularOauthPermissionSupport (تعداد)
• HomepageExtensionPoint (رسالة)
• HttpAuthorizationHeader (تعداد)
• HttpOptions (رسالة)
• LayoutProperties (رسالة)
• LinkPreviewExtensionPoint (رسالة)
• MenuItemExtensionPoint (رسالة)
• UniversalActionExtensionPoint (رسالة)
• UriPattern (رسالة)

AddOnWidgetSet

مجموعة التطبيقات المصغّرة التي تستخدمها إحدى الإضافات

الحقول
usedWidgets[]	WidgetType قائمة الأدوات المستخدَمة في إضافة

WidgetType

تمثّل هذه السمة نوع التطبيق المصغَّر. WIDGET_TYPE_UNSPECIFIED هي مجموعة التطبيقات المصغّرة الأساسية.

عمليات التعداد
WIDGET_TYPE_UNSPECIFIED	مجموعة الأدوات التلقائية
DATE_PICKER	أداة اختيار التاريخ
STYLED_BUTTONS	تتضمّن الأزرار ذات الأنماط أزرارًا معبّأة وأزرارًا غير مفعّلة.
PERSISTENT_FORMS	تسمح النماذج الثابتة بالاحتفاظ بقيم النموذج أثناء تنفيذ الإجراءات.
FIXED_FOOTER	تذييل ثابت في بطاقة
UPDATE_SUBJECT_AND_RECIPIENTS	تعديل موضوع مسودة الرسالة ومستلميها
GRID_WIDGET	التطبيق المصغّر للشبكة
ADDON_COMPOSE_UI_ACTION	إجراء إضافة في Gmail ينطبق على واجهة مستخدم الإنشاء الخاصة بالإضافة

CommonAddOnManifest

إعدادات الإضافة التي تتم مشاركتها بين جميع التطبيقات المضيفة للإضافة

الحقول
name	string الحقل مطلوب. الاسم المعروض للإضافة.
logoUrl	string الحقل مطلوب. عنوان URL لصورة الشعار المعروضة في شريط أدوات الإضافة
layoutProperties	LayoutProperties خصائص التنسيق الشائعة لبطاقات الإضافة
addOnWidgetSet	AddOnWidgetSet تمثّل هذه السمة التطبيقات المصغّرة المستخدَمة في الإضافة. في حال عدم تحديد هذا الحقل، يتم استخدام المجموعة التلقائية.
useLocaleFromApp	bool تحديد ما إذا كان سيتم نقل معلومات اللغة من التطبيق المضيف
homepageTrigger	HomepageExtensionPoint تحدّد نقطة نهاية سيتم تنفيذها في أي سياق، وفي أي مضيف. ستكون أي بطاقات يتم إنشاؤها بواسطة هذه الدالة متاحة دائمًا للمستخدم، ولكن قد يتم حجبها بواسطة المحتوى السياقي عندما تعلن هذه الإضافة عن مشغّلات أكثر استهدافًا.
universalActions[]	UniversalActionExtensionPoint تحدّد هذه السمة قائمة بنقاط الإضافة في قائمة الإجراءات العامة التي تعمل كقائمة إعدادات للإضافة. يمكن أن تكون نقطة الإضافة عبارة عن عنوان URL لرابط سيتم فتحه أو نقطة نهاية سيتم تنفيذها كعملية إرسال نموذج.
openLinkUrlPrefixes	ListValue لا يمكن أن يستخدم إجراء OpenLink إلا عنوان URL يتضمّن المخطط HTTPS أو MAILTO أو TEL. بالنسبة إلى روابط HTTPS، يجب أن يتطابق عنوان URL أيضًا مع إحدى البادئات المحدّدة في القائمة المسموح بها. إذا لم تتضمّن البادئة المخطط، يتم افتراض القيمة HTTPS. تتم إعادة كتابة روابط HTTP تلقائيًا لتصبح روابط HTTPS.

CreateActionExtensionPoint

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

الحقول
id	string الحقل مطلوب. المعرّف الفريد لتمييز نقطة الإضافة هذه. يمكن أن يتضمّن المعرّف 64 حرفًا كحدّ أقصى ويجب أن يكون بالتنسيق [a-zA-Z0-9-]+.
labelText	string الحقل مطلوب. النص الذي يظهر بجانب رمز نقطة دخول إنشاء المورد، مثل Create support case هذا النص ثابت ويظهر قبل أن ينفّذ المستخدمون الإضافة.
localizedLabelText	map<string, string> اختيارية: خريطة labelText لتتم ترجمتها إلى لغات أخرى يجب تنسيق اللغة وفقًا لمعيار ISO 639 والبلد أو المنطقة وفقًا لمعيار ISO 3166، مع الفصل بينهما بشرطة -. على سبيل المثال، en-US. إذا كانت لغة المستخدم متوفرة في مفاتيح الخريطة، سيظهر للمستخدم الإصدار المترجَم من labelText.
runFunction	string الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند بدء سير عمل إنشاء الموارد لإنشاء رابط
logoUrl	string اختيارية: رمز نقطة دخول إنشاء المرجع في حال عدم تضمينها، تستخدم القائمة رمز شريط أدوات الإضافة، logoUrl.

GranularOauthPermissionSupport

تُستخدَم لتحديد ما إذا كانت الإضافة قد فعّلت ميزة "الموافقة الدقيقة على OAuth".

عمليات التعداد
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED	القيمة التلقائية، ويجب عدم استخدامها.
OPT_IN	تم تفعيل ميزة "الموافقة الدقيقة على OAuth" للإضافة.
OPT_OUT	تم إيقاف ميزة "الموافقة الدقيقة على OAuth" في الإضافة.

HomepageExtensionPoint

تنسيق شائع لتحديد طريقة عرض الصفحة الرئيسية للإضافة

الحقول
runFunction	string الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.
enabled	BoolValue اختيارية: إذا تم ضبطها على false، سيتم إيقاف عرض الصفحة الرئيسية في هذا السياق. يتم ضبط القيمة تلقائيًا على true في حال عدم ضبطها. في حال إيقاف عرض الصفحة الرئيسية المخصّص لإحدى الإضافات، يتم توفير بطاقة عامة للمستخدمين بدلاً من ذلك.

HttpAuthorizationHeader

عنوان التفويض الذي تم إرساله في طلبات الإضافة HTTP

عمليات التعداد
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED	القيمة التلقائية، وهي تعادل SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN	إرسال رمز مميّز للمعرّف لحساب خدمة النظام الخاص بإضافة Google Workspace الخاصة بالمشروع (الإعداد التلقائي)
USER_ID_TOKEN	أرسِل رمزًا مميّزًا للمعرّف خاصًا بالمستخدم النهائي.
NONE	لا ترسِل عنوان مصادقة.

HttpOptions

خيارات لإرسال طلبات إلى نقاط نهاية إضافة HTTP

الحقول
authorizationHeader	HttpAuthorizationHeader إعدادات الرمز المميز المُرسَل في عنوان التفويض HTTP
granularOauthPermissionSupport	GranularOauthPermissionSupport تُستخدَم لتحديد ما إذا كانت الإضافة قد فعّلت ميزة "الموافقة الدقيقة على OAuth".

LayoutProperties

خصائص تصميم البطاقة المشترَكة بين جميع تطبيقات المضيف الخاصة بالإضافات

الحقول
primaryColor	string اللون الأساسي للإضافة يضبط لون شريط الأدوات. إذا لم يتم ضبط لون أساسي، سيتم استخدام القيمة التلقائية التي يوفّرها إطار العمل.
secondaryColor	string اللون الثانوي للإضافة تضبط هذه السمة لون الأزرار. إذا تم ضبط اللون الأساسي ولكن لم يتم ضبط أي لون ثانوي، سيكون اللون الثانوي هو نفسه اللون الأساسي. إذا لم يتم ضبط اللون الأساسي أو اللون الثانوي، سيتم استخدام القيمة التلقائية التي يوفّرها إطار العمل.
useNewMaterialDesign (deprecated)	bool تم إيقاف هذا العنصر نهائيًا. تفعيل تصميمات متعددة الأبعاد للبطاقات

LinkPreviewExtensionPoint

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

الحقول
labelText	string الحقل مطلوب. نص لشريحة ذكية نموذجية تحث المستخدمين على معاينة الرابط، مثل Example: Support case هذا النص ثابت ويظهر قبل أن ينفّذ المستخدمون الإضافة.
localizedLabelText	map<string, string> اختيارية: خريطة labelText لتتم ترجمتها إلى لغات أخرى يجب تنسيق اللغة وفقًا لمعيار ISO 639 والبلد أو المنطقة وفقًا لمعيار ISO 3166، مع الفصل بينهما بشرطة -. على سبيل المثال، en-US. إذا كانت لغة المستخدم متوفرة في مفاتيح الخريطة، سيظهر للمستخدم الإصدار المترجَم من labelText.
patterns[]	UriPattern الحقل مطلوب. مجموعة من أنماط عناوين URL التي تؤدي إلى تشغيل الإضافة لمعاينة الروابط
runFunction	string الحقل مطلوب. نقطة نهاية يتم تنفيذها عند تشغيل معاينة رابط.
logoUrl	string اختيارية: الرمز الذي يظهر في الشريحة الذكية وبطاقة المعاينة في حال عدم توفّره، تستخدم الإضافة رمز شريط الأدوات logoUrl.

MenuItemExtensionPoint

تنسيق شائع لتعريف عنصر قائمة أو زر يظهر داخل تطبيق مضيف

الحقول
runFunction	string الحقل مطلوب. نقطة النهاية التي سيتم تنفيذها عند تفعيل نقطة الإضافة هذه.
label	string الحقل مطلوب. النص المرئي للمستخدم الذي يصف الإجراء الذي تم اتخاذه من خلال تفعيل نقطة الإضافة هذه. على سبيل المثال، "إدراج فاتورة".
logoUrl	string عنوان URL لصورة الشعار المعروضة في شريط أدوات الإضافة إذا لم يتم ضبطه، سيتم استخدام عنوان URL الأساسي لشعار الإضافة تلقائيًا.

UniversalActionExtensionPoint

تنسيق لتحديد نقطة إضافة عنصر قائمة إجراءات عامة

الحقول
label	string الحقل مطلوب. نص مرئي للمستخدم يصف الإجراء الذي يتم اتخاذه عند تفعيل نقطة الإضافة هذه، مثل "إضافة جهة اتصال جديدة".
حقل الدمج action_type الحقل مطلوب. نوع الإجراء المتوافق مع عنصر قائمة الإجراءات الشاملة. يمكن أن يكون إما رابطًا لفتحه أو نقطة نهاية لتنفيذها. يمكن أن تكون action_type إحدى القيم التالية فقط:
openLink	string عنوان URL الذي سيتم فتحه بواسطة UniversalAction.
runFunction	string نقطة النهاية التي سيتم تشغيلها بواسطة UniversalAction

UriPattern

إعدادات كل نمط عنوان URL يؤدي إلى ظهور معاينة للرابط

الحقول
hostPattern	string مطلوب لكل نمط عنوان URL لمعاينته. نطاق نمط عنوان URL. تعرض الإضافة معاينات للروابط التي تتضمّن هذا النطاق في عنوان URL. لمعاينة الروابط الخاصة بنطاق فرعي معيّن، مثل subdomain.example.com، أدرِج النطاق الفرعي. لمعاينة الروابط الخاصة بالنطاق بأكمله، حدِّد حرف بدل مع علامة نجمة (*) كنطاق فرعي. على سبيل المثال، تتطابق *.example.com مع subdomain.example.com وanother.subdomain.example.com.
pathPrefix	string اختيارية: المسار الذي يلحق بنطاق hostPattern على سبيل المثال، إذا كان نمط مضيف عنوان URL هو support.example.com، لإجراء مطابقة مع عناوين URL للحالات المستضافة على support.example.com/cases/، أدخِل cases. لمطابقة جميع عناوين URL في نطاق نمط المضيف، اترك pathPrefix فارغًا.