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

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

AddOns

پیکربندی برافزای 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)

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

object (DriveAddOnManifest)

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

object (CalendarAddOnManifest)

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

object (DocsAddOnManifest)

پیکربندی برافزای «سندنگار».
meet

object (MeetAddOnManifest)

پیکربندی برافزای Meet.
sheets

object (SheetsAddOnManifest)

پیکربندی برافزای «کاربرگ‌نگار».
slides

object (SlidesAddOnManifest)

پیکربندی برافزای «اسلایدنگار».
httpOptions

object (HttpOptions)

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

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)

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

array (ListValue format)

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

LayoutProperties

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

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

string

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

string

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

boolean

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

AddOnWidgetSet

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

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

enum (WidgetType)

فهرست ابزاره‌های استفاده‌شده در برافزا.

WidgetType

نوع ابزاره. ‫WIDGET_TYPE_UNSPECIFIED مجموعه ابزاره‌های پایه است.

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

HomepageExtensionPoint

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

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

string

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

boolean

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

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

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

UniversalActionExtensionPoint

قالب اعلام نقطه افزونه منوِ کنش‌های جهانی.

نمایش JSON 
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
فیلدها
label

string

الزامی. نوشتار قابل‌مشاهده برای کاربر که کنش انجام‌شده با فعال کردن این نقطه افزونه را شرح می‌دهد، برای مثال، «افزودن مخاطب جدید».
الزامی. نوع کنش پشتیبانی‌شده در مورد منو کنش جهانی. این می‌تواند پیوندی برای باز کردن یا نقطه پایانی برای اجرا باشد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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

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

ContextualTrigger

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

نمایش JSON 
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
فیلدها
onTriggerFunction

string

الزامی. نام نقطه پایانی که وقتی پیامی با راه‌انداز مطابقت دارد باید فراخوانی شود.
نوع راه‌انداز شرایطی را که Gmail برای نمایش برافزا استفاده می‌کند تعیین می‌کند. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
unconditional

object (UnconditionalTrigger)

راه‌اندازهای غیرشرطی زمانی اجرا می‌شوند که هر پیام ایمیلی باز شود.
پایان فیلدهای متقابلاً انحصاری.

UnconditionalTrigger

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

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

UniversalAction

کنشی که همیشه در منو نوار ابزار برافزا دردسترس است، صرف‌نظر از بافت پیام.

نمایش JSON 
{
  "text": string,

  "openLink": string,
  "runFunction": string
}
فیلدها
text

string

الزامی. نوشتار قابل‌مشاهده برای کاربر که کنش را توصیف می‌کند، برای مثال، «افزودن مخاطب جدید».
نوع کنش تعیین‌کننده رفتار Gmail هنگام فراخوانی کنش توسط کاربر است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
runFunction

string

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

ComposeTrigger

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

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

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

DraftAccess

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

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

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

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

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

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

برای جلوگیری از حلقه‌های اعلان بازگشتی، وقتی برافزایی رویداد «تقویم Google» را بااستفاده از Calendar API با اعتبارنامه‌های اصالت‌سنجی از همان پروژه Google Cloud که میزبان استقرار برافزا است اصلاح می‌کند، پلاتفرم اعلان‌های اصلاح را سرکوب می‌کند. راه‌اندازی خودکار فراخوانی‌های Calendar API پروژه خودتان پشتیبانی نمی‌شود.

برای Apps Script add-ons و Apps Script installable triggers قابل‌اجرا نیست.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

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

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

string

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

string

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

string

الزامی. نام نمایشی راهکار کنفرانس.
logoUrl

string

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

CalendarExtensionPoint

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

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

string

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

EventAccess

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

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

DocsAddOnManifest

ویژگی‌هایی که ظاهر و اجرای برافزای «سندنگار Google» را سفارشی‌سازی می‌کنند.

نمایش 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». برای جزئیات، به پیش‌دید پیوندها با تراشه‌های هوشمند مراجعه کنید.
createActionTriggers[]

object (CreateActionExtensionPoint)

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

DocsExtensionPoint

قالب رایج برای اعلام راه‌اندازهای برافزای «سندنگار».

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

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

string

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

string

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

UriPattern

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

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

string

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

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

string

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

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

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

CreateActionExtensionPoint

پیکربندی راه‌اندازی که وقتی کاربر گردش کار ایجاد منبع را در برنامه 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

مانیفست برافزای Meet.

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

نشانی وب برای iframe پانل کناری.
mainStageUri
(deprecated)

string

URI برای iframe «مرحله اصلی».
supportsScreenSharing

boolean

اینکه برافزا از هم‌رسانی صفحه‌نمایش در جایگاه اصلی پشتیبانی می‌کند یا نه.
supportsCollaboration
(deprecated)

boolean

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

boolean

آیا برافزا از باز شدن در تجربه PiP مرورگر پشتیبانی می‌کند یا نه.
hostOrigins[]
(deprecated)

string

نام قدیمی و منسوخ‌شده. مبادی‌ای که باید به ویژگی frame-src از iframe حاوی سایت طرف سوم اضافه شوند. درعوض از addonorigins استفاده کنید.
addOnOrigins[]

string

مبادی‌ای که باید به ویژگی frame-src از iframe حاوی سایت طرف سوم اضافه شوند.
openState

enum (State)

وضعیت اولیه هنگام باز شدن برافزا.
supportsCollaborationHostControls

boolean

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

string

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

string

نسخه حالت تاریک logourl.
displayFlow
(deprecated)

enum (DisplayFlow)

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

ایالت

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

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

DisplayFlow

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

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

SheetsAddOnManifest

ویژگی‌هایی که ظاهر و اجرای برافزای «کاربرگ‌نگار Google» را سفارشی‌سازی می‌کنند.

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

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

قالب رایج برای اعلام راه‌اندازهای برافزای «کاربرگ‌نگار».

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

string

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

SlidesAddOnManifest

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

نمایش 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),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
فیلدها
authorizationHeader

enum (HttpAuthorizationHeader)

پیکربندی برای کد ارسالی در سرایند «مجوز» HTTP.
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

اینکه برافزا «رضایت OAuth جزئی» را فعال کرده است یا نه.

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

اینکه برافزا «رضایت OAuth جزئی» را فعال کرده است یا نه.

شمارشی‌ها
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED مقدار پیش‌فرض، نباید استفاده شود.
OPT_IN برافزا با «رضایت OAuth جزئی» موافقت کرده باشد.
OPT_OUT برافزا از «رضایت OAuth با اطلاعات جزءبه‌جزء» انصراف داده است.

روش‌ها

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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