منبع مانیفست ویرایشگر

پیکربندی منبعی که برای تعریف محتوا و رفتار افزونه‌ی Google Workspace در ویرایشگرها استفاده می‌شود. مانیفست‌های افزونه‌ی Google Workspace باید تمام اجزایی را که به عنوان «الزامی» علامت‌گذاری شده‌اند، داشته باشند، اگر ویرایشگر را توسعه دهند.

ویراستاران

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

نمایش JSON 
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
فیلدها
homepageTrigger

object ( HomepageTrigger )

این تابع تریگر، صفحه اصلی افزونه را در برنامه میزبان ایجاد می‌کند. این addOns.common.homepageTrigger را لغو می‌کند.

onFileScopeGrantedTrigger

object ( OnFileScopeGrantedTrigger )

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

linkPreviewTriggers[]

object ( LinkPreviewTriggers )

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

createActionTriggers[]

object ( createActionTriggers )

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

OnFileScopeGrantedTrigger

پیکربندی برای یک تریگر زمینه‌ای که زمانی فعال می‌شود که کادر محاوره‌ای درخواست دامنه فایل با استفاده از CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); و کاربر مجوز دامنه drive.file را اعطا می‌کند.

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

string

نام تابعی که در صورت اعطای دامنه‌ی drive.file اجرا می‌شود. در صورت مشخص شدن، باید این تابع را برای ساخت و بازگرداندن آرایه‌ای از اشیاء Card برای نمایش در رابط کاربری افزونه پیاده‌سازی کنید.

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

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

برای تنظیم این ماشه برای افزونه‌ی Google Workspace، به پیش‌نمایش پیوندها با تراشه‌های هوشمند مراجعه کنید.

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

string

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

map (key: string, value: string)

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

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

patterns[]

object ( UriPattern )

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

string

الزامی. نام تابعی که هنگام تأیید دامنه https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر اجرا می‌شود. در صورت مشخص شدن، باید این تابع را طوری پیاده‌سازی کنید که یک شیء رویداد حاوی EDITOR_NAME .matchedUrl.url را به عنوان آرگومان بپذیرد و یک شیء Card واحد را برگرداند که پیش‌نمایش لینک را در رابط کاربری افزونه نمایش می‌دهد.
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 Docs@ توسط کاربر، فعال می‌شود.

برای تنظیم این ماشه برای افزونه‌ی 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 را مشاهده می‌کند.

runFunction

string

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

string

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