REST Resource: projects.deployments

منبع: استقرار

استقرار افزونه Google Workspace

نمایندگی JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
فیلدها
name

string

نام منبع استقرار. مثال: projects/123/deployments/my_deployment .

oauthScopes[]

string

فهرستی از حوزه‌های Google OAuth که برای درخواست رضایت از کاربر نهایی قبل از اجرای نقطه پایانی افزودنی است.

addOns

object ( AddOns )

پیکربندی افزونه Google Workspace.

etag

string

این مقدار توسط سرور بر اساس نسخه استقرار در فضای ذخیره‌سازی محاسبه می‌شود و ممکن است در درخواست‌های به‌روزرسانی و حذف ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه، مقدار به‌روزی دارد.

افزونه ها

یک پیکربندی افزونه Google Workspace.

نمایندگی JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
فیلدها
common

object ( CommonAddOnManifest )

پیکربندی که در همه افزونه‌های Google Workspace رایج است.

gmail

object ( GmailAddOnManifest )

پیکربندی افزونه جیمیل.

drive

object ( DriveAddOnManifest )

پیکربندی افزونه Drive.

calendar

object ( CalendarAddOnManifest )

پیکربندی افزونه تقویم

docs

object ( DocsAddOnManifest )

پیکربندی افزونه Docs.

sheets

object ( SheetsAddOnManifest )

پیکربندی افزونه Sheets.

slides

object ( SlidesAddOnManifest )

پیکربندی افزودنی اسلایدها.

httpOptions

object ( HttpOptions )

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

CommonAddOnManifest

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

نمایندگی JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
فیلدها
name

string

مورد نیاز. نام نمایشی افزونه.

logoUrl

string

مورد نیاز. نشانی اینترنتی تصویر لوگو که در نوار ابزار افزودنی نشان داده شده است.

layoutProperties

object ( LayoutProperties )

ویژگی های طرح بندی رایج برای کارت های افزودنی.

addOnWidgetSet

object ( AddOnWidgetSet )

ویجت های استفاده شده در افزونه اگر این فیلد مشخص نشده باشد، از مجموعه پیش فرض استفاده می شود.

useLocaleFromApp

boolean

آیا باید اطلاعات محلی را از برنامه میزبان منتقل کرد یا خیر.

homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در هر زمینه و در هر میزبانی اجرا می شود. هر کارتی که توسط این عملکرد ایجاد می‌شود همیشه در دسترس کاربر خواهد بود، اما ممکن است زمانی که این افزونه محرک‌های هدفمندتری را اعلام می‌کند، توسط محتوای متنی محو شوند.

universalActions[]

object ( UniversalActionExtensionPoint )

فهرستی از نقاط برنامه افزودنی را در منوی عملکرد جهانی تعریف می کند که به عنوان منوی تنظیمات برای افزونه عمل می کند. نقطه پسوند می تواند یک URL پیوند برای باز کردن یا یک نقطه پایانی برای اجرا به عنوان ارسال فرم باشد.

openLinkUrlPrefixes

array ( ListValue format)

یک اقدام OpenLink فقط می‌تواند از یک URL با طرح HTTPS ، MAILTO یا TEL استفاده کند. برای پیوندهای HTTPS ، URL نیز باید با یکی از پیشوندهای مشخص شده در لیست مجاز مطابقت داشته باشد . اگر پیشوند طرح را حذف کند، HTTPS فرض می شود. پیوندهای HTTP به طور خودکار به پیوندهای HTTPS بازنویسی می شوند.

LayoutProperties

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

نمایندگی JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
فیلدها
primaryColor

string

رنگ اصلی افزونه. رنگ نوار ابزار را تعیین می کند. اگر رنگ اصلی تنظیم نشده باشد، از مقدار پیش فرض ارائه شده توسط فریم ورک استفاده می شود.

secondaryColor

string

رنگ ثانویه افزونه. رنگ دکمه ها را تنظیم می کند. اگر رنگ اصلی تنظیم شده باشد اما رنگ دوم تنظیم نشده باشد، رنگ ثانویه همان رنگ اصلی است. اگر نه رنگ اصلی و نه رنگ ثانویه تنظیم نشده باشد، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.

useNewMaterialDesign

boolean

طراحی مواد را برای کارت ها فعال می کند.

AddOnWidgetSet

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

نمایندگی JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
فیلدها
usedWidgets[]

enum ( WidgetType )

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

ویجت نوع

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

Enums
WIDGET_TYPE_UNSPECIFIED مجموعه ویجت پیش فرض
DATE_PICKER انتخاب کننده تاریخ
STYLED_BUTTONS دکمه های سبک شامل دکمه های پر شده و دکمه های غیرفعال می شوند.
PERSISTENT_FORMS فرم‌های ماندگار اجازه می‌دهند که مقادیر فرم در طول اعمال باقی بماند.
UPDATE_SUBJECT_AND_RECIPIENTS موضوع و دریافت کنندگان پیش نویس را به روز کنید.
GRID_WIDGET ویجت شبکه
ADDON_COMPOSE_UI_ACTION یک اقدام برافزای Gmail که در رابط کاربری نوشتن افزونه اعمال می‌شود.

HomepageExtensionPoint

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

