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)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
فیلدها
common

object ( CommonAddOnManifest )

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

gmail

object ( GmailAddOnManifest )

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

drive

object ( DriveAddOnManifest )

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

calendar

object ( CalendarAddOnManifest )

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

docs

object ( DocsAddOnManifest )

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

meet

object ( MeetAddOnManifest )

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

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 بازنویسی می‌شوند.

ویژگی‌های طرح‌بندی

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

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

string

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

secondaryColor

string

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

useNewMaterialDesign
(deprecated)

boolean

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

مجموعه ابزارک‌های اضافه

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

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

enum ( WidgetType )

فهرست ویجت‌های استفاده‌شده در یک افزونه.

نوع ابزارک

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

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

صفحه اصلی ExtensionPoint

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

نمایش 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

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

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

محرک زمینه‌ای

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

نمایش 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 فیلد Union. نوع تریگر، شرایطی را که جیمیل برای نمایش افزونه استفاده می‌کند، تعیین می‌کند. 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 action_type . نوع اکشن، رفتار جیمیل را هنگام فراخوانی آن توسط کاربر تعیین می‌کند. action_type فقط می‌تواند یکی از موارد زیر باشد:
runFunction

string

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

ComposeTrigger

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

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

object ( MenuItemExtensionPoint )

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

draftAccess

enum ( DraftAccess )

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

پیش‌نویس دسترسی

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

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

درایوافزودنمانیفست

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

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

object ( HomepageExtensionPoint )

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

onItemsSelectedTrigger

object ( DriveExtensionPoint )

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

درایو اکستنشن پوینت

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

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

string

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

تقویمAddOnManifest

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

نمایش JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    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 )

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

calendarNotificationTrigger

object ( CalendarExtensionPoint )

اختیاری. وقتی رویدادی برای تقویمی که کاربر در آن مشترک شده است ایجاد یا به‌روزرسانی می‌شود، فعال می‌شود. فقط برای فعال‌کننده‌هایی که توسط Alt-Runtime add-ons با استفاده از CalendarSubscriptionActionMarkup ایجاد شده‌اند، اعمال می‌شود. برای Apps Script add-ons و Apps Script installable triggers قابل اجرا نیست.

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

الزامی. نشانی اینترنتی (URL) تصویر لوگوی راهکار کنفرانس.

تقویم افزونه نقطه

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

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

string

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

دسترسی به رویداد

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

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

مستنداتAddOnManifest

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

نمایش 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. برای اطلاعات بیشتر، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.

اسنادExtensionPoint

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

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

string

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

پیش‌نمایش لینک‌ها

پیکربندی مربوط به تریگری که وقتی کاربر پیوندی را از یک سرویس شخص ثالث یا غیر گوگل در یک فایل Google Docs، Sheets یا Slides تایپ یا پیست می‌کند، فعال می‌شود.

نمایش 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 ، زیردامنه را اضافه کنید. برای پیش‌نمایش لینک‌های کل دامنه، یک کاراکتر wildcard با ستاره ( * ) به عنوان زیردامنه مشخص کنید.

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

pathPrefix

string

اختیاری. مسیری که دامنه‌ی hostpattern را به آن اضافه می‌کند.

برای مثال، اگر الگوی میزبان URL، support.example.com باشد، برای تطبیق URLها برای موارد میزبانی شده در support.example.com/cases/ ، cases وارد کنید.

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

ایجاد اکشن اکستنشن پوینت

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

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

string

الزامی. شناسه منحصر به فرد برای تمایز این نقطه الحاق. شناسه می‌تواند تا ۶۴ کاراکتر داشته باشد و باید به شکل [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 ، استفاده می‌کند.

MeetAddOnManifest

با مانیفست افزونه آشنا شوید.

نمایش JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
فیلدها
homepageTrigger

object ( HomepageExtensionPoint )

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

web

object ( Web )

جزئیات افزونه‌هایی که کلاینت وب Meet را بهبود می‌بخشند.

supportsCollaboration

boolean

اینکه آیا افزونه از همکاری پشتیبانی می‌کند یا دیگران را به تجربه افزونه دعوت می‌کند.

termsUri

string

در صورت وجود، باید پیوندی به شرایط خدمات افزونه نمایش داده شود.

وب

جزئیات افزونه‌هایی که کلاینت وب Meet را بهبود می‌بخشند.

نمایش JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
فیلدها
sidePanelUri
(deprecated)

string

آدرس اینترنتی (URI) برای iframe پنل کناری.

sidePanelUrl

string

نشانی اینترنتی (URL) مربوط به iframe پنل کناری.

mainStageUri
(deprecated)

string

آدرس اینترنتی (URI) برای iframe مربوط به "مرحله اصلی".

supportsScreenSharing

boolean

اینکه آیا افزونه از اشتراک‌گذاری صفحه نمایش در مرحله اصلی پشتیبانی می‌کند یا خیر.

supportsCollaboration
(deprecated)

boolean

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

supportsPopOut

boolean

اینکه آیا افزونه از نمایش تصویر در تصویر (PiP) در مرورگر پشتیبانی می‌کند یا خیر.

hostOrigins[]
(deprecated)

string

نام قدیمی و منسوخ. Originهایی که باید به ویژگی frame-src مربوط به iframe حاوی سایت شخص ثالث اضافه شوند. به جای آن از addonorigins استفاده کنید.

addOnOrigins[]

string

ریشه‌هایی که باید به ویژگی frame-src از iframe حاوی سایت شخص ثالث اضافه شوند.

openState

enum ( State )

حالت اولیه هنگام باز شدن افزونه.

supportsCollaborationHostControls

boolean

اینکه آیا افزونه‌ی همکاری از کنترل‌های میزبان پشتیبانی می‌کند یا خیر.

logoUrl

string

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

darkModeLogoUrl

string

نسخه حالت تاریک لوگو.

displayFlow
(deprecated)

enum ( DisplayFlow )

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

ایالت

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

انوم‌ها
STATE_UNSPECIFIED وضعیت اولیه با افزونه مشخص نشده است.
SIDE_PANEL_ONLY افزونه فقط با فعال بودن پنل کناری باز می‌شود.
MAIN_STAGE_ONLY افزونه فقط با مرحله اصلی فعال باز می‌شود.
SIDE_PANEL_AND_MAIN_STAGE افزونه با فعال بودن پنل کناری و صحنه اصلی باز می‌شود.

جریان نمایش

Enum برای مشخص کردن جریان نمایشی که افزونه هنگام اجرا دنبال خواهد کرد

انوم‌ها
DISPLAY_FLOW_UNSPECIFIED جریان نمایش مشخص نشده است.
FOCUS افزونه باید در جریان نمایش "تمرکز" اجرا شود.
AUGMENT افزونه باید در جریان نمایش «افزودن» اجرا شود.

SheetsAddOnManifest

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

نمایش 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

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

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

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

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

object ( HomepageExtensionPoint )

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

onFileScopeGrantedTrigger

object ( SlidesExtensionPoint )

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

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

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

اسلایدهاExtensionPoint

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

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

string

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

گزینه‌های Http

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

نمایش JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
فیلدها
authorizationHeader

enum ( HttpAuthorizationHeader )

پیکربندی توکن ارسالی در هدر HTTP Authorization.

granularOauthPermissionSupport

enum ( GranularOauthPermissionSupport )

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

هدر HttpAuthorizationHeader

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

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

پشتیبانی مجوز GranularOauth

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

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

روش‌ها

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

 یک نسخه آزمایشی از حساب کاربری را حذف نصب می‌کند.