REST Resource: projects.deployments

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

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

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

string

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

oauth Scopes[]

string

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

add Ons

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 )

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

http Options

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

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

logo Url

string

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

layout Properties

object ( LayoutProperties )

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

add On Widget Set

object ( AddOnWidgetSet )

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

use Locale From App

boolean

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

homepage Trigger

object ( HomepageExtensionPoint )

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

universal Actions[]

object ( UniversalActionExtensionPoint )

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

open Link Url Prefixes

array ( ListValue format)

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

LayoutProperties

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

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

string

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

secondary Color

string

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

use New Material Design

boolean

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

AddOnWidgetSet

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

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

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
}
فیلدها
run Function

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 فقط می تواند یکی از موارد زیر باشد:
run Function

string

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

GmailAddOnManifest

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

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

object ( HomepageExtensionPoint )

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

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

contextual Triggers[]

object ( ContextualTrigger )

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

universal Actions[]

object ( UniversalAction )

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

compose Trigger

object ( ComposeTrigger )

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

authorization Check Function

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.
}
فیلدها
on Trigger Function

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 فقط می تواند یکی از موارد زیر باشد:
run Function

string

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

ComposeTrigger

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

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

object ( MenuItemExtensionPoint )

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

draft Access

enum ( DraftAccess )

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

DraftAccess

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

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

DriveAddOnManifest

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

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

object ( HomepageExtensionPoint )

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

on Items Selected Trigger

object ( DriveExtensionPoint )

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

DriveExtensionPoint

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

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

string

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

CalendarAddOnManifest

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

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

object ( HomepageExtensionPoint )

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

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

conference Solution[]

object ( ConferenceSolution )

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

create Settings Url Function

string

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

event Open Trigger

object ( CalendarExtensionPoint )

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

event Update Trigger

object ( CalendarExtensionPoint )

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

event Attachment Trigger

object ( MenuItemExtensionPoint )

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

current Event Access

enum ( EventAccess )

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

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

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

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

string

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

id

string

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

name

string

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

logo Url

string

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

CalendarExtensionPoint

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

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

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)
    }
  ]
}
فیلدها
homepage Trigger

object ( HomepageExtensionPoint )

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

on File Scope Granted Trigger

object ( DocsExtensionPoint )

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

link Preview Triggers[]

object ( LinkPreviewExtensionPoint )

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

create Action Triggers[]

object ( CreateActionExtensionPoint )

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

DocsExtensionPoint

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

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

string

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

LinkPreviewExtensionPoint

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

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

string

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

localized Label Text

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 که افزونه را برای پیش نمایش پیوندها فعال می کند.

run Function

string

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

logo Url

string

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

UriPattern

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

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

string

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

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

path Prefix

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-]+ باشد.

label Text

string

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

localized Label Text

map (key: string, value: string)

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

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

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

run Function

string

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

logo Url

string

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

SheetsAddOnManifest

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

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

object ( HomepageExtensionPoint )

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

on File Scope Granted Trigger

object ( SheetsExtensionPoint )

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

link Preview Triggers[]

object ( LinkPreviewExtensionPoint )

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

SheetsExtensionPoint

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

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

string

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

SlidesAddOnManifest

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

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

object ( HomepageExtensionPoint )

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

on File Scope Granted Trigger

object ( SlidesExtensionPoint )

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

link Preview Triggers[]

object ( LinkPreviewExtensionPoint )

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

SlidesExtensionPoint

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

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

string

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

HttpOptions

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

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

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

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

get Install Status

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

install

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

list

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

replace Deployment

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

uninstall

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