نمایندگی JSON 
{
  "runFunction": string,
  "enabled": boolean
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

enabled

boolean

اختیاری. اگر روی false تنظیم شود، نمای صفحه اصلی را در این زمینه غیرفعال می کند.

اگر تنظیم نشده باشد، پیش‌فرض به true می‌شود.

اگر نمای صفحه اصلی سفارشی افزونه غیرفعال باشد، به جای آن یک کارت نمای کلی برای کاربران ارائه می شود.

UniversalActionExtensionPoint

قالب برای اعلام نقطه پسوند آیتم منوی عمل جهانی.

نمایندگی JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
label

string

مورد نیاز. متن قابل مشاهده برای کاربر که عملکرد انجام شده با فعال کردن این نقطه پسوند را توصیف می کند، به عنوان مثال، "افزودن یک مخاطب جدید".

action_type میدان اتحادیه. مورد نیاز. نوع عملکردی که در یک آیتم منوی عملکرد جهانی پشتیبانی می‌شود. این می تواند پیوندی برای باز کردن یا نقطه پایانی برای اجرا باشد. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که باید توسط UniversalAction اجرا شود.

GmailAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Gmail را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می‌کند که در زمینه‌هایی اجرا می‌شود که با یک محرک متنی اعلام‌شده مطابقت ندارند. هر کارتی که توسط این عملکرد ایجاد می‌شود همیشه در دسترس کاربر خواهد بود، اما ممکن است زمانی که این افزونه محرک‌های هدفمندتری را اعلام می‌کند، توسط محتوای متنی محو شوند.

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

contextualTriggers[]

object ( ContextualTrigger )

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

universalActions[]

object ( UniversalAction )

مجموعه ای از اقدامات جهانی را برای افزونه تعریف می کند. کاربر اقدامات جهانی را از منوی نوار ابزار افزودنی فعال می کند.

composeTrigger

object ( ComposeTrigger )

محرک زمان نوشتن را برای افزونه زمان نوشتن تعریف می کند. این عاملی است که باعث می شود یک افزونه در هنگام نوشتن ایمیل اقدام کند. همه افزونه‌های زمان نوشتن باید دامنه gmail.addons.current.action.compose را داشته باشند، حتی اگر پیش‌نویس را ویرایش نکند.

authorizationCheckFunction

string

نام نقطه پایانی که با بررسی API های شخص ثالث تأیید می کند که افزونه دارای تمام مجوزهای شخص ثالث مورد نیاز است. اگر پروب از کار بیفتد، تابع باید یک استثنا برای شروع جریان مجوز ایجاد کند. این تابع قبل از هر فراخوانی افزونه فراخوانی می شود تا از تجربه کاربری روان اطمینان حاصل شود.

ContextualTrigger

ماشه ای را تعریف می کند که زمانی فعال می شود که ایمیل باز دارای معیار خاصی باشد. هنگامی که ماشه فعال می شود، یک نقطه پایانی خاص را اجرا می کند، معمولاً به منظور ایجاد کارت های جدید و به روز رسانی UI.

نمایندگی JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
فیلدها
onTriggerFunction

string

مورد نیاز. نام نقطه پایانی برای تماس زمانی که پیامی با ماشه مطابقت دارد.

trigger میدان اتحادیه . نوع راه‌انداز شرایطی را که Gmail برای نمایش افزونه استفاده می‌کند تعیین می‌کند. trigger می تواند تنها یکی از موارد زیر باشد:
unconditional

object ( UnconditionalTrigger )

هنگامی که هر پیام ایمیلی باز می شود، محرک های بدون قید و شرط اجرا می شوند.

بدون شرط

این نوع هیچ فیلدی ندارد.

ماشه ای که با باز شدن هر پیام ایمیلی فعال می شود.

یونیورسال اکشن

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

نمایندگی JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
text

string

مورد نیاز. متن قابل مشاهده برای کاربر که عملکرد را توصیف می کند، به عنوان مثال، "افزودن یک مخاطب جدید".

action_type میدان اتحادیه. نوع عمل رفتار جیمیل را زمانی که کاربر اقدامی را فراخوانی می کند، تعیین می کند. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که زمانی فراخوانی می شود که کاربر اقدام را راه اندازی می کند. برای جزئیات به راهنمای اقدامات جهانی مراجعه کنید.

ComposeTrigger

ماشه ای که هنگام نوشتن ایمیل فعال می شود.

نمایندگی JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
فیلدها
actions[]

object ( MenuItemExtensionPoint )

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

draftAccess

enum ( DraftAccess )

سطح دسترسی به داده را هنگام فعال شدن یک افزونه زمان نوشتن مشخص می کند.

DraftAccess

یک عدد که سطح دسترسی به داده مورد نیاز تریگر نوشتن را مشخص می کند.

Enums
UNSPECIFIED مقدار پیش‌فرض زمانی که چیزی برای دسترسی به پیش‌نویس تنظیم نشده باشد.
NONE هنگامی که یک برافزای نوشتن راه‌اندازی می‌شود، راه‌انداز نوشتن نمی‌تواند به هیچ داده‌ای از پیش‌نویس دسترسی داشته باشد.
METADATA به راه‌انداز نوشتن اجازه دسترسی به فراداده پیش‌نویس را هنگام راه‌اندازی یک افزونه نوشتن می‌دهد. این شامل فهرست مخاطبان، مانند فهرست To و Cc یک پیام پیش‌نویس می‌شود.

DriveAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Drive را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onItemsSelectedTrigger

object ( DriveExtensionPoint )

مربوط به رفتاری است که هنگام انتخاب موارد در نمای Drive مربوطه، مانند My Drive Doclist، اجرا می‌شود.

DriveExtensionPoint

قالب متداول برای اعلام محرک های افزونه Drive.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن نقطه گسترش اجرا شود.

CalendarAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Calendar را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می‌کند که در زمینه‌هایی اجرا می‌شود که با یک محرک متنی اعلام‌شده مطابقت ندارد. هر کارتی که توسط این عملکرد ایجاد می‌شود همیشه در دسترس کاربر خواهد بود، اما ممکن است زمانی که این افزونه محرک‌های هدفمندتری را اعلام می‌کند، توسط محتوای متنی محو شوند.

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

conferenceSolution[]

object ( ConferenceSolution )

راه حل های کنفرانس ارائه شده توسط این افزونه را تعریف می کند. افزونه های کنفرانس شخص ثالث فقط در Apps Script ساخته می شوند.

createSettingsUrlFunction

string

یک نقطه پایانی برای اجرا که یک URL به صفحه تنظیمات افزونه ایجاد می کند.

eventOpenTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام باز شدن یک رویداد برای مشاهده یا ویرایش فعال می شود.

eventUpdateTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام به‌روزرسانی رویداد باز فعال می‌شود.

eventAttachmentTrigger

object ( MenuItemExtensionPoint )

پیکربندی برای یک راه‌انداز متنی که وقتی کاربر روی ارائه‌دهنده پیوست افزونه در منوی کشویی تقویم کلیک می‌کند فعال می‌شود.

currentEventAccess

enum ( EventAccess )

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

راه حل کنفرانس

ارزش های مرتبط با کنفرانس را تعریف می کند. افزونه های کنفرانس شخص ثالث فقط در Apps Script ساخته می شوند.

نمایندگی JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
فیلدها
onCreateFunction

string

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

id

string

مورد نیاز. شناسه‌ها باید به‌صورت منحصربه‌فرد در راه‌حل‌های کنفرانس در یک افزونه اختصاص داده شوند، در غیر این صورت ممکن است هنگام راه‌اندازی افزونه، از راه‌حل اشتباه کنفرانس استفاده شود. در حالی که می توانید نام نمایشی یک افزونه را تغییر دهید، شناسه نباید تغییر کند.

name

string

مورد نیاز. نام نمایشی راه حل کنفرانس.

logoUrl

string

مورد نیاز. نشانی اینترنتی تصویر آرم راه حل کنفرانس.

CalendarExtensionPoint

قالب متداول برای اعلام محرک های افزونه تقویم.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

رویداد دسترسی

شماره‌ای که سطح مورد نیاز محرک‌های رویداد دسترسی به داده را مشخص می‌کند.

Enums
UNSPECIFIED مقدار پیش‌فرض زمانی که چیزی برای eventAccess تنظیم نشده باشد.
METADATA به فعال‌کننده‌های رویداد اجازه دسترسی به فراداده رویدادها مانند شناسه رویداد و شناسه تقویم را می‌دهد.
READ به محرک های رویداد دسترسی به تمام زمینه های رویداد ارائه شده از جمله ابرداده، شرکت کنندگان و داده های کنفرانس را می دهد.
WRITE به محرک های رویداد دسترسی به فراداده رویدادها و توانایی انجام همه اقدامات، از جمله افزودن شرکت کنندگان و تنظیم داده های کنفرانس را می دهد.
READ_WRITE به محرک‌های رویداد دسترسی به تمام فیلدهای رویداد ارائه شده از جمله فراداده، شرکت‌کنندگان و داده‌های کنفرانس و توانایی انجام همه اقدامات را می‌دهد.

DocsAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Google Docs را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onFileScopeGrantedTrigger

object ( DocsExtensionPoint )

هنگامی که مجوز دامنه فایل برای این جفت سند/کاربر اعطا می شود، نقطه پایانی اجرا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

فهرستی از نقاط افزونه برای پیش نمایش پیوندها در سند Google Docs. برای جزئیات، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

createActionTriggers[]

object ( CreateActionExtensionPoint )

فهرستی از نقاط افزونه برای ایجاد منابع شخص ثالث از داخل برنامه‌های Google Workspace. برای اطلاعات بیشتر، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

DocsExtensionPoint

قالب متداول برای اعلام محرک های افزونه Docs.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

LinkPreviewExtensionPoint

پیکربندی یک ماشه که زمانی فعال می‌شود که کاربر پیوندی را از یک سرویس شخص ثالث یا غیر Google در فایل سندنگار، کاربرگ‌نگار یا اسلایدنگار Google تایپ یا جای‌گذاری کند.

نمایندگی JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
فیلدها
labelText

string

مورد نیاز. متن یک نمونه تراشه هوشمند که از کاربران می خواهد پیوند را پیش نمایش کنند، مانند Example: Support case . این متن ثابت است و قبل از اجرای افزونه توسط کاربران نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبان های دیگر. زبان را در ISO 639 و کشور/منطقه را در ISO 3166 فرمت کنید که با خط فاصله از هم جدا شده اند - . به عنوان مثال، en-US .

اگر موقعیت مکانی کاربر در کلیدهای نقشه وجود داشته باشد، کاربر نسخه بومی‌سازی شده labeltext را می‌بیند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

patterns[]

object ( UriPattern )

مورد نیاز. مجموعه ای از الگوهای URL که افزونه را برای پیش نمایش پیوندها فعال می کند.

runFunction

string

مورد نیاز. نقطه پایانی برای اجرا در هنگام راه اندازی پیش نمایش پیوند.

logoUrl

string

اختیاری. نمادی که در تراشه هوشمند و کارت پیش نمایش نمایش داده می شود. اگر حذف شود، افزونه از نماد نوار ابزار خود، logourl استفاده می کند.

UriPattern

پیکربندی برای هر الگوی URL که پیش‌نمایش پیوند را راه‌اندازی می‌کند.

نمایندگی JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
فیلدها
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 خالی بگذارید.

CreateActionExtensionPoint

پیکربندی یک ماشه که وقتی کاربر گردش کار ایجاد منبع را در یک برنامه Google Workspace فراخوانی می‌کند فعال می‌شود. برای اطلاعات بیشتر، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

نمایندگی JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
فیلدها
id

string

مورد نیاز. شناسه منحصر به فرد برای متمایز کردن این نقطه پسوند. شناسه می تواند حداکثر 64 کاراکتر داشته باشد و باید در قالب [a-zA-Z0-9-]+ باشد.

labelText

string

مورد نیاز. متنی که در کنار نمادی برای نقطه ورودی ایجاد منبع نمایش داده می شود، مانند Create support case . این متن ثابت است و قبل از اجرای افزونه توسط کاربران نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبان های دیگر. زبان را در ISO 639 و کشور/منطقه را در ISO 3166 فرمت کنید که با خط فاصله از هم جدا شده اند - . به عنوان مثال، en-US .

اگر موقعیت مکانی کاربر در کلیدهای نقشه وجود داشته باشد، کاربر نسخه بومی‌سازی شده labeltext را می‌بیند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

runFunction

string

مورد نیاز. نقطه پایانی برای اجرا زمانی که یک گردش کار ایجاد منبع برای ایجاد یک پیوند راه اندازی می شود.

logoUrl

string

اختیاری. نمادی که برای نقطه ورودی ایجاد منبع نمایش داده می شود. اگر حذف شود، منو از نماد نوار ابزار افزونه شما، logourl استفاده می کند.

SheetsAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Google Sheets را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onFileScopeGrantedTrigger

object ( SheetsExtensionPoint )

هنگامی که مجوز دامنه فایل برای این جفت سند/کاربر اعطا می شود، نقطه پایانی اجرا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

فهرستی از نقاط افزونه برای پیش نمایش پیوندها در سند Google Sheets. برای جزئیات، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

SheetsExtensionPoint

قالب متداول برای اعلام محرک های افزونه Sheets.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

SlidesAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Google Slides را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onFileScopeGrantedTrigger

object ( SlidesExtensionPoint )

هنگامی که مجوز دامنه فایل برای این جفت سند/کاربر اعطا می شود، نقطه پایانی اجرا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

فهرستی از نقاط افزونه برای پیش نمایش پیوندها در سند اسلایدهای Google. برای جزئیات، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

SlidesExtensionPoint

فرمت متداول برای اعلام محرک های برافزای اسلایدها.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

HttpOptions

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

نمایندگی JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
فیلدها
authorizationHeader

enum ( HttpAuthorizationHeader )

پیکربندی برای توکن ارسال شده در هدر مجوز HTTP .

HttpAuthorizationHeader

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

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

روش ها

create

 یک استقرار با نام و پیکربندی مشخص شده ایجاد می کند.

delete

 استقرار با نام داده شده را حذف می کند.

get

 استقرار را با نام مشخص شده دریافت می کند.

getInstallStatus

 وضعیت نصب یک استقرار آزمایشی را دریافت می کند.

install

 یک استقرار را برای آزمایش در حساب شما نصب می کند.

list

 تمام استقرارها در یک پروژه خاص را فهرست می کند.

replaceDeployment

 یک استقرار را با نام مشخص شده ایجاد یا جایگزین می کند.

uninstall

 یک استقرار آزمایشی را از حساب کاربر حذف نصب می کند.
،

منبع: استقرار

استقرار افزونه Google Workspace

نمایندگی JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
فیلدها
name

string

نام منبع استقرار. مثال: projects/123/deployments/my_deployment .

oauthScopes[]

string

فهرستی از حوزه‌های Google OAuth که برای درخواست رضایت از کاربر نهایی قبل از اجرای نقطه پایانی افزودنی است.

addOns

object ( AddOns )

پیکربندی افزونه Google Workspace.

etag

string

این مقدار توسط سرور بر اساس نسخه استقرار در فضای ذخیره‌سازی محاسبه می‌شود و ممکن است در درخواست‌های به‌روزرسانی و حذف ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه، مقدار به‌روزی دارد.

افزونه ها

یک پیکربندی افزونه Google Workspace.

نمایندگی JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
فیلدها
common

object ( CommonAddOnManifest )

پیکربندی که در همه افزونه‌های Google Workspace رایج است.

gmail

object ( GmailAddOnManifest )

پیکربندی افزونه جیمیل.

drive

object ( DriveAddOnManifest )

پیکربندی افزونه Drive.

calendar

object ( CalendarAddOnManifest )

پیکربندی افزونه تقویم

docs

object ( DocsAddOnManifest )

پیکربندی افزونه Docs.

sheets

object ( SheetsAddOnManifest )

پیکربندی افزونه Sheets.

slides

object ( SlidesAddOnManifest )

پیکربندی افزودنی اسلایدها.

httpOptions

object ( HttpOptions )

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

CommonAddOnManifest

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

نمایندگی JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
فیلدها
name

string

مورد نیاز. نام نمایشی افزونه.

logoUrl

string

مورد نیاز. نشانی اینترنتی تصویر لوگو که در نوار ابزار افزودنی نشان داده شده است.

layoutProperties

object ( LayoutProperties )

ویژگی های طرح بندی رایج برای کارت های الحاقی.

addOnWidgetSet

object ( AddOnWidgetSet )

ویجت های استفاده شده در افزونه اگر این فیلد مشخص نشده باشد، از مجموعه پیش فرض استفاده می شود.

useLocaleFromApp

boolean

آیا باید اطلاعات محلی را از برنامه میزبان منتقل کرد یا خیر.

homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در هر زمینه و در هر میزبانی اجرا می شود. هر کارتی که توسط این عملکرد ایجاد می‌شود همیشه در دسترس کاربر خواهد بود، اما ممکن است زمانی که این افزونه محرک‌های هدفمندتری را اعلام می‌کند، توسط محتوای متنی محو شوند.

universalActions[]

object ( UniversalActionExtensionPoint )

فهرستی از نقاط برنامه افزودنی را در منوی عملکرد جهانی تعریف می کند که به عنوان منوی تنظیمات برای افزونه عمل می کند. نقطه پسوند می تواند یک URL پیوند برای باز کردن یا یک نقطه پایانی برای اجرا به عنوان ارسال فرم باشد.

openLinkUrlPrefixes

array ( ListValue format)

یک اقدام OpenLink فقط می‌تواند از یک URL با طرح HTTPS ، MAILTO یا TEL استفاده کند. برای پیوندهای HTTPS ، URL نیز باید با یکی از پیشوندهای مشخص شده در لیست مجاز مطابقت داشته باشد . اگر پیشوند طرح را حذف کند، HTTPS فرض می شود. پیوندهای HTTP به طور خودکار به پیوندهای HTTPS بازنویسی می شوند.

LayoutProperties

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

نمایندگی JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
فیلدها
primaryColor

string

رنگ اصلی افزونه. رنگ نوار ابزار را تعیین می کند. اگر رنگ اصلی تنظیم نشده باشد، از مقدار پیش فرض ارائه شده توسط فریم ورک استفاده می شود.

secondaryColor

string

رنگ ثانویه افزونه. رنگ دکمه ها را تنظیم می کند. اگر رنگ اصلی تنظیم شده باشد اما رنگ دوم تنظیم نشده باشد، رنگ ثانویه همان رنگ اصلی است. اگر نه رنگ اصلی و نه رنگ ثانویه تنظیم نشده باشد، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.

useNewMaterialDesign

boolean

طراحی مواد را برای کارت ها فعال می کند.

AddOnWidgetSet

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

نمایندگی JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
فیلدها
usedWidgets[]

enum ( WidgetType )

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

ویجت نوع

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

Enums
WIDGET_TYPE_UNSPECIFIED مجموعه ویجت پیش فرض
DATE_PICKER انتخاب کننده تاریخ
STYLED_BUTTONS دکمه های سبک شامل دکمه های پر شده و دکمه های غیرفعال می شوند.
PERSISTENT_FORMS فرم‌های ماندگار اجازه می‌دهند که مقادیر فرم در طول اعمال باقی بماند.
UPDATE_SUBJECT_AND_RECIPIENTS موضوع و دریافت کنندگان پیش نویس را به روز کنید.
GRID_WIDGET ویجت شبکه
ADDON_COMPOSE_UI_ACTION یک اقدام برافزای Gmail که در رابط کاربری نوشتن افزونه اعمال می‌شود.

HomepageExtensionPoint

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

نمایندگی JSON 
{
  "runFunction": string,
  "enabled": boolean
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

enabled

boolean

اختیاری. اگر روی false تنظیم شود، نمای صفحه اصلی را در این زمینه غیرفعال می کند.

اگر تنظیم نشده باشد، پیش‌فرض به true می‌شود.

اگر نمای صفحه اصلی سفارشی افزونه غیرفعال باشد، به جای آن یک کارت نمای کلی برای کاربران ارائه می شود.

UniversalActionExtensionPoint

قالب برای اعلام نقطه پسوند آیتم منوی عمل جهانی.

نمایندگی JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
label

string

مورد نیاز. متن قابل مشاهده برای کاربر که عملکرد انجام شده با فعال کردن این نقطه پسوند را توصیف می کند، به عنوان مثال، "افزودن یک مخاطب جدید".

action_type میدان اتحادیه. مورد نیاز. نوع عملکردی که در یک آیتم منوی عملکرد جهانی پشتیبانی می‌شود. این می تواند پیوندی برای باز کردن یا نقطه پایانی برای اجرا باشد. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که باید توسط UniversalAction اجرا شود.

GmailAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Gmail را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می‌کند که در زمینه‌هایی اجرا می‌شود که با یک محرک متنی اعلام‌شده مطابقت ندارند. هر کارتی که توسط این عملکرد ایجاد می‌شود همیشه در دسترس کاربر خواهد بود، اما ممکن است زمانی که این افزونه محرک‌های هدفمندتری را اعلام می‌کند، توسط محتوای متنی محو شوند.

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

contextualTriggers[]

object ( ContextualTrigger )

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

universalActions[]

object ( UniversalAction )

مجموعه ای از اقدامات جهانی را برای افزونه تعریف می کند. کاربر اقدامات جهانی را از منوی نوار ابزار افزودنی فعال می کند.

composeTrigger

object ( ComposeTrigger )

محرک زمان نوشتن را برای افزونه زمان نوشتن تعریف می کند. این عاملی است که باعث می شود یک افزونه در هنگام نوشتن ایمیل اقدام کند. همه افزونه‌های زمان نوشتن باید دامنه gmail.addons.current.action.compose را داشته باشند، حتی اگر پیش‌نویس را ویرایش نکند.

authorizationCheckFunction

string

نام نقطه پایانی که با بررسی API های شخص ثالث تأیید می کند که افزونه دارای تمام مجوزهای شخص ثالث مورد نیاز است. اگر پروب از کار بیفتد، تابع باید یک استثنا برای شروع جریان مجوز ایجاد کند. این تابع قبل از هر فراخوانی افزونه فراخوانی می شود تا از تجربه کاربری روان اطمینان حاصل شود.

ContextualTrigger

ماشه ای را تعریف می کند که زمانی فعال می شود که ایمیل باز دارای معیار خاصی باشد. هنگامی که ماشه فعال می شود، یک نقطه پایانی خاص را اجرا می کند، معمولاً به منظور ایجاد کارت های جدید و به روز رسانی UI.

نمایندگی JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
فیلدها
onTriggerFunction

string

مورد نیاز. نام نقطه پایانی برای تماس زمانی که پیامی با ماشه مطابقت دارد.

trigger میدان اتحادیه . نوع راه‌انداز شرایطی را که Gmail برای نمایش افزونه استفاده می‌کند تعیین می‌کند. trigger می تواند تنها یکی از موارد زیر باشد:
unconditional

object ( UnconditionalTrigger )

هنگامی که هر پیام ایمیلی باز می شود، محرک های بدون قید و شرط اجرا می شوند.

بدون شرط

این نوع هیچ فیلدی ندارد.

ماشه ای که با باز شدن هر پیام ایمیلی فعال می شود.

یونیورسال اکشن

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

نمایندگی JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
text

string

مورد نیاز. متن قابل مشاهده برای کاربر که عملکرد را توصیف می کند، به عنوان مثال، "افزودن یک مخاطب جدید".

action_type میدان اتحادیه. نوع عمل رفتار جیمیل را زمانی که کاربر اقدامی را فراخوانی می کند، تعیین می کند. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که زمانی فراخوانی می شود که کاربر اقدام را راه اندازی می کند. برای جزئیات به راهنمای اقدامات جهانی مراجعه کنید.

ComposeTrigger

ماشه ای که هنگام نوشتن ایمیل فعال می شود.

نمایندگی JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
فیلدها
actions[]

object ( MenuItemExtensionPoint )

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

draftAccess

enum ( DraftAccess )

سطح دسترسی به داده را هنگام فعال شدن یک افزونه زمان نوشتن مشخص می کند.

DraftAccess

یک عدد که سطح دسترسی به داده مورد نیاز تریگر نوشتن را مشخص می کند.

Enums
UNSPECIFIED مقدار پیش‌فرض زمانی که چیزی برای دسترسی به پیش‌نویس تنظیم نشده باشد.
NONE هنگامی که یک برافزای نوشتن راه‌اندازی می‌شود، راه‌انداز نوشتن نمی‌تواند به هیچ داده‌ای از پیش‌نویس دسترسی داشته باشد.
METADATA به راه‌انداز نوشتن اجازه دسترسی به فراداده پیش‌نویس را هنگام راه‌اندازی یک افزونه نوشتن می‌دهد. این شامل فهرست مخاطبان، مانند فهرست To و Cc یک پیام پیش‌نویس می‌شود.

DriveAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Drive را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onItemsSelectedTrigger

object ( DriveExtensionPoint )

مربوط به رفتاری است که هنگام انتخاب موارد در نمای Drive مربوطه، مانند My Drive Doclist، اجرا می‌شود.

DriveExtensionPoint

قالب متداول برای اعلام محرک های افزونه Drive.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن نقطه گسترش اجرا شود.

CalendarAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Calendar را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می‌کند که در زمینه‌هایی اجرا می‌شود که با یک محرک متنی اعلام‌شده مطابقت ندارد. هر کارتی که توسط این عملکرد ایجاد می‌شود همیشه در دسترس کاربر خواهد بود، اما ممکن است زمانی که این افزونه محرک‌های هدفمندتری را اعلام می‌کند، توسط محتوای متنی محو شوند.

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

conferenceSolution[]

object ( ConferenceSolution )

راه حل های کنفرانس ارائه شده توسط این افزونه را تعریف می کند. افزونه های کنفرانس شخص ثالث فقط در Apps Script ساخته می شوند.

createSettingsUrlFunction

string

یک نقطه پایانی برای اجرا که یک URL به صفحه تنظیمات افزونه ایجاد می کند.

eventOpenTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام باز شدن یک رویداد برای مشاهده یا ویرایش فعال می شود.

eventUpdateTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام به‌روزرسانی رویداد باز فعال می‌شود.

eventAttachmentTrigger

object ( MenuItemExtensionPoint )

پیکربندی برای یک راه‌انداز متنی که وقتی کاربر روی ارائه‌دهنده پیوست افزونه در منوی کشویی تقویم کلیک می‌کند فعال می‌شود.

currentEventAccess

enum ( EventAccess )

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

راه حل کنفرانس

ارزش های مرتبط با کنفرانس را تعریف می کند. افزونه های کنفرانس شخص ثالث فقط در Apps Script ساخته می شوند.

نمایندگی JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
فیلدها
onCreateFunction

string

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

id

string

مورد نیاز. شناسه‌ها باید به‌صورت منحصربه‌فرد در راه‌حل‌های کنفرانس در یک افزونه اختصاص داده شوند، در غیر این صورت ممکن است هنگام راه‌اندازی افزونه، از راه‌حل اشتباه کنفرانس استفاده شود. در حالی که می توانید نام نمایشی یک افزونه را تغییر دهید، شناسه نباید تغییر کند.

name

string

مورد نیاز. نام نمایشی راه حل کنفرانس.

logoUrl

string

مورد نیاز. نشانی اینترنتی تصویر آرم راه حل کنفرانس.

CalendarExtensionPoint

قالب متداول برای اعلام محرک های افزونه تقویم.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

رویداد دسترسی

شماره‌ای که سطح مورد نیاز محرک‌های رویداد دسترسی به داده را مشخص می‌کند.

Enums
UNSPECIFIED مقدار پیش‌فرض زمانی که چیزی برای eventAccess تنظیم نشده باشد.
METADATA به فعال‌کننده‌های رویداد اجازه دسترسی به فراداده رویدادها مانند شناسه رویداد و شناسه تقویم را می‌دهد.
READ به محرک های رویداد دسترسی به تمام فیلدهای رویداد ارائه شده از جمله ابرداده، شرکت کنندگان و داده های کنفرانس را می دهد.
WRITE به محرک های رویداد دسترسی به فراداده رویدادها و توانایی انجام همه اقدامات، از جمله افزودن شرکت کنندگان و تنظیم داده های کنفرانس را می دهد.
READ_WRITE به محرک‌های رویداد دسترسی به تمام فیلدهای رویداد ارائه شده از جمله فراداده، شرکت‌کنندگان و داده‌های کنفرانس و توانایی انجام همه اقدامات را می‌دهد.

DocsAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Google Docs را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onFileScopeGrantedTrigger

object ( DocsExtensionPoint )

هنگامی که مجوز دامنه فایل برای این جفت سند/کاربر اعطا می شود، نقطه پایانی اجرا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

فهرستی از نقاط افزونه برای پیش نمایش پیوندها در سند Google Docs. برای جزئیات، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

createActionTriggers[]

object ( CreateActionExtensionPoint )

فهرستی از نقاط افزونه برای ایجاد منابع شخص ثالث از داخل برنامه‌های Google Workspace. برای اطلاعات بیشتر، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

DocsExtensionPoint

قالب متداول برای اعلام محرک های افزونه Docs.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

LinkPreviewExtensionPoint

پیکربندی یک ماشه که زمانی فعال می‌شود که کاربر پیوندی را از یک سرویس شخص ثالث یا غیر Google در فایل سندنگار، کاربرگ‌نگار یا اسلایدنگار Google تایپ یا جای‌گذاری کند.

نمایندگی JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
فیلدها
labelText

string

مورد نیاز. متن یک نمونه تراشه هوشمند که از کاربران می خواهد پیوند را پیش نمایش کنند، مانند Example: Support case . این متن ثابت است و قبل از اجرای افزونه توسط کاربران نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبان های دیگر. زبان را در ISO 639 و کشور/منطقه را در ISO 3166 فرمت کنید که با خط فاصله از هم جدا شده اند - . به عنوان مثال، en-US .

اگر موقعیت مکانی کاربر در کلیدهای نقشه وجود داشته باشد، کاربر نسخه بومی‌سازی شده labeltext را می‌بیند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

patterns[]

object ( UriPattern )

مورد نیاز. مجموعه ای از الگوهای URL که افزونه را برای پیش نمایش پیوندها فعال می کند.

runFunction

string

مورد نیاز. نقطه پایانی برای اجرا در هنگام راه اندازی پیش نمایش پیوند.

logoUrl

string

اختیاری. نمادی که در تراشه هوشمند و کارت پیش نمایش نمایش داده می شود. اگر حذف شود، افزونه از نماد نوار ابزار خود، logourl استفاده می کند.

UriPattern

پیکربندی برای هر الگوی URL که پیش‌نمایش پیوند را راه‌اندازی می‌کند.

نمایندگی JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
فیلدها
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 خالی بگذارید.

CreateActionExtensionPoint

پیکربندی یک ماشه که وقتی کاربر گردش کار ایجاد منبع را در یک برنامه Google Workspace فراخوانی می‌کند فعال می‌شود. برای اطلاعات بیشتر، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

نمایندگی JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
فیلدها
id

string

مورد نیاز. شناسه منحصر به فرد برای متمایز کردن این نقطه پسوند. شناسه می تواند حداکثر 64 کاراکتر داشته باشد و باید در قالب [a-zA-Z0-9-]+ باشد.

labelText

string

مورد نیاز. متنی که در کنار نمادی برای نقطه ورودی ایجاد منبع نمایش داده می شود، مانند Create support case . این متن ثابت است و قبل از اجرای افزونه توسط کاربران نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبان های دیگر. زبان را در ISO 639 و کشور/منطقه را در ISO 3166 فرمت کنید که با خط فاصله از هم جدا شده اند - . به عنوان مثال، en-US .

اگر موقعیت مکانی کاربر در کلیدهای نقشه وجود داشته باشد، کاربر نسخه بومی‌سازی شده labeltext را می‌بیند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

runFunction

string

مورد نیاز. نقطه پایانی برای اجرا زمانی که یک گردش کار ایجاد منبع برای ایجاد یک پیوند راه اندازی می شود.

logoUrl

string

اختیاری. نمادی که برای نقطه ورودی ایجاد منبع نمایش داده می شود. اگر حذف شود، منو از نماد نوار ابزار افزونه شما، logourl استفاده می کند.

SheetsAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Google Sheets را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onFileScopeGrantedTrigger

object ( SheetsExtensionPoint )

هنگامی که مجوز دامنه فایل برای این جفت سند/کاربر اعطا می شود، نقطه پایانی اجرا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

فهرستی از نقاط افزونه برای پیش نمایش پیوندها در سند Google Sheets. برای جزئیات، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

SheetsExtensionPoint

قالب متداول برای اعلام محرک های افزونه Sheets.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

SlidesAddOnManifest

ویژگی هایی که ظاهر و اجرای یک افزونه Google Slides را سفارشی می کند.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود، این تنظیمات از addons.common.homepageTrigger لغو می شود.

onFileScopeGrantedTrigger

object ( SlidesExtensionPoint )

هنگامی که مجوز دامنه فایل برای این جفت سند/کاربر اعطا می شود، نقطه پایانی اجرا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

فهرستی از نقاط افزونه برای پیش‌نمایش پیوندها در یک سند Google Slides. برای جزئیات، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

SlidesExtensionPoint

فرمت متداول برای اعلام محرک های برافزای اسلایدها.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی که باید با فعال شدن این نقطه پسوند اجرا شود.

HttpOptions

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

نمایندگی JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
فیلدها
authorizationHeader

enum ( HttpAuthorizationHeader )

پیکربندی برای نشانه ارسال شده در عنوان مجوز HTTP .

httpauthorizationHeader

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

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

روش ها

create

 استقرار را با نام و پیکربندی مشخص شده ایجاد می کند.

delete

 استقرار را با نام داده شده حذف می کند.

get

 استقرار را با نام مشخص می کند.

getInstallStatus

 وضعیت نصب یک تست را دریافت می کند.

install

 برای آزمایش یک استقرار به حساب خود نصب می کند.

list

 کلیه استقرارها را در یک پروژه خاص لیست می کند.

replaceDeployment

 استقرار را با نام مشخص شده ایجاد یا جایگزین می کند.

uninstall

 استقرار آزمایش را از حساب کاربر حذف کنید.
،

منبع: استقرار

استقرار افزودنی فضای کاری Google

نمایندگی JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
فیلدها
name

string

نام منابع استقرار. مثال: projects/123/deployments/my_deployment .

oauthScopes[]

string

لیست Scopes Google OAuth که قبل از اجرای یک نقطه پایانی افزودنی ، درخواست رضایت از کاربر نهایی را می دهند.

addOns

object ( AddOns )

پیکربندی افزودنی فضای کاری Google.

etag

string

این مقدار توسط سرور بر اساس نسخه استقرار در ذخیره سازی محاسبه می شود و ممکن است در مورد به روزرسانی و حذف درخواست ها ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه ارزش به روز دارد.

ترکیب

پیکربندی افزودنی فضای کاری Google.

نمایندگی JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
فیلدها
common

object ( CommonAddOnManifest )

پیکربندی که در تمام افزودنیهای فضای کاری Google متداول است.

gmail

object ( GmailAddOnManifest )

پیکربندی افزودنی Gmail.

drive

object ( DriveAddOnManifest )

پیکربندی افزودنی را درایو کنید.

calendar

object ( CalendarAddOnManifest )

پیکربندی افزودنی تقویم.

docs

object ( DocsAddOnManifest )

پیکربندی افزودنی اسناد.

sheets

object ( SheetsAddOnManifest )

پیکربندی افزودنی ورق ها.

slides

object ( SlidesAddOnManifest )

پیکربندی افزودنی اسلایدها.

httpOptions

object ( HttpOptions )

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

CommonaddonManifest

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

نمایندگی JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
فیلدها
name

string

مورد نیاز. نام نمایشگاه افزودنی.

logoUrl

string

مورد نیاز. URL برای تصویر آرم نشان داده شده در نوار ابزار افزودنی.

layoutProperties

object ( LayoutProperties )

خصوصیات چیدمان مشترک برای کارتهای افزودنی.

addOnWidgetSet

object ( AddOnWidgetSet )

ابزارک های مورد استفاده در افزودنی. اگر این قسمت مشخص نشده باشد ، از مجموعه پیش فرض استفاده می شود.

useLocaleFromApp

boolean

آیا می توان اطلاعات محلی را از برنامه میزبان منتقل کرد.

homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در هر زمینه و در هر میزبان اجرا می شود. هر کارت تولید شده توسط این عملکرد همیشه در دسترس کاربر خواهد بود ، اما ممکن است وقتی این افزودنی محرک های هدفمندتری را اعلام کند ، توسط محتوای متنی گرفتار شود.

universalActions[]

object ( UniversalActionExtensionPoint )

لیستی از نقاط پسوند را در منوی Action Universal تعریف می کند که به عنوان منوی تنظیمات برای افزودنی خدمت می کند. نقطه فرمت می تواند یک URL پیوند برای باز یا نقطه پایانی برای اجرای به عنوان ارسال فرم باشد.

openLinkUrlPrefixes

array ( ListValue format)

یک عمل OpenLink فقط می تواند از URL با طرح HTTPS ، MAILTO یا TEL استفاده کند. برای پیوندهای HTTPS ، URL همچنین باید با یکی از پیشوندهای مشخص شده در لیست مجاز مطابقت داشته باشد . اگر پیشوند این طرح را حذف کند ، HTTPS فرض می شود. پیوندهای HTTP به طور خودکار به پیوندهای HTTPS بازنویسی می شوند.

برنامه های

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

نمایندگی JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
فیلدها
primaryColor

string

رنگ اصلی افزودنی. رنگ نوار ابزار را تنظیم می کند. اگر رنگ اصلی تنظیم نشده باشد ، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.

secondaryColor

string

رنگ ثانویه افزودنی. رنگ دکمه ها را تنظیم می کند. اگر رنگ اصلی تنظیم شده باشد اما هیچ رنگ ثانویه تنظیم نشده است ، رنگ ثانویه همان رنگ اصلی است. اگر نه رنگ اولیه و نه رنگ ثانویه تنظیم نشده باشد ، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.

useNewMaterialDesign

boolean

طراحی مواد را برای کارت ها امکان پذیر می کند.

adtonwidgetset

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

نمایندگی JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
فیلدها
usedWidgets[]

enum ( WidgetType )

لیست ابزارک های مورد استفاده در یک افزودنی.

از نوع

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

Enums
WIDGET_TYPE_UNSPECIFIED مجموعه ویجت پیش فرض.
DATE_PICKER انتخاب کننده تاریخ
STYLED_BUTTONS دکمه های یک ظاهر طراحی شده شامل دکمه های پر شده و دکمه های غیرفعال است.
PERSISTENT_FORMS اشکال مداوم اجازه می دهد تا مقادیر فرم پایدار در حین اقدامات.
UPDATE_SUBJECT_AND_RECIPIENTS موضوع و گیرندگان پیش نویس را به روز کنید.
GRID_WIDGET ویجت شبکه.
ADDON_COMPOSE_UI_ACTION یک عمل افزودنی Gmail که مربوط به UI افزودنی است.

صفحه اصلی

قالب مشترک برای اعلام نمای صفحه اصلی افزودنی.

نمایندگی JSON 
{
  "runFunction": string,
  "enabled": boolean
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

enabled

boolean

اختیاری. اگر روی false تنظیم شود ، در این زمینه نمای صفحه اصلی را غیرفعال می کند.

true فرض در صورت عدم استفاده.

اگر نمای خانگی سفارشی یک افزودنی غیرفعال باشد ، به جای آن یک کارت نمای کلی برای کاربران ارائه می شود.

UniversalactionExtionPoint

قالب برای اعلام یک نقطه فرمت آیتم منوی عملکرد جهانی.

نمایندگی JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
label

string

مورد نیاز. متن قابل مشاهده با کاربر که عملکرد انجام شده با فعال کردن این نقطه پسوند را توصیف می کند ، به عنوان مثال ، "یک مخاطب جدید اضافه کنید."

Union Field action_type . مورد نیاز. نوع عمل در یک مورد منوی عملکرد جهانی پشتیبانی می شود. این می تواند پیوندی برای باز کردن باشد یا یک نقطه پایانی برای اجرای آن. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که توسط Universalaction اداره می شود.

gmailaddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی Gmail.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در زمینه هایی اجرا می شود که با یک ماشه متنی اعلام شده مطابقت ندارد. هر کارت تولید شده توسط این عملکرد همیشه در دسترس کاربر خواهد بود ، اما ممکن است وقتی این افزودنی محرک های هدفمندتری را اعلام می کند ، توسط محتوای متنی گرفتار شود.

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

contextualTriggers[]

object ( ContextualTrigger )

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

universalActions[]

object ( UniversalAction )

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

composeTrigger

object ( ComposeTrigger )

ماشه زمان آهنگسازی را برای افزودنی زمان آهنگسازی تعریف می کند. این ماشه ای است که باعث می شود یک افزودنی در هنگام تهیه یک ایمیل ، اقدام به اقدام کند. تمام افزودنیهای زمان آهنگسازی باید دامنه gmail.addons.current.action.compose را داشته باشند ، حتی اگر ممکن است پیش نویس را ویرایش نکند.

authorizationCheckFunction

string

نام یک نقطه پایانی که تأیید می کند که افزودنی با بررسی API های شخص ثالث ، تمام مجوزهای شخص ثالث مورد نیاز را دارد. در صورت عدم موفقیت کاوشگر ، عملکرد باید یک استثنا را برای شروع جریان مجوز پرتاب کند. این عملکرد قبل از هر دعوت از افزودنی فراخوانی می شود تا از یک تجربه کاربر صاف اطمینان حاصل شود.

زمینه ساز

ماشه ای را تعریف می کند که هنگام رعایت ایمیل باز با معیارهای خاص آتش می گیرد. هنگامی که ماشه آتش می گیرد ، معمولاً به منظور ایجاد کارتهای جدید و به روزرسانی UI ، یک نقطه پایانی خاص را اجرا می کند.

نمایندگی JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
فیلدها
onTriggerFunction

string

مورد نیاز. نام نقطه پایانی برای تماس با پیام با ماشه تماس می گیرد.

trigger میدان اتحادیه. نوع ماشه شرایطی را که Gmail برای نشان دادن افزودنی استفاده می کند ، تعیین می کند. trigger فقط می تواند یکی از موارد زیر باشد:
unconditional

object ( UnconditionalTrigger )

محرک های بدون قید و شرط هنگام باز شدن هر پیام پستی اجرا می شوند.

بدون شرط

این نوع هیچ فیلدی ندارد.

ماشه ای که هنگام باز شدن هر پیام ایمیل شلیک می کند.

جهانی سازی

عملی که همیشه بدون در نظر گرفتن متن پیام در منوی نوار ابزار افزودنی موجود است.

نمایندگی JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
text

string

مورد نیاز. به عنوان مثال ، متن قابل مشاهده با کاربر که عملکرد را توصیف می کند ، "یک مخاطب جدید اضافه کنید."

Union Field action_type . نوع عمل رفتار Gmail را هنگامی که کاربر از عمل فراخوانی می کند ، تعیین می کند. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که وقتی کاربر باعث عمل می شود ، فراخوانی می شود. برای جزئیات بیشتر به راهنمای اقدامات جهانی مراجعه کنید.

ترکیب کننده

ماشه ای که هنگام تشکیل ایمیل فعال می شود ، فعال می شود.

نمایندگی JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
فیلدها
actions[]

object ( MenuItemExtensionPoint )

مجموعه اقدامات را برای افزودنی زمان آهنگسازی تعریف می کند. این اقداماتی است که کاربران می توانند در یک افزودنی زمان آهنگسازی ایجاد کنند.

draftAccess

enum ( DraftAccess )

هنگام ایجاد یک افزودنی زمان آهنگسازی ، سطح دسترسی به داده ها را تعریف می کند.

پیش بینی

enum که سطح دسترسی به داده ها را تعریف می کند که ماشه آهنگسازی نیاز دارد.

Enums
UNSPECIFIED مقدار پیش فرض هنگامی که هیچ چیز برای پیش نویس تنظیم نشده است.
NONE ماشه آهنگسازی در هنگام ایجاد یک افزودنی آهنگسازی نمی تواند به هیچ داده ای از پیش نویس دسترسی پیدا کند.
METADATA هنگام ایجاد یک افزودنی از آهنگسازی ، مجوز دسترسی به ابرداده پیش نویس را به شما می دهد. این شامل لیست مخاطبان مانند لیست TO و CC از پیش نویس پیام است.

diveaddonmanifest

خواص سفارشی سازی ظاهر و اجرای یک افزودنی درایو.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

onItemsSelectedTrigger

object ( DriveExtensionPoint )

مطابق با رفتاری است که هنگام انتخاب موارد در نمای درایو مربوطه ، مانند Doclist My Drive ، اجرا می شود.

driveextionpoint

فرمت مشترک برای اعلام محرک های افزودنی درایو.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای زمان فعال شدن نقطه پسوند.

calendaraddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی تقویم.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در زمینه هایی اجرا می شود که با یک ماشه متنی اعلام شده مطابقت ندارد. هر کارت تولید شده توسط این عملکرد همیشه در دسترس کاربر خواهد بود ، اما ممکن است وقتی این افزودنی محرک های هدفمندتری را اعلام کند ، توسط محتوای متنی گرفتار شود.

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

conferenceSolution[]

object ( ConferenceSolution )

راه حل های کنفرانس ارائه شده توسط این افزودنی را تعریف می کند. افزودنی های کنفرانس شخص ثالث فقط می توانند در اسکریپت برنامه ها ساخته شوند.

createSettingsUrlFunction

string

نقطه پایانی برای اجرای آن که URL را در صفحه تنظیمات افزودنی ایجاد می کند.

eventOpenTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام باز شدن یک رویداد برای مشاهده یا ویرایش ایجاد می شود.

eventUpdateTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام بروزرسانی رویداد باز باعث ایجاد می شود.

eventAttachmentTrigger

object ( MenuItemExtensionPoint )

پیکربندی برای یک ماشه متنی که هنگام کلیک کاربر بر روی ارائه دهنده پیوست افزودنی در منوی کشویی تقویم ، آتش می گیرد.

currentEventAccess

enum ( EventAccess )

هنگام ایجاد افزودنی رویداد ، سطح دسترسی به داده ها را تعریف می کند.

کنفرانس

ارزشهای مربوط به کنفرانس را تعریف می کند. افزودنی های کنفرانس شخص ثالث فقط می توانند در اسکریپت برنامه ها ساخته شوند.

نمایندگی JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
فیلدها
onCreateFunction

string

مورد نیاز. نقطه پایانی هنگام ایجاد داده های کنفرانس باید تماس بگیرید.

id

string

مورد نیاز. IDS باید منحصر به فرد در راه حل های کنفرانس در یک افزودنی اختصاص یابد ، در غیر این صورت ممکن است از راه حل اشتباه کنفرانس هنگام ایجاد افزودنی استفاده شود. در حالی که می توانید نام نمایشگر یک افزودنی را تغییر دهید ، شناسه نباید تغییر کند.

name

string

مورد نیاز. نام نمایش راه حل کنفرانس.

logoUrl

string

مورد نیاز. URL برای تصویر آرم راه حل کنفرانس.

تقویم

قالب مشترک برای اعلام محرک های افزودنی تقویم.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

حادثه

یک enum که سطح رویداد دسترسی به داده ها را تعریف می کند.

Enums
UNSPECIFIED مقدار پیش فرض هنگامی که هیچ چیز برای EventAccess تنظیم نشده است.
METADATA باعث می شود که رویداد اجازه دسترسی به ابرداده رویدادها ، مانند شناسه رویداد و شناسه تقویم را داشته باشد.
READ دسترسی به رویداد را به همه زمینه های رویداد ارائه شده از جمله ابرداده ، شرکت کنندگان و داده های کنفرانس دسترسی می دهد.
WRITE دسترسی به رویداد را به ابرداده رویدادها و امکان انجام کلیه اقدامات از جمله اضافه کردن شرکت کنندگان و تنظیم داده های کنفرانس می دهد.
READ_WRITE دسترسی به رویداد را به همه زمینه های رویداد ارائه شده از جمله ابرداده ، شرکت کنندگان و داده های کنفرانس و امکان انجام کلیه اقدامات می دهد.

docsaddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی Google Docs.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

onFileScopeGrantedTrigger

object ( DocsExtensionPoint )

نقطه پایان برای اجرای هنگامی که مجوز دامنه پرونده برای این سند/جفت کاربر اعطا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

لیستی از نقاط پسوند برای پیش نمایش پیوندها در یک سند Google Docs. برای جزئیات بیشتر ، به پیوندهای پیش نمایش با تراشه های هوشمند مراجعه کنید.

createActionTriggers[]

object ( CreateActionExtensionPoint )

لیستی از نقاط پسوند برای ایجاد منابع شخص ثالث از طریق برنامه های فضای کاری Google. برای اطلاعات بیشتر ، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

docsextoint

فرمت مشترک برای اعلام محرک های افزودنی Docs.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

linkpreviewextionpoint

پیکربندی یک ماشه که هنگامی که کاربر لینک می کند یا پیوندی را از یک سرویس شخص ثالث یا غیر Google به یک پرونده Google Docs ، برگه یا اسلایدها می چسباند ، شلیک می کند.

نمایندگی JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
فیلدها
labelText

string

مورد نیاز. متن به عنوان مثال تراشه هوشمند که باعث می شود کاربران برای پیش نمایش لینک مانند Example: Support case . این متن استاتیک است و قبل از اجرای کاربران افزودنی نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبانهای دیگر. زبان را در ISO 639 و کشور/منطقه در ISO 3166 قالب بندی کنید ، که توسط یک Hyphen از هم جدا شده است - . به عنوان مثال ، en-US .

اگر محلی کاربر در کلیدهای نقشه موجود باشد ، کاربر نسخه محلی شده از labeltext را می بیند.

یک شیء حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

patterns[]

object ( UriPattern )

مورد نیاز. مجموعه ای از الگوهای URL که باعث افزودنی پیوندهای پیش نمایش می شود.

runFunction

string

مورد نیاز. نقطه پایان برای اجرای هنگامی که پیش نمایش پیوند ایجاد می شود.

logoUrl

string

اختیاری. نمادی که در کارت هوشمند تراشه و پیش نمایش نمایش داده می شود. در صورت حذف ، افزودنی از نماد نوار ابزار خود ، logourl استفاده می کند.

عیاشی

پیکربندی برای هر الگوی URL که باعث پیش نمایش پیوند می شود.

نمایندگی JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
فیلدها
hostPattern

string

برای پیش نمایش برای هر الگوی URL لازم است. دامنه الگوی URL. پیوندهای افزودنی پیوندهایی که حاوی این دامنه در URL هستند. برای پیش نمایش پیوندها برای یک زیر دامنه خاص ، مانند subdomain.example.com ، زیر دامنه را درج کنید. برای پیش نمایش پیوندها برای کل دامنه ، یک شخصیت Wildcard را با ستاره ( * ) به عنوان زیر دامنه مشخص کنید.

به عنوان مثال ، *.example.com با subdomain.example.com و another.subdomain.example.com مطابقت دارد.

pathPrefix

string

اختیاری. مسیری که دامنه hostpattern را ضمیمه می کند.

به عنوان مثال cases اگر الگوی میزبان URL support.example.com support.example.com/cases/ شود.

برای مطابقت با تمام URL های موجود در دامنه الگوی میزبان ، pathprefix خالی بگذارید.

createactionextionpoint

پیکربندی یک ماشه که هنگام استفاده از کاربر از گردش کار ایجاد منبع در یک برنامه فضای کاری Google استفاده می کند. برای اطلاعات بیشتر ، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

نمایندگی JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
فیلدها
id

string

مورد نیاز. شناسه منحصر به فرد برای تمایز این نقطه پسوند. شناسه می تواند حداکثر 64 کاراکتر داشته باشد و باید در قالب [a-zA-Z0-9-]+ باشد.

labelText

string

مورد نیاز. متنی که در کنار یک نماد برای نقطه ورود به ایجاد منابع ، مانند Create support case نمایش داده می شود. این متن استاتیک است و قبل از اجرای کاربران افزودنی نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبانهای دیگر. زبان را در ISO 639 و کشور/منطقه در ISO 3166 قالب بندی کنید ، که توسط یک Hyphen از هم جدا شده است - . به عنوان مثال ، en-US .

اگر محلی کاربر در کلیدهای نقشه موجود باشد ، کاربر نسخه محلی شده از labeltext را می بیند.

یک شیء حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

runFunction

string

مورد نیاز. نقطه پایانی برای اجرای هنگامی که یک گردش کار ایجاد منبع برای ایجاد پیوند ایجاد می شود.

logoUrl

string

اختیاری. نمادی که برای نقطه ورود منبع ایجاد می کند. در صورت حذف ، این منو از نماد نوار ابزار افزودنی شما ، logourl استفاده می کند.

sheetsaddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی Google Sheets.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

onFileScopeGrantedTrigger

object ( SheetsExtensionPoint )

نقطه پایان برای اجرای هنگامی که مجوز دامنه پرونده برای این سند/جفت کاربر اعطا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

لیستی از نقاط پسوند برای پیش نمایش پیوندها در یک سند Google Sheets. برای جزئیات بیشتر ، به پیوندهای پیش نمایش با تراشه های هوشمند مراجعه کنید.

صفحه

فرمت مشترک برای اعلام محرک های افزودنی ورق.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

SlidesaddonManifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی Google Slides.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

onFileScopeGrantedTrigger

object ( SlidesExtensionPoint )

نقطه پایان برای اجرای هنگامی که مجوز دامنه پرونده برای این سند/جفت کاربر اعطا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

لیستی از نقاط پسوند برای پیش نمایش پیوندها در یک سند Slides Google. برای جزئیات بیشتر ، به پیوندهای پیش نمایش با تراشه های هوشمند مراجعه کنید.

نقطه لغزش

فرمت مشترک برای اعلام محرک های اضافی اسلایدها.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

httpoptions

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

نمایندگی JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
فیلدها
authorizationHeader

enum ( HttpAuthorizationHeader )

پیکربندی برای نشانه ارسال شده در عنوان مجوز HTTP .

httpauthorizationHeader

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

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

روش ها

create

 استقرار را با نام و پیکربندی مشخص شده ایجاد می کند.

delete

 استقرار را با نام داده شده حذف می کند.

get

 استقرار را با نام مشخص می کند.

getInstallStatus

 وضعیت نصب یک تست را دریافت می کند.

install

 برای آزمایش یک استقرار به حساب خود نصب می کند.

list

 کلیه استقرارها را در یک پروژه خاص لیست می کند.

replaceDeployment

 استقرار را با نام مشخص شده ایجاد یا جایگزین می کند.

uninstall

 استقرار آزمایش را از حساب کاربر حذف کنید.
،

منبع: استقرار

استقرار افزودنی فضای کاری Google

نمایندگی JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
فیلدها
name

string

نام منابع استقرار. مثال: projects/123/deployments/my_deployment .

oauthScopes[]

string

لیست Scopes Google OAuth که قبل از اجرای یک نقطه پایانی افزودنی ، درخواست رضایت از کاربر نهایی را می دهند.

addOns

object ( AddOns )

پیکربندی افزودنی فضای کاری Google.

etag

string

این مقدار توسط سرور بر اساس نسخه استقرار در ذخیره سازی محاسبه می شود و ممکن است در مورد به روزرسانی و حذف درخواست ها ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه ارزش به روز دارد.

ترکیب

پیکربندی افزودنی فضای کاری Google.

نمایندگی JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
فیلدها
common

object ( CommonAddOnManifest )

پیکربندی که در تمام افزودنیهای فضای کاری Google متداول است.

gmail

object ( GmailAddOnManifest )

پیکربندی افزودنی Gmail.

drive

object ( DriveAddOnManifest )

پیکربندی افزودنی را درایو کنید.

calendar

object ( CalendarAddOnManifest )

پیکربندی افزودنی تقویم.

docs

object ( DocsAddOnManifest )

پیکربندی افزودنی اسناد.

sheets

object ( SheetsAddOnManifest )

پیکربندی افزودنی ورق ها.

slides

object ( SlidesAddOnManifest )

پیکربندی افزودنی اسلایدها.

httpOptions

object ( HttpOptions )

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

CommonaddonManifest

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

نمایندگی JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
فیلدها
name

string

مورد نیاز. نام نمایشگاه افزودنی.

logoUrl

string

مورد نیاز. URL برای تصویر آرم نشان داده شده در نوار ابزار افزودنی.

layoutProperties

object ( LayoutProperties )

خصوصیات چیدمان مشترک برای کارتهای افزودنی.

addOnWidgetSet

object ( AddOnWidgetSet )

ابزارک های مورد استفاده در افزودنی. اگر این قسمت مشخص نشده باشد ، از مجموعه پیش فرض استفاده می شود.

useLocaleFromApp

boolean

آیا می توان اطلاعات محلی را از برنامه میزبان منتقل کرد.

homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در هر زمینه و در هر میزبان اجرا می شود. هر کارت تولید شده توسط این عملکرد همیشه در دسترس کاربر خواهد بود ، اما ممکن است وقتی این افزودنی محرک های هدفمندتری را اعلام کند ، توسط محتوای متنی گرفتار شود.

universalActions[]

object ( UniversalActionExtensionPoint )

لیستی از نقاط پسوند را در منوی Action Universal تعریف می کند که به عنوان منوی تنظیمات برای افزودنی خدمت می کند. نقطه فرمت می تواند یک URL پیوند برای باز یا نقطه پایانی برای اجرای به عنوان ارسال فرم باشد.

openLinkUrlPrefixes

array ( ListValue format)

یک عمل OpenLink فقط می تواند از URL با طرح HTTPS ، MAILTO یا TEL استفاده کند. برای پیوندهای HTTPS ، URL همچنین باید با یکی از پیشوندهای مشخص شده در لیست مجاز مطابقت داشته باشد . اگر پیشوند این طرح را حذف کند ، HTTPS فرض می شود. پیوندهای HTTP به طور خودکار به پیوندهای HTTPS بازنویسی می شوند.

برنامه های

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

نمایندگی JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
فیلدها
primaryColor

string

رنگ اصلی افزودنی. رنگ نوار ابزار را تنظیم می کند. اگر رنگ اصلی تنظیم نشده باشد ، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.

secondaryColor

string

رنگ ثانویه افزودنی. رنگ دکمه ها را تنظیم می کند. اگر رنگ اصلی تنظیم شده باشد اما هیچ رنگ ثانویه تنظیم نشده است ، رنگ ثانویه همان رنگ اصلی است. اگر نه رنگ اولیه و نه رنگ ثانویه تنظیم نشده باشد ، از مقدار پیش فرض ارائه شده توسط چارچوب استفاده می شود.

useNewMaterialDesign

boolean

طراحی مواد را برای کارت ها امکان پذیر می کند.

adtonwidgetset

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

نمایندگی JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
فیلدها
usedWidgets[]

enum ( WidgetType )

لیست ابزارک های مورد استفاده در یک افزودنی.

از نوع

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

Enums
WIDGET_TYPE_UNSPECIFIED مجموعه ویجت پیش فرض.
DATE_PICKER انتخاب کننده تاریخ
STYLED_BUTTONS دکمه های یک ظاهر طراحی شده شامل دکمه های پر شده و دکمه های غیرفعال است.
PERSISTENT_FORMS اشکال مداوم اجازه می دهد تا مقادیر فرم پایدار در حین اقدامات.
UPDATE_SUBJECT_AND_RECIPIENTS موضوع و گیرندگان پیش نویس را به روز کنید.
GRID_WIDGET ویجت شبکه.
ADDON_COMPOSE_UI_ACTION یک عمل افزودنی Gmail که مربوط به UI افزودنی است.

صفحه اصلی

قالب مشترک برای اعلام نمای صفحه اصلی افزودنی.

نمایندگی JSON 
{
  "runFunction": string,
  "enabled": boolean
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

enabled

boolean

اختیاری. اگر روی false تنظیم شود ، در این زمینه نمای صفحه اصلی را غیرفعال می کند.

true فرض در صورت عدم استفاده.

اگر نمای خانگی سفارشی یک افزودنی غیرفعال باشد ، به جای آن یک کارت نمای کلی برای کاربران ارائه می شود.

UniversalactionExtionPoint

قالب برای اعلام یک نقطه فرمت آیتم منوی عملکرد جهانی.

نمایندگی JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
label

string

مورد نیاز. متن قابل مشاهده با کاربر که عملکرد انجام شده با فعال کردن این نقطه پسوند را توصیف می کند ، به عنوان مثال ، "یک مخاطب جدید اضافه کنید."

Union Field action_type . مورد نیاز. نوع عمل در یک مورد منوی عملکرد جهانی پشتیبانی می شود. این می تواند پیوندی برای باز کردن باشد یا یک نقطه پایانی برای اجرای آن. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که توسط Universalaction اداره می شود.

gmailaddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی Gmail.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در زمینه هایی اجرا می شود که با یک ماشه متنی اعلام شده مطابقت ندارد. هر کارت تولید شده توسط این عملکرد همیشه در دسترس کاربر خواهد بود ، اما ممکن است وقتی این افزودنی محرک های هدفمندتری را اعلام می کند ، توسط محتوای متنی گرفتار شود.

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

contextualTriggers[]

object ( ContextualTrigger )

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

universalActions[]

object ( UniversalAction )

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

composeTrigger

object ( ComposeTrigger )

ماشه زمان آهنگسازی را برای افزودنی زمان آهنگسازی تعریف می کند. این ماشه ای است که باعث می شود یک افزودنی در هنگام تهیه یک ایمیل ، اقدام به اقدام کند. تمام افزودنیهای زمان آهنگسازی باید دامنه gmail.addons.current.action.compose را داشته باشند ، حتی اگر ممکن است پیش نویس را ویرایش نکند.

authorizationCheckFunction

string

نام یک نقطه پایانی که تأیید می کند که افزودنی با بررسی API های شخص ثالث ، تمام مجوزهای شخص ثالث مورد نیاز را دارد. در صورت عدم موفقیت کاوشگر ، عملکرد باید یک استثنا را برای شروع جریان مجوز پرتاب کند. این عملکرد قبل از هر دعوت از افزودنی فراخوانی می شود تا از یک تجربه کاربر صاف اطمینان حاصل شود.

زمینه ساز

ماشه ای را تعریف می کند که هنگام رعایت ایمیل باز با معیارهای خاص آتش می گیرد. هنگامی که ماشه آتش می گیرد ، معمولاً به منظور ایجاد کارتهای جدید و به روزرسانی UI ، یک نقطه پایانی خاص را اجرا می کند.

نمایندگی JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
فیلدها
onTriggerFunction

string

مورد نیاز. نام نقطه پایانی برای تماس با پیام با ماشه تماس می گیرد.

trigger میدان اتحادیه. نوع ماشه شرایطی را که Gmail برای نشان دادن افزودنی استفاده می کند ، تعیین می کند. trigger فقط می تواند یکی از موارد زیر باشد:
unconditional

object ( UnconditionalTrigger )

محرک های بدون قید و شرط هنگام باز شدن هر پیام پستی اجرا می شوند.

بدون شرط

این نوع هیچ فیلدی ندارد.

ماشه ای که هنگام باز شدن هر پیام ایمیل شلیک می کند.

جهانی سازی

عملی که همیشه بدون در نظر گرفتن متن پیام در منوی نوار ابزار افزودنی موجود است.

نمایندگی JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
فیلدها
text

string

مورد نیاز. به عنوان مثال ، متن قابل مشاهده با کاربر که عملکرد را توصیف می کند ، "یک مخاطب جدید اضافه کنید."

Union Field action_type . نوع عمل رفتار Gmail را هنگامی که کاربر از عمل فراخوانی می کند ، تعیین می کند. action_type فقط می تواند یکی از موارد زیر باشد:
runFunction

string

نقطه پایانی که وقتی کاربر باعث عمل می شود ، فراخوانی می شود. برای جزئیات بیشتر به راهنمای اقدامات جهانی مراجعه کنید.

ترکیب کننده

ماشه ای که هنگام تشکیل ایمیل فعال می شود ، فعال می شود.

نمایندگی JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
فیلدها
actions[]

object ( MenuItemExtensionPoint )

مجموعه اقدامات را برای افزودنی زمان آهنگسازی تعریف می کند. این اقداماتی است که کاربران می توانند در یک افزودنی زمان آهنگسازی ایجاد کنند.

draftAccess

enum ( DraftAccess )

هنگام ایجاد یک افزودنی زمان آهنگسازی ، سطح دسترسی به داده ها را تعریف می کند.

پیش بینی

enum که سطح دسترسی به داده ها را تعریف می کند که ماشه آهنگسازی نیاز دارد.

Enums
UNSPECIFIED مقدار پیش فرض هنگامی که هیچ چیز برای پیش نویس تنظیم نشده است.
NONE ماشه آهنگسازی در هنگام ایجاد یک افزودنی آهنگسازی نمی تواند به هیچ داده ای از پیش نویس دسترسی پیدا کند.
METADATA هنگام ایجاد یک افزودنی از آهنگسازی ، مجوز دسترسی به ابرداده پیش نویس را به شما می دهد. این شامل لیست مخاطبان مانند لیست TO و CC از پیش نویس پیام است.

diveaddonmanifest

خواص سفارشی سازی ظاهر و اجرای یک افزودنی درایو.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

onItemsSelectedTrigger

object ( DriveExtensionPoint )

مطابق با رفتاری است که هنگام انتخاب موارد در نمای درایو مربوطه ، مانند Doclist My Drive ، اجرا می شود.

driveextionpoint

فرمت مشترک برای اعلام محرک های افزودنی درایو.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای زمان فعال شدن نقطه پسوند.

calendaraddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی تقویم.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

نقطه پایانی را تعریف می کند که در زمینه هایی اجرا می شود که با یک ماشه متنی اعلام شده مطابقت ندارد. هر کارت تولید شده توسط این عملکرد همیشه در دسترس کاربر خواهد بود ، اما ممکن است وقتی این افزودنی محرک های هدفمندتری را اعلام کند ، توسط محتوای متنی گرفتار شود.

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

conferenceSolution[]

object ( ConferenceSolution )

راه حل های کنفرانس ارائه شده توسط این افزودنی را تعریف می کند. افزودنی های کنفرانس شخص ثالث فقط می توانند در اسکریپت برنامه ها ساخته شوند.

createSettingsUrlFunction

string

نقطه پایانی برای اجرای آن که URL را در صفحه تنظیمات افزودنی ایجاد می کند.

eventOpenTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام باز شدن یک رویداد برای مشاهده یا ویرایش ایجاد می شود.

eventUpdateTrigger

object ( CalendarExtensionPoint )

نقطه پایانی که هنگام بروزرسانی رویداد باز باعث ایجاد می شود.

eventAttachmentTrigger

object ( MenuItemExtensionPoint )

پیکربندی برای یک ماشه متنی که هنگام کلیک کاربر بر روی ارائه دهنده پیوست افزودنی در منوی کشویی تقویم ، آتش می گیرد.

currentEventAccess

enum ( EventAccess )

هنگام ایجاد افزودنی رویداد ، سطح دسترسی به داده ها را تعریف می کند.

کنفرانس

ارزشهای مربوط به کنفرانس را تعریف می کند. افزودنی های کنفرانس شخص ثالث فقط می توانند در اسکریپت برنامه ها ساخته شوند.

نمایندگی JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
فیلدها
onCreateFunction

string

مورد نیاز. نقطه پایانی هنگام ایجاد داده های کنفرانس باید تماس بگیرید.

id

string

مورد نیاز. IDS باید منحصر به فرد در راه حل های کنفرانس در یک افزودنی اختصاص یابد ، در غیر این صورت ممکن است از راه حل اشتباه کنفرانس هنگام ایجاد افزودنی استفاده شود. در حالی که می توانید نام نمایشگر یک افزودنی را تغییر دهید ، شناسه نباید تغییر کند.

name

string

مورد نیاز. نام نمایش راه حل کنفرانس.

logoUrl

string

مورد نیاز. URL برای تصویر آرم راه حل کنفرانس.

تقویم

قالب مشترک برای اعلام محرک های افزودنی تقویم.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

حادثه

یک enum که سطح رویداد دسترسی به داده ها را تعریف می کند.

Enums
UNSPECIFIED مقدار پیش فرض هنگامی که هیچ چیز برای EventAccess تنظیم نشده است.
METADATA باعث می شود که رویداد اجازه دسترسی به ابرداده رویدادها ، مانند شناسه رویداد و شناسه تقویم را داشته باشد.
READ دسترسی به رویداد را به همه زمینه های رویداد ارائه شده از جمله ابرداده ، شرکت کنندگان و داده های کنفرانس دسترسی می دهد.
WRITE دسترسی به رویداد را به ابرداده رویدادها و امکان انجام کلیه اقدامات از جمله اضافه کردن شرکت کنندگان و تنظیم داده های کنفرانس می دهد.
READ_WRITE دسترسی به رویداد را به همه زمینه های رویداد ارائه شده از جمله ابرداده ، شرکت کنندگان و داده های کنفرانس و امکان انجام کلیه اقدامات می دهد.

docsaddonmanifest

خواص شخصی سازی ظاهر و اجرای یک افزودنی Google Docs.

نمایندگی JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

در صورت وجود ، این پیکربندی را از addons.common.homepageTrigger غلبه می کند.

onFileScopeGrantedTrigger

object ( DocsExtensionPoint )

نقطه پایان برای اجرای هنگامی که مجوز دامنه پرونده برای این سند/جفت کاربر اعطا می شود.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

لیستی از نقاط پسوند برای پیش نمایش پیوندها در یک سند Google Docs. برای جزئیات بیشتر ، به پیوندهای پیش نمایش با تراشه های هوشمند مراجعه کنید.

createActionTriggers[]

object ( CreateActionExtensionPoint )

لیستی از نقاط پسوند برای ایجاد منابع شخص ثالث از طریق برنامه های فضای کاری Google. برای اطلاعات بیشتر ، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

docsextoint

فرمت مشترک برای اعلام محرک های افزودنی Docs.

نمایندگی JSON 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. نقطه پایانی برای اجرای این نقطه پسوند.

linkpreviewextionpoint

پیکربندی یک ماشه که هنگامی که کاربر لینک می کند یا پیوندی را از یک سرویس شخص ثالث یا غیر Google به یک پرونده Google Docs ، برگه یا اسلایدها می چسباند ، شلیک می کند.

نمایندگی JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
فیلدها
labelText

string

مورد نیاز. متن به عنوان مثال تراشه هوشمند که باعث می شود کاربران برای پیش نمایش لینک مانند Example: Support case . این متن استاتیک است و قبل از اجرای کاربران افزودنی نمایش داده می شود.

localizedLabelText

map (key: string, value: string)

اختیاری. نقشه ای از labeltext برای بومی سازی به زبانهای دیگر. زبان را در ISO 639 و کشور/منطقه در ISO 3166 قالب بندی کنید ، که توسط یک Hyphen از هم جدا شده است - . به عنوان مثال ، en-US .

اگر محلی کاربر در کلیدهای نقشه موجود باشد ، کاربر نسخه محلی شده از labeltext را می بیند.

یک شیء حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

patterns[]

object ( UriPattern )

مورد نیاز. مجموعه ای از الگوهای URL که باعث افزودنی پیوندهای پیش نمایش می شود.

runFunction

string

مورد نیاز. نقطه پایان برای اجرای هنگامی که پیش نمایش پیوند ایجاد می شود.

logoUrl

string

اختیاری. نمادی که در کارت هوشمند تراشه و پیش نمایش نمایش داده می شود. در صورت حذف ، افزودنی از نماد نوار ابزار خود ، logourl استفاده می کند.

عیاشی

پیکربندی برای هر الگوی URL که باعث پیش نمایش پیوند می شود.

نمایندگی JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
فیلدها
hostPattern

string

برای پیش نمایش برای هر الگوی URL لازم است. دامنه الگوی URL. پیوندهای افزودنی پیوندهایی که حاوی این دامنه در URL هستند. برای پیش نمایش پیوندها برای یک زیر دامنه خاص ، مانند subdomain.example.com ، زیر دامنه را درج کنید. برای پیش نمایش پیوندها برای کل دامنه ، یک شخصیت Wildcard را با ستاره ( * ) به عنوان زیر دامنه مشخص کنید.

به عنوان مثال ، *.example.com با subdomain.example.com و another.subdomain.example.com مطابقت دارد.

pathPrefix

string

اختیاری. مسیری که دامنه hostpattern را ضمیمه می کند.

به عنوان مثال cases اگر الگوی میزبان URL support.example.com support.example.com/cases/ شود.

To match all URLs in the host pattern domain, leave pathprefix empty.

CreateActionExtensionPoint

The configuration for a trigger that fires when a user invokes the resource creation workflow in a Google Workspace application. For more information, see Create third-party resources from the @ menu .

JSON representation 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
فیلدها
id

string

مورد نیاز. The unique ID to differentiate this extension point. The ID can have up to 64 characters and should be in the format of [a-zA-Z0-9-]+ .

labelText

string

مورد نیاز. The text that displays alongside an icon for the resource creation entry point, such as Create support case . This text is static and displays before users execute the add-on.

localizedLabelText

map (key: string, value: string)

اختیاری. A map of labeltext to localize into other languages. Format the language in ISO 639 and the country/region in ISO 3166 , separated by a hyphen - . For example, en-US .

If a user's locale is present in the map's keys, the user sees the localized version of the labeltext .

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

runFunction

string

مورد نیاز. Endpoint to execute when a resource creation workflow is triggered to create a link.

logoUrl

string

اختیاری. The icon that displays for the resource creation entry point. If omitted, the menu uses your add-on's toolbar icon, logourl .

SheetsAddOnManifest

Properties customizing the appearance and execution of a Google Sheets add-on.

JSON representation 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

If present, this overrides the configuration from addons.common.homepageTrigger .

onFileScopeGrantedTrigger

object ( SheetsExtensionPoint )

Endpoint to execute when file scope authorization is granted for this document/user pair.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

A list of extension points for previewing links in a Google Sheets document. For details, see Preview links with smart chips .

SheetsExtensionPoint

Common format for declaring a Sheets add-on's triggers.

JSON representation 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. The endpoint to execute when this extension point is activated.

SlidesAddOnManifest

Properties customizing the appearance and execution of a Google Slides add-on.

JSON representation 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

If present, this overrides the configuration from addons.common.homepageTrigger .

onFileScopeGrantedTrigger

object ( SlidesExtensionPoint )

Endpoint to execute when file scope authorization is granted for this document/user pair.

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

A list of extension points for previewing links in a Google Slides document. For details, see Preview links with smart chips .

SlidesExtensionPoint

Common format for declaring a Slides add-on's triggers.

JSON representation 
{
  "runFunction": string
}
فیلدها
runFunction

string

مورد نیاز. The endpoint to execute when this extension point is activated.

HttpOptions

Options for sending requests to add-on HTTP endpoints.

JSON representation 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
فیلدها
authorizationHeader

enum ( HttpAuthorizationHeader )

Configuration for the token sent in the HTTP Authorization header.

HttpAuthorizationHeader

Authorization header sent in add-on HTTP requests.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Default value, equivalent to SYSTEM_ID_TOKEN .
SYSTEM_ID_TOKEN Send an ID token for the project-specific Google Workspace Add-on's system service account (default).
USER_ID_TOKEN Send an ID token for the end user.
NONE Do not send an Authentication header.

روش ها

create

 Creates a deployment with the specified name and configuration.

delete

 Deletes the deployment with the given name.

get

 Gets the deployment with the specified name.

getInstallStatus

 Gets the install status of a test deployment.

install

 Installs a deployment to your account for testing.

list

 Lists all deployments in a particular project.

replaceDeployment

 Creates or replaces a deployment with the specified name.

uninstall

 Uninstalls a test deployment from the user's account.