منبع مانیفست تقویم

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

تقویم

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

نمایش JSON
{
  "createSettingsUrlFunction": string,
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "eventAttachmentTrigger": {
    object (EventAttachmentTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
فیلدها
createSettingsUrlFunction

string

فقط در صورتی استفاده می‌شود که افزونه، راهکارهای کنفرانس ارائه دهد. اختیاری. نام تابع Apps Script که یک URL ایجاد می‌کند که به صفحه تنظیمات افزونه منتهی می‌شود.

برای جزئیات بیشتر، به افزودن تنظیمات افزونه کنفرانس مراجعه کنید.
conferenceSolution[]

object ( ConferenceSolution )

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

string

سطح دسترسی افزونه به داده‌های رویداد تولید شده توسط کاربر را تعیین می‌کند. در صورت عدم ارائه، هیچ فراداده رویدادی به افزونه ارسال نمی‌شود. تنظیمات معتبر به شرح زیر است:

  • METADATA نشان می‌دهد که افزونه فقط به متادیتای رویدادهای پایه دسترسی دارد.
  • READ نشان می‌دهد که افزونه می‌تواند علاوه بر فراداده‌های رویداد پایه، داده‌های رویداد تولید شده توسط کاربر را نیز بخواند.
  • WRITE نشان می‌دهد که افزونه می‌تواند داده‌های رویداد تولید شده توسط کاربر را بنویسد.
  • READ_WRITE نشان می‌دهد که افزونه می‌تواند داده‌های رویداد تولید شده توسط کاربر و همچنین فراداده‌های اولیه را بخواند و بنویسد.

اگر روی READ یا READ_WRITE تنظیم شده باشد، افزونه باید دامنه https://www.googleapis.com/auth/calendar.addons.current.event.read را داشته باشد.

اگر روی WRITE یا READ_WRITE تنظیم شده باشد، افزونه باید دامنه‌ی https://www.googleapis.com/auth/calendar.addons.current.event.write را داشته باشد.

eventOpenTrigger

object ( EventOpenTrigger )

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

eventUpdateTrigger

object ( EventUpdateTrigger )

برای ارائه رابط‌های به‌روزرسانی رویداد زمینه‌ای در تقویم گوگل الزامی است. مشخصات تریگر برای تریگرهای به‌روزرسانی رویداد در تقویم.

eventAttachmentTrigger

object ( EventAttachmentTrigger )

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

homepageTrigger

object ( HomepageTrigger )

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

راهکار کنفرانس

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

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

string

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

string

پیوندی به آیکونی که راه‌حل را نشان می‌دهد. تصویر باید در ابعاد ۹۶ در ۹۶ نقطه در اینچ باشد.

این نمی‌تواند یک URL دلخواه باشد — تصویر باید در زیرساخت گوگل میزبانی شود. برای جزئیات بیشتر به بخش ارائه لوگوهای راهکار کنفرانس مراجعه کنید.

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

string

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

string

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

رویدادبازراه‌انداز

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

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

string

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

رویدادبه‌روزرسانی تریگر

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

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

string

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

رویداد پیوست تریگر

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

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

string

الزامی. نام تابع Apps Script که هنگام انتخاب ارائه‌دهنده پیوست افزونه توسط کاربر در منوی کشویی Calendar اجرا می‌شود. شما باید این تابع را برای ساخت و بازگرداندن آرایه‌ای از اشیاء Card برای نمایش در رابط کاربری افزونه پیاده‌سازی کنید.
label

string

الزامی. متنی که در منوی کشویی تقویم نمایش داده می‌شود و این ارائه‌دهنده پیوست را مشخص می‌کند.