Package google.apps.script.type

الفهرس

AddOnWidgetSet

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

الحقول
usedWidgets[]

WidgetType

قائمة التطبيقات المصغّرة المُستخدَمة في إحدى الإضافات

WidgetType

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

عمليات التعداد
WIDGET_TYPE_UNSPECIFIED تم ضبط التطبيق المصغّر التلقائي.
DATE_PICKER أداة اختيار التاريخ
STYLED_BUTTONS تشمل الأزرار المصمّمة الأزرار المعبّأة والأزرار غير المفعّلة.
PERSISTENT_FORMS تتيح النماذج الثابتة قيمًا ثابتة أثناء تنفيذ الإجراءات.
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.

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

LayoutProperties

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

الحقول
primaryColor

string

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

secondaryColor

string

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

useNewMaterialDesign

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.

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

الحقول
runFunction

string

مطلوب. يتم تنفيذ نقطة النهاية عند تفعيل نقطة الإضافة هذه.

label

string

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

logoUrl

string

عنوان URL لصورة الشعار المعروضة في شريط أدوات الإضافة.

في حال عدم ضبطه، يتم ضبطه تلقائيًا على عنوان URL للشعار الأساسي للإضافة.

UniversalActionExtensionPoint

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

الحقول
label

string

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

حقل الربط action_type مطلوب. نوع الإجراء المتوافق مع عنصر قائمة إجراءات عام. يمكن أن يكون إما رابطًا للفتح أو نقطة نهاية للتنفيذ. يمكن أن يكون action_type واحدًا فقط مما يلي:
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 فارغًا.