Package google.apps.script.type

شاخص

• AddOnWidgetSet (پیام)
• AddOnWidgetSet.WidgetType (enum)
• CommonAddOnManifest (پیام)
• CreateActionExtensionPoint (پیام)
• GranularOauthPermissionSupport (enum)
• HomepageExtensionPoint (پیام)
• HttpAuthorizationHeader (enum)
• HttpOptions (پیام)
• LayoutProperties (پیام)
• LinkPreviewExtensionPoint (پیام)
• MenuItemExtensionPoint (پیام)
• UniversalActionExtensionPoint (پیام)
• UriPattern (پیام)

AddOnWidgetSet

زیرمجموعه ویجت که توسط یک افزونه استفاده می شود.

فیلدها
usedWidgets[]	WidgetType لیست ویجت های مورد استفاده در یک افزونه.

ویجت نوع

نوع ویجت WIDGET_TYPE_UNSPECIFIED مجموعه اصلی ویجت است.

Enums
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 مورد نیاز. نشانی اینترنتی تصویر لوگو که در نوار ابزار افزودنی نشان داده شده است.
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

اینکه آیا این افزونه رضایت Granular OAuth را فعال کرده است یا خیر.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED	مقدار پیش فرض، نباید استفاده شود.
OPT_IN	این افزونه در Granular OAuth Consent انتخاب شده است.
OPT_OUT	این افزونه از موافقت Granular OAuth منصرف شده است.

HomepageExtensionPoint

فرمت رایج برای اعلام نمای صفحه اصلی افزونه.

فیلدها
runFunction	string مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.
enabled	BoolValue اختیاری. اگر روی false تنظیم شود، نمای صفحه اصلی را در این زمینه غیرفعال می کند. اگر تنظیم نشده باشد، پیش‌فرض به true می‌شود. اگر نمای صفحه اصلی سفارشی افزونه غیرفعال باشد، به جای آن یک کارت نمای کلی برای کاربران ارائه می شود.

HttpAuthorizationHeader

هدر مجوز در درخواست‌های HTTP افزودنی ارسال می‌شود.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED	مقدار پیش‌فرض، معادل SYSTEM_ID_TOKEN .
SYSTEM_ID_TOKEN	یک کد شناسه برای حساب سرویس سیستم افزونه Google Workspace خاص پروژه (پیش‌فرض) ارسال کنید.
USER_ID_TOKEN	برای کاربر نهایی یک شناسه بفرستید.
NONE	سرصفحه احراز هویت ارسال نکنید.

HttpOptions

گزینه هایی برای ارسال درخواست به نقاط پایانی HTTP افزودنی.

فیلدها
authorizationHeader	HttpAuthorizationHeader پیکربندی برای توکن ارسال شده در هدر مجوز HTTP .
granularOauthPermissionSupport	GranularOauthPermissionSupport اینکه آیا این افزونه رضایت Granular OAuth را فعال کرده است یا خیر.

LayoutProperties

ویژگی های طرح بندی کارت در همه برنامه های میزبان افزودنی به اشتراک گذاشته شده است.

فیلدها
primaryColor	string رنگ اصلی افزونه. رنگ نوار ابزار را تعیین می کند. اگر رنگ اصلی تنظیم نشده باشد، از مقدار پیش فرض ارائه شده توسط فریم ورک استفاده می شود.
secondaryColor	string رنگ ثانویه افزونه. رنگ دکمه ها را تنظیم می کند. اگر رنگ اصلی تنظیم شده باشد اما رنگ دوم تنظیم نشده باشد، رنگ ثانویه همان رنگ اصلی است. اگر نه رنگ اصلی و نه رنگ ثانویه تنظیم نشده باشد، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.
useNewMaterialDesign (deprecated)	bool این مورد منسوخ شده است! طراحی مواد را برای کارت ها فعال می کند.

LinkPreviewExtensionPoint

پیکربندی یک ماشه که زمانی فعال می‌شود که کاربر پیوندی را از یک سرویس شخص ثالث یا غیر 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 نشانی اینترنتی تصویر لوگو که در نوار ابزار افزودنی نشان داده شده است. اگر تنظیم نشده باشد، به طور پیش‌فرض روی نشانی اینترنتی نشان‌واره اصلی افزونه تنظیم می‌شود.

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 است، برای مطابقت با نشانی‌های وب برای موارد میزبانی شده در support.example.com/cases/ ، cases وارد کنید. برای مطابقت با همه URL ها در دامنه الگوی میزبان، pathPrefix خالی بگذارید.