اشیاء رویداد

این صفحه ساختار اشیاء رویداد افزونه‌های Google Workspace را شرح می‌دهد.

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

افزونه‌های Google Workspace از اشیاء رویداد در مکان‌های زیر استفاده می‌کنند:

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

    اشیاء رویدادی که هنگام فعال شدن صفحه اصلی ایجاد می‌شوند، شامل تمام فیلدهای موجود در دو مورد دیگر نیستند؛ فیلدهای مربوط به ویجت‌ها و اطلاعات زمینه‌ای حذف شده‌اند.

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

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

  • اقدامات ویجت . اشیاء رویداد نیز برای ارائه تعامل ویجت ، با استفاده از همان مدل عملی که افزونه‌های Gmail استفاده می‌کنند، استفاده می‌شوند. افزونه‌های Google Workspace از تمام توابع کنترل‌کننده ویجت، اشیاء Action و پاسخ‌های اکشن یکسان استفاده می‌کنند. با این حال، در افزونه‌های Google Workspace ، اشیاء رویداد اکشن شامل اطلاعات بیشتری هستند که یک تابع فراخوانی می‌تواند روی آنها عمل کند.

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

  • پیش‌نمایش محرک‌های لینک . در Google Docs، Sheets و Slides، می‌توانید پیش‌نمایش‌های لینک را برای سرویس‌های شخص ثالث بر اساس الگوهای خاص URL پیکربندی کنید. هنگامی که کاربران با لینکی که با الگو مطابقت دارد تعامل می‌کنند، linkPreviewTriggers فعال می‌شود و یک شیء رویداد که حاوی لینک است به تابع فراخوانی trigger ارسال می‌شود. افزونه شما می‌تواند از این شیء رویداد برای ساخت یک تراشه و کارت هوشمند استفاده کند که اطلاعات مربوط به لینک را در برنامه میزبان نمایش می‌دهد. همچنین می‌توانید اقدامات ویجت را ایجاد کنید تا کاربران بتوانند با کارت پیش‌نمایش و محتوای آن تعامل داشته باشند.

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

ساختار شیء رویداد

جدول زیر ساختار سطح بالای اشیاء رویداد افزونه‌های Google Workspace را شرح می‌دهد. ساختار شیء رویداد شامل یک فیلد سطح بالای commonEventObject برای اطلاعات مستقل از میزبان است. هر شیء رویداد همچنین می‌تواند یکی از فیلدهای سطح بالای مختص میزبان زیر را داشته باشد که توسط برنامه میزبان فعال تعیین می‌شود: gmailEventObject ، calendarEventObject یا driveEventObject .

برای سازگاری با نسخه‌های قبلی، اشیاء رویداد افزونه‌های Google Workspace شامل تمام فیلدهای اصلی مورد استفاده در اشیاء رویداد اقدام افزونه Gmail نیز می‌شوند. این فیلدها در جدول زیر در بخش «فیلدهای افزونه اصلی Gmail» فهرست شده‌اند؛ اطلاعات موجود در این فیلدها در ساختار شیء جدید بازتولید شده است.

شیء رویداد
eventObject.commonEventObject Common fields object
شیء‌ای که حاوی اطلاعات مشترک بین همه اشیاء رویداد، صرف نظر از برنامه میزبان، است.
eventObject.calendar Calendar event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، تقویم گوگل باشد . یک شیء حاوی اطلاعات تقویم و رویداد.
eventObject.chat Chat event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، Google Chat باشد . یک شیء حاوی اطلاعات Chat.
eventObject.drive Drive event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، گوگل درایو باشد . یک شیء حاوی اطلاعات درایو.
eventObject.gmail Gmail event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، Gmail باشد . یک شیء حاوی اطلاعات Gmail.
eventObject.docs Docs event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، Google Docs باشد . یک شیء حاوی اطلاعات Docs.
eventObject.sheets Sheets event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، Google Sheets باشد . یک شیء حاوی اطلاعات Sheets.
eventObject.slides Slides event object
فقط در صورتی ارائه می‌شود که میزبان فراخوانی، Google Slides باشد . یک شیء حاوی اطلاعات Slides.
فیلدهای افزونه اصلی جیمیل
eventObject.messageMetadata.accessToken string
منسوخ شده. یک توکن دسترسی. می‌توانید از این برای فعال کردن دسترسی به داده‌های کاربر با استفاده از محدوده‌های موقت افزونه‌های جیمیل استفاده کنید.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.gmail.accessToken پیدا کنید.

eventObject.messageMetadata.messageId string
منسوخ شده. شناسه پیام مربوط به رشته‌ای که در رابط کاربری Gmail باز است.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.gmail.messageId پیدا کنید.

eventObject.clientPlatform string
منسوخ شده. نشان می‌دهد که رویداد از کجا سرچشمه می‌گیرد (وب، iOS یا اندروید).

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.platform پیدا کنید.

eventObject.formInput object
منسوخ شده. نقشه‌ای از مقادیر فعلی تمام ویجت‌های فرم در کارت، که به یک مقدار برای هر ویجت محدود شده است. کلیدها، شناسه‌های رشته‌ای مرتبط با ویجت‌ها هستند و مقادیر، رشته‌ها می‌باشند. شیء رویداد formInput را به عنوان یک ابزارک برای راحتی شما فراهم می‌کند، زمانی که نیاز به خواندن داده‌ها از چندین ویجت با مقادیر منفرد مورد انتظار، مانند ورودی‌های متنی و سوئیچ‌ها، دارید. برای ویجت‌های چند مقداری مانند چک‌باکس‌ها، می‌توانید هر مقدار را از formInputs بخوانید.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.formInputs پیدا کنید؛ ویجت‌هایی با مقادیر واحد به صورت آرایه‌هایی با یک عنصر واحد نمایش داده می‌شوند.

eventObject.formInputs object
منسوخ شده. نقشه‌ای از مقادیر فعلی ویجت‌ها در کارت، که به صورت لیستی از رشته‌ها ارائه می‌شود. کلیدها، شناسه‌های رشته‌ای مرتبط با ویجت هستند. برای ویجت‌های تک مقداری، مقدار در یک آرایه تک عنصری ارائه می‌شود. برای ویجت‌های چند مقداری مانند گروه‌های چک‌باکس، تمام مقادیر در یک لیست ارائه می‌شوند.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.formInputs پیدا کنید.

eventObject.parameters object
منسوخ شده. نقشه‌ای از هر پارامتر اضافی که با استفاده از Action.setParameters() به Action ارائه می‌دهید. کلیدها و مقادیر نقشه، رشته هستند.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.parameters پیدا کنید.

eventObject.userCountry string
به طور پیش‌فرض منسوخ و غیرفعال شده است . کد دو حرفی که کشور یا منطقه کاربر را نشان می‌دهد. همچنین می‌تواند یک کد کشور عددی UN M49 باشد.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.userLocale پیدا کنید.

eventObject.userLocale string
به طور پیش‌فرض منسوخ و غیرفعال شده است . کد دو حرفی ISO 639 که زبان کاربر را نشان می‌دهد. برای جزئیات بیشتر به بخش دسترسی به زبان و منطقه زمانی کاربر مراجعه کنید.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.userLocale پیدا کنید.

eventObject.userTimezone.id string
به طور پیش‌فرض منسوخ و غیرفعال شده است . شناسه منطقه زمانی منطقه زمانی کاربر. مثال‌ها عبارتند از: America/New_York ، Europe/Vienna و Asia/Seoul . برای جزئیات بیشتر به بخش دسترسی به زبان و منطقه زمانی کاربر مراجعه کنید.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.timeZone.id پیدا کنید.

eventObject.userTimezone.offset string
به طور پیش‌فرض منسوخ و غیرفعال شده است . اختلاف زمانی از زمان هماهنگ جهانی (UTC) منطقه زمانی کاربر، که بر حسب میلی‌ثانیه اندازه‌گیری می‌شود. برای جزئیات بیشتر به دسترسی به زبان و منطقه زمانی کاربر مراجعه کنید.

برای افزونه‌های Google Workspace، این اطلاعات را در فیلد eventObject.commonEventObject.timeZone.offset پیدا کنید.

شیء رویداد مشترک

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

علاوه بر تریگرهای صفحه اصلی و زمینه‌ای، افزونه‌ها اشیاء رویداد را ساخته و به توابع فراخوانی اکشن منتقل می‌کنند، زمانی که کاربر با ویجت‌ها تعامل دارد. تابع فراخوانی افزونه شما می‌تواند از شیء رویداد مشترک برای تعیین محتوای ویجت‌های باز در کلاینت کاربر پرس‌وجو کند. به عنوان مثال، افزونه شما می‌تواند متنی را که کاربر در یک ویجت TextInput در شیء eventObject.commentEventObject.formInputs وارد کرده است، پیدا کند.

فیلدهای شیء رویداد مشترک
commonEventObject.platform string
نشان می‌دهد که رویداد از کجا سرچشمه می‌گیرد (`WEB`، `IOS` یا `ANDROID`).
commonEventObject.formInputs object
نقشه‌ای حاوی مقادیر فعلی ویجت‌ها در کارت نمایش داده شده. کلیدهای نقشه، شناسه‌های رشته‌ای هستند که به هر ویجت اختصاص داده شده‌اند.

ساختار شیء مقدار نقشه به نوع ویجت بستگی دارد:

  • ویجت‌های تک مقداری (برای مثال، یک کادر متنی): فهرستی از رشته‌ها (فقط یک عنصر).

    مثال : برای یک ویجت ورودی متن با شناسه employeeName ، با استفاده از دستور زیر به مقدار ورودی متن دسترسی پیدا کنید: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • ویجت‌های چند مقداری (برای مثال، گروه‌های چک‌باکس): فهرستی از رشته‌ها.

    مثال : برای یک ویجت چند مقداری با شناسه participants ، با استفاده از e.commonEventObject.formInputs.participants.stringInputs.value به آرایه مقدار دسترسی پیدا کنید.

  • A date-time picker : یک DateTimeInput object .

    مثال : برای یک انتخابگر با شناسه myDTPicker ، با استفاده از e.commonEventObject.formInputs.myDTPicker.dateTimeInput به شیء DateTimeInput دسترسی پیدا کنید.

  • A date-only picker : یک DateInput object .

    مثال : برای یک انتخابگر با شناسه myDatePicker ، با استفاده از e.commonEventObject.formInputs.myDatePicker.dateInput به شیء DateInput دسترسی پیدا کنید.

  • A time-only picker : یک TimeInput object .

    مثال : برای یک انتخابگر با شناسه myTimePicker ، با استفاده از e.commonEventObject.formInputs.myTimePicker.timeInput به شیء TimeInput دسترسی پیدا کنید.

commonEventObject.hostApp string
نشان می‌دهد که افزونه هنگام تولید شیء رویداد، در کدام برنامه میزبان فعال است. مقادیر ممکن شامل موارد زیر است:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
هر پارامتر اضافی که با استفاده از actionParameters یا Action.setParameters() به یک اکشن ارائه می‌دهید.

پیش‌نمایش توسعه‌دهندگان: برای افزونه‌هایی که Google Chat را توسعه می‌دهند ، برای پیشنهاد موارد بر اساس آنچه کاربران در منوهای چندگزینه‌ای تایپ می‌کنند، از مقدار کلید "autocomplete_widget_query" ( event.commonEventObject.parameters["autocomplete_widget_query"] ) استفاده کنید. می‌توانید از این مقدار برای پرس‌وجو از یک پایگاه داده و پیشنهاد موارد قابل انتخاب به کاربران هنگام تایپ استفاده کنید. برای جزئیات بیشتر، به جمع‌آوری و پردازش اطلاعات از کاربران Google Chat مراجعه کنید.

commonEventObject.userLocale string
به طور پیش‌فرض غیرفعال است . زبان و شناسه کشور/منطقه کاربر در قالب کد زبان ISO 639 - کد کشور/منطقه ISO 3166. به عنوان مثال، en-US .

برای فعال کردن این فیلد، باید addOns.common.useLocaleFromApp در مانیفست افزونه خود روی true تنظیم کنید. لیست دامنه افزونه شما باید شامل https://www.googleapis.com/auth/script.locale نیز باشد. برای جزئیات بیشتر به بخش دسترسی به زبان و منطقه زمانی کاربر مراجعه کنید.

commonEventObject.timeZone string
به طور پیش‌فرض غیرفعال است . شناسه و فاصله زمانی منطقه زمانی. برای فعال کردن این فیلد، باید addOns.common.useLocaleFromApp در مانیفست افزونه خود روی true تنظیم کنید. لیست دامنه افزونه شما باید شامل https://www.googleapis.com/auth/script.locale نیز باشد. برای جزئیات بیشتر به دسترسی به زبان کاربر و منطقه زمانی مراجعه کنید.
commonEventObject.timeZone.id string
شناسه منطقه زمانی منطقه زمانی کاربر. مثال‌ها عبارتند از: America/New_York ، Europe/Vienna و Asia/Seoul . برای فعال کردن این فیلد، باید addOns.common.useLocaleFromApp در مانیفست افزونه خود روی true تنظیم کنید. لیست محدوده افزونه شما همچنین باید شامل https://www.googleapis.com/auth/script.locale باشد. برای جزئیات بیشتر به بخش دسترسی به منطقه زمانی و منطقه زمانی کاربر مراجعه کنید.
commonEventObject.timeZone.offset string
اختلاف زمانی منطقه زمانی کاربر با زمان هماهنگ جهانی (UTC) که بر حسب میلی‌ثانیه اندازه‌گیری می‌شود. برای جزئیات بیشتر به بخش دسترسی به منطقه زمانی و زبان کاربر مراجعه کنید.

ورودی‌های فرم انتخابگر تاریخ و زمان

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

شیء ورودی DateTime
dateTimeInput.hasDate boolean
اگر تاریخ ورودی شامل تاریخ باشد، true اگر false ، فقط زمان لحاظ شده است.
dateTimeInput.hasTime boolean
اگر تاریخ ورودی شامل زمان باشد، true ؛ اگر false ، فقط تاریخ گنجانده شده است.
dateTimeInput.msSinceEpoch string
زمان انتخاب شده توسط کاربر، بر حسب میلی‌ثانیه از زمان شروع (۰۰:۰۰:۰۰ UTC در ۱ ژانویه ۱۹۷۰).
شیء DateInput
dateInput.msSinceEpoch string
زمان انتخاب شده توسط کاربر، بر حسب میلی‌ثانیه از زمان شروع (۰۰:۰۰:۰۰ UTC در ۱ ژانویه ۱۹۷۰).
شیء TimeInput
timeInput.hours number
شماره ساعت انتخاب شده توسط کاربر.
timeInput.minutes number
عدد دقیقه انتخاب شده توسط کاربر.

شیء رویداد چت

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

چت
chat.user object ( User )
کاربر چتی که با برنامه چت تعامل داشته است.
chat.space object ( Space )
فضای چتی که کاربر در آن با برنامه چت تعامل داشته است.
chat.eventTime

string ( Timestamp format)

زمانی که تعامل رخ داده است.

payload فیلد Union.

payload می‌تواند فقط یکی از موارد زیر باشد:

chat.messagePayload

object ( MessagePayload )

بار داده‌ای که برنامه‌های چت از یک تریگر پیام دریافت می‌کنند.

chat.addedToSpacePayload

object ( AddedToSpacePayload )

بار داده‌ای که برنامه‌های چت از یک تریگر Added to space دریافت می‌کنند.

chat.removedFromSpacePayload

object ( RemovedFromSpacePayload )

بار داده‌ای که برنامه‌های چت از یک تریگر حذف‌شده از فضا دریافت می‌کنند.

chat.buttonClickedPayload

object ( ButtonClickedPayload )

بار داده‌ای که برنامه‌های چت هنگام کلیک کاربران روی دکمه‌ای از یک پیام یا کارت دریافت می‌کنند. اگر کاربری برای ارسال اطلاعات روی دکمه‌ای کلیک کند، شیء commonEventObject.formInputs شامل مقادیر جمع‌آوری‌شده از کاربر است. برای جزئیات بیشتر، به بخش جمع‌آوری اطلاعات از کاربران Google Chat مراجعه کنید.

chat.widgetUpdatedPayload

object ( WidgetUpdatedPayload )

بار داده‌ای که برنامه‌های چت هنگام تایپ متن توسط کاربران در منوی چندگزینه‌ای ویجت selectionInput دریافت می‌کنند. برنامه‌های چت می‌توانند از این شیء رویداد برای پر کردن موارد پیشنهادی از یک منبع داده پویا استفاده کنند. به عنوان مثال، برای پر کردن موارد پشتیبانی از یک منبع داده خارجی، یک برنامه چت می‌تواند بر اساس آنچه کاربر در منو تایپ می‌کند، از منبع داده پرس و جو کند و سپس موارد پشتیبانی منطبق را به عنوان موارد قابل انتخاب بازگرداند.

شیء CommonEventObject.parameters['autocomplete_widget_query'] حاوی مقدار رشته‌ای است که کاربر در منو تایپ می‌کند.

chat.appCommandPayload

object ( AppCommandPayload )

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

بار مفید

بسته به نوع تعامل برنامه چت، این رویداد شامل یک payload با یک یا چند منبع Chat API است.

بار مفید پیام
پیام‌پِی‌لود
chat.messagePayload.message object ( Message )
پیام چتی که باعث ایجاد این رویداد شده است.
chat.messagePayload.space object ( Space )
فضای چتی که کاربر در آن پیامی ارسال کرده که برنامه چت را فراخوانی کرده است.
chat.messagePayload.configCompleteRedirectUri string
آدرس اینترنتی (URL) که برنامه چت باید پس از تکمیل فرآیند مجوزدهی یا پیکربندی خارج از گوگل چت، کاربر را به آن هدایت کند. برای اطلاعات بیشتر، به بخش «افزونه Google Workspace خود را به یک سرویس شخص ثالث متصل کنید» مراجعه کنید.

به محموله فضایی اضافه شد
بارگیری به فضا (AddedToSpacePayload)
chat.addedToSpacePayload.space object ( Space )
فضای چتی که کاربر برنامه چت را به آن اضافه یا نصب کرده است.

وقتی مدیران برنامه‌های چت را نصب می‌کنند، فیلد space.adminInstalled روی true تنظیم می‌شود.

chat.addedToSpacePayload.interactionAdd boolean
اینکه آیا کاربر برنامه چت را با استفاده از یک پیام به یک فضا اضافه می‌کند یا خیر. برای مثال، با @mention برنامه چت را فراخوانی می‌کند یا از یک دستور استفاده می‌کند. اگر true ، چت یک شیء رویداد دیگر را با یک messagePayload ارسال می‌کند که حاوی اطلاعاتی در مورد پیام است.
chat.addedToSpacePayload.configCompleteRedirectUri string
آدرس اینترنتی (URL) که برنامه چت باید پس از تکمیل فرآیند مجوزدهی یا پیکربندی خارج از گوگل چت، کاربر را به آن هدایت کند. برای اطلاعات بیشتر، به بخش «افزونه Google Workspace خود را به یک سرویس شخص ثالث متصل کنید» مراجعه کنید.

از محموله فضایی حذف شد
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object ( Space )
فضای چتی که کاربر برنامه چت را از آن حذف یا لغو نصب کرده است.

وقتی مدیران، برنامه‌های چت را حذف نصب می‌کنند، فیلد space.adminInstalled روی false تنظیم می‌شود.

بار داده کلیک شده روی دکمه
بارگذاری کلیک‌شده‌ی دکمه
chat.buttonClickedPayload.message object ( Message )
پیام چتی که حاوی دکمه‌ای است که کاربر روی آن کلیک کرده است.
chat.buttonClickedPayload.space object ( Space )
فضای چتی که کاربر در آن روی دکمه‌ای از یک پیام برنامه چت کلیک کرده است.
chat.buttonClickedPayload.isDialogEvent boolean
اینکه آیا کاربر برای تعامل با یک کادر محاوره‌ای روی دکمه کلیک کرده است یا خیر.
chat.buttonClickedPayload.dialogEventType enum ( DialogEventType )
اگر isDialogEvent true باشد، نوع تعامل در یک دیالوگ را نشان می‌دهد.

نوع رویداد محاوره‌ای شمارشی (Enum DialogEventType ).

مقدار dialogEventType فقط می‌تواند یکی از موارد زیر باشد:

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

بار مفید ویجت به‌روزرسانی شد
بار داده ویجت به‌روز شده
chat.widgetUpdatedPayload.space object ( Space )
فضای چتی که تعامل در آن رخ داده است.

بار مفید دستور برنامه
بارگذاری فرمان AppCommand
chat.appCommandPayload.appCommandMetadata object ( AppCommandMetadata )
فراداده‌هایی درباره اینکه کاربر از کدام دستور استفاده کرده و چگونه دستور را فعال کرده است.
chat.appCommandPayload.space object ( Space )
فضای چتی که کاربر در آن از دستور استفاده کرده است.
chat.appCommandPayload.thread object ( Thread )
اگر تعامل در یک رشته چت رخ داده باشد، رشته چتی که کاربر در آن از دستور استفاده کرده است.
chat.appCommandPayload.message object ( Message )
برای دستورات اسلش، پیامی که حاوی دستور اسلش است.
chat.appCommandPayload.configCompleteRedirectUri string
اگر برای اجرای دستور به مجوز یا پیکربندی نیاز باشد، یک URL برای هدایت کاربر به آن پس از تکمیل فرآیند خارج از Google Chat.
chat.appCommandPayload.isDialogEvent boolean
اینکه آیا دستور، کادر محاوره‌ای باز می‌کند یا خیر.
chat.appCommandPayload.dialogEventType enum ( DialogEventType )
نوع تعامل با یک دیالوگ.

نوع رویداد محاوره‌ای شمارشی (Enum DialogEventType ).

مقدار dialogEventType فقط می‌تواند یکی از موارد زیر باشد:

TYPE_UNSPECIFIED مقدار پیش‌فرض. نامشخص.
REQUEST_DIALOG کاربر درخواست یک دیالوگ را می‌دهد. برای مثال، او از یک دستور استفاده می‌کند یا روی دکمه‌ای از یک پیام کلیک می‌کند.
SUBMIT_DIALOG کاربر روی یک عنصر تعاملی در یک کادر محاوره‌ای کلیک می‌کند. برای مثال، کاربر اطلاعاتی را در یک کادر محاوره‌ای وارد می‌کند و روی دکمه‌ای برای ارسال اطلاعات کلیک می‌کند.
فراداده دستور برنامه
فراداده‌ی AppCommand
chat.appCommandPayload.appCommandMetadata.appCommandId

string ( int64 format)

شناسه فرمان.

chat.appCommandPayload.appCommandMetadata.appCommandType enum ( AppCommandType )
نوع فرمان.

نوع دستور برنامه شمارشی (Enum AppCommandType ).

مقدار AppCommandType فقط می‌تواند یکی از موارد زیر باشد:

APP_COMMAND_TYPE_UNSPECIFIED مقدار پیش‌فرض. نامشخص.
SLASH_COMMAND کاربر با ارسال پیامی که با یک اسلش / شروع می‌شود، از این دستور استفاده می‌کند.
QUICK_COMMAND کاربر دستور را از منوی چت در قسمت پاسخ پیام انتخاب می‌کند.

شیء رویداد تقویم

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

جدول زیر فیلدهای موجود در فیلد calendarEventObject از یک شیء رویداد را فهرست می‌کند. فیلدهایی که به عنوان داده‌های تولید شده توسط کاربر علامت‌گذاری شده‌اند، در شیء رویداد وجود دارند اگر و فقط اگر داده‌ها در رویداد Calendar وجود داشته باشند و افزونه فیلد manifest مربوط به addOns.calendar.currentEventAccess خود را روی READ یا READ_WRITE تنظیم کند.

شیء رویداد تقویم
calendar.attendees[] list of attendee objects
داده‌های تولید شده توسط کاربر. فهرستی از شرکت‌کنندگان در رویداد تقویم.
calendar.calendarId string
شناسه تقویم.
calendar.capabilities object
داده‌های تولید شده توسط کاربر. یک شیء که قابلیت‌های افزونه را برای مشاهده یا به‌روزرسانی اطلاعات رویداد توصیف می‌کند.
calendar.capabilities.canAddAttendees boolean
داده‌های تولید شده توسط کاربر. اگر افزونه بتواند شرکت‌کنندگان جدیدی را به لیست شرکت‌کنندگان رویداد اضافه کند، true و در غیر این صورت false برمی‌گرداند.
calendar.capabilities.canSeeAttendees boolean
داده‌های تولید شده توسط کاربر. اگر افزونه بتواند لیست شرکت‌کنندگان رویداد را بخواند، true و در غیر این صورت false برمی‌گرداند.
calendar.capabilities.canSeeConferenceData boolean
داده‌های تولید شده توسط کاربر. اگر افزونه بتواند داده‌های کنفرانس رویداد را بخواند، true و در غیر این صورت false برمی‌گرداند.
calendar.capabilities.canSetConferenceData boolean
داده‌های تولید شده توسط کاربر. اگر افزونه بتواند داده‌های کنفرانس رویداد را به‌روزرسانی کند، true و در غیر این صورت false برمی‌گرداند.
calendar.capabilities.canAddAttachments boolean
داده‌های تولید شده توسط کاربر. اگر افزونه بتواند پیوست‌های جدید به رویداد اضافه کند، true و در غیر این صورت false برمی‌گرداند.
calendar.conferenceData Conference data object
داده‌های تولید شده توسط کاربر. یک شیء که نشان‌دهنده هرگونه داده کنفرانس مرتبط با این رویداد است، مانند جزئیات کنفرانس Google Meet.
calendar.id string
شناسه رویداد.
calendar.organizer object
یک شیء که نشان دهنده برگزارکننده رویداد است.
calendar.organizer.email string
آدرس ایمیل برگزارکننده رویداد.
calendar.recurringEventId string
شناسه یک رویداد تکرارشونده.

شرکت کننده

اشیاء شرکت‌کننده اطلاعات مربوط به شرکت‌کنندگان را به رویدادهای تقویم گوگل منتقل می‌کنند. این اطلاعات در شیء رویداد وجود دارد اگر و فقط اگر داده‌ها در رویداد تقویم وجود داشته باشند و افزونه فیلد مانیفست addOns.calendar.currentEventAccess خود را روی READ یا READ_WRITE تنظیم کند.

شیء شرکت‌کننده
attendee.additionalGuests number
تعداد مهمانان اضافی که شرکت‌کننده اعلام کرده بود با خود می‌آورد. به طور پیش‌فرض روی صفر تنظیم شده است.
attendee.comment string
نظر پاسخ شرکت‌کننده، در صورت وجود.
attendee.displayName string
شرکت‌کننده نام خود را نمایش داد.
attendee.email string
آدرس ایمیل شرکت‌کننده.
attendee.optional boolean
اگر حضور این شرکت‌کننده اختیاری باشد، true و در غیر این صورت false برمی‌گرداند.
attendee.organizer boolean
اگر شرکت‌کننده، برگزارکننده‌ی این رویداد باشد، true .
attendee.resource boolean
اگر شرکت‌کننده نشان‌دهنده‌ی یک منبع، مانند اتاق یا قطعه‌ای از تجهیزات باشد، true ؛ در غیر این صورت false .
attendee.responseStatus string
وضعیت پاسخ شرکت‌کننده. مقادیر ممکن شامل موارد زیر است:
  • accepted : شرکت‌کننده دعوت رویداد را پذیرفته است.
  • declined : شرکت‌کننده دعوت رویداد را رد کرده است.
  • needsAction : شرکت‌کننده به دعوتنامه رویداد پاسخ نداده است.
  • tentative : شرکت‌کننده دعوت رویداد را به‌طور آزمایشی پذیرفته است.
attendee.self boolean
اگر این شرکت‌کننده نمایانگر تقویمی باشد که این رویداد در آن ظاهر می‌شود، true و در غیر این صورت false برمی‌گرداند.

داده‌های کنفرانس

اشیاء داده کنفرانس، اطلاعات مربوط به کنفرانس‌هایی را که به رویدادهای تقویم گوگل پیوست شده‌اند، حمل می‌کنند. این رویدادها می‌توانند راه‌حل‌های کنفرانس گوگل، مانند Google Meet، یا کنفرانس‌های شخص ثالث باشند. این اطلاعات در شیء رویداد وجود دارد اگر و فقط اگر داده‌ها در رویداد تقویم وجود داشته باشند و افزونه، فیلد مانیفست addOns.calendar.currentEventAccess خود را روی READ یا READ_WRITE تنظیم کند.

شیء داده کنفرانس
conferenceData.conferenceId string
شناسه کنفرانس. این شناسه برای این است که برنامه‌ها بتوانند کنفرانس‌ها را پیگیری کنند؛ شما نباید این شناسه را به کاربران نمایش دهید.
conferenceData.conferenceSolution object
یک شیء که نشان‌دهنده‌ی راهکار کنفرانس، مانند Hangouts یا Google Meet است.
conferenceData.conferenceSolution.iconUri string
آدرس اینترنتی (URI) مربوط به آیکون قابل مشاهده توسط کاربر که نشان‌دهنده‌ی این راهکار کنفرانس است.
conferenceData.conferenceSolution.key object
کلیدی که به طور منحصر به فرد، راهکار کنفرانس را برای این رویداد مشخص می‌کند.
conferenceData.conferenceSolution.key.type string
نوع راهکار کنفرانس. مقادیر ممکن شامل موارد زیر است:
  • eventHangout برای Hangouts برای مصرف‌کنندگان (http://hangouts.google.com).
  • eventNamedHangout برای Hangouts کلاسیک مخصوص کاربران Google Workspace (http://hangouts.google.com).
  • hangoutsMeet برای گوگل میت (http://meet.google.com).
conferenceData.conferenceSolution.name string
نام قابل مشاهده توسط کاربر برای این راهکار کنفرانس (بومی‌سازی نشده).
conferenceData.entryPoints[] list of entry point objects
فهرست نقاط ورود به کنفرانس، مانند نشانی‌های اینترنتی یا شماره تلفن‌ها.
conferenceData.notes string
یادداشت‌های اضافی (مانند دستورالعمل‌های مدیر دامنه یا اطلاعیه‌های قانونی) در مورد کنفرانس برای نمایش به کاربر. می‌تواند شامل HTML باشد. حداکثر طول آن ۲۰۴۸ کاراکتر است.
conferenceData.parameters object
یک شیء حاوی نقشه‌ای از داده‌های پارامتر تعریف‌شده برای استفاده توسط افزونه.
conferenceData.parameters.addOnParameters object
نقشه‌ای از کلیدها و مقادیر رشته پارامتر. این کلیدها و مقادیر توسط توسعه‌دهنده افزونه تعریف شده‌اند تا اطلاعات را به یک کنفرانس خاص برای استفاده افزونه پیوست کنند.

نقطه ورود

اشیاء نقطه ورود، اطلاعاتی در مورد روش‌های تعیین‌شده برای دسترسی به یک کنفرانس معین، مانند تلفن یا ویدیو، را حمل می‌کنند. این اطلاعات در شیء رویداد وجود دارد اگر و تنها اگر داده‌ها در رویداد تقویم وجود داشته باشند و افزونه، فیلد مانیفست addOns.calendar.currentEventAccess خود را روی READ یا READ_WRITE تنظیم کند.

شیء نقطه ورود
entryPoint.accessCode string
کد دسترسی مورد استفاده برای دسترسی به کنفرانس. حداکثر طول آن ۱۲۸ کاراکتر است. ارائه دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از { accessCode , meetingCode , passcode , password , pin } برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فیلدهایی را که ارائه دهنده کنفرانس استفاده می‌کند، مطابقت دهید و فقط نمایش دهید.
entryPoint.entryPointFeatures list
ویژگی‌های نقطه ورود. در حال حاضر این ویژگی‌ها فقط برای نقاط ورود phone اعمال می‌شوند:
  • toll : نقطه ورود، یک تماس تلفنی عوارضی است.
  • toll_free : نقطه ورود یک تماس تلفنی رایگان است.
entryPoint.entryPointType string
نوع نقطه ورود. مقادیر ممکن به شرح زیر است:
  • more : دستورالعمل‌های اضافی برای پیوستن به کنفرانس، مانند شماره تلفن‌های جایگزین. یک کنفرانس فقط می‌تواند یک نقطه ورود more داشته باشد؛ در صورت وجود، حداقل یک نوع نقطه ورود دیگر نیز مورد نیاز است.
  • phone : از طریق شماره تلفن به کنفرانس بپیوندید. یک کنفرانس می‌تواند هیچ یا چند نقطه ورود phone داشته باشد. تقویم گوگل فقط دو نقطه ورود تلفن اول را پس از قالب‌بندی و مرتب‌سازی بر اساس حروف الفبا نمایش می‌دهد.
  • sip : از طریق SIP به کنفرانس بپیوندید. یک کنفرانس می‌تواند حداکثر یک نقطه ورود sip داشته باشد.
  • video : از طریق HTTP به کنفرانس بپیوندید. یک کنفرانس می‌تواند حداکثر یک نقطه ورود video داشته باشد.
entryPoint.label string
برچسب قابل مشاهده توسط کاربر برای URI نقطه ورود (بومی‌سازی نشده).
entryPoint.meetingCode string
کد جلسه‌ای که برای دسترسی به کنفرانس استفاده می‌شود. حداکثر طول آن ۱۲۸ کاراکتر است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از { accessCode , meetingCode , passcode , password , pin } برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند، مطابقت دهید و فقط نمایش دهید.
entryPoint.passcode string
کد عبور مورد استفاده برای دسترسی به کنفرانس. حداکثر طول آن ۱۲۸ کاراکتر است. ارائه دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از { accessCode , meetingCode , passcode , password , pin } برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فیلدهایی را که ارائه دهنده کنفرانس استفاده می‌کند، مطابقت دهید و فقط نمایش دهید.
entryPoint.password string
رمز عبوری که برای دسترسی به کنفرانس استفاده می‌شود. حداکثر طول آن ۱۲۸ کاراکتر است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از { accessCode , meetingCode , passcode , password , pin } برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند، مطابقت دهید و فقط نمایش دهید.
entryPoint.pin string
پین مورد استفاده برای دسترسی به کنفرانس. حداکثر طول آن ۱۲۸ کاراکتر است. ارائه دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از { accessCode , meetingCode , passcode , password , pin } برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فیلدهایی را که ارائه دهنده کنفرانس استفاده می‌کند، مطابقت دهید و فقط نمایش دهید.
entryPoint.regionCode string
کد منطقه شماره تلفن. اگر URI شامل کد کشور نباشد، کاربران به آن نیاز دارند. مقادیر بر اساس فهرست عمومی کدهای منطقه CLDR هستند.
entryPoint.uri string
آدرس اینترنتی (URI) نقطه ورود. حداکثر طول آن ۱۳۰۰ کاراکتر است. قالب‌بندی آن به نوع نقطه ورود بستگی دارد:
  • more : یک طرحواره http: یا https: مورد نیاز است.
  • phone : یک طرحواره tel: مورد نیاز است. URI باید شامل کل توالی شماره گیری باشد (برای مثال، "tel:+12345678900,,,12345678;1234").
  • sip : یک طرحواره sip: یا sips: مورد نیاز است. برای مثال "sip:12345678@myprovider.com".
  • video : یک طرحواره http: یا https: مورد نیاز است.

شیء رویداد درایو

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

شیء رویداد درایو
drive.activeCursorItem Drive item object
مورد درایو در حال حاضر فعال است.
drive.selectedItems[] list of Drive item objects
فهرستی از موارد (فایل‌ها یا پوشه‌ها) انتخاب‌شده در درایو.

مورد درایو

اشیاء آیتم درایو، اطلاعاتی در مورد آیتم‌های خاص درایو، مانند فایل‌ها یا پوشه‌ها، را حمل می‌کنند.

شیء مورد درایو
item.addonHasFileScopePermission boolean
اگر مقدار true ، افزونه مجوز دامنه https://www.googleapis.com/auth/drive.file را برای این مورد درخواست و دریافت کرده است؛ در غیر این صورت این فیلد false است.
item.id string
شناسه‌ی آیتم انتخاب شده.
item.iconUrl string
آدرس اینترنتی (URL) آیکونی که نشان دهنده آیتم انتخاب شده است.
item.mimeType string
نوع MIME مورد انتخاب شده.
item.title string
عنوان مورد انتخاب شده.

شیء رویداد جیمیل

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

شیء رویداد جیمیل
gmail.accessToken string
توکن دسترسی مخصوص جیمیل. شما می‌توانید از این توکن به همراه متد GmailApp.setCurrentMessageAccessToken(accessToken) استفاده کنید تا به افزونه خود دسترسی موقت به پیام جیمیل باز فعلی کاربر بدهید یا به افزونه خود اجازه دهید پیش‌نویس‌های جدید بنویسد.
gmail.bccRecipients[] list of strings
به طور پیش‌فرض غیرفعال است . فهرست آدرس‌های ایمیل گیرنده "BCC:" که در حال حاضر در پیش‌نویسی که افزونه در حال نوشتن آن است، وجود دارد. برای فعال کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess را در مانیفست خود روی METADATA تنظیم کنید.
gmail.ccRecipients[] list of strings
به طور پیش‌فرض غیرفعال است . فهرست آدرس‌های ایمیل گیرنده "CC:" که در حال حاضر در پیش‌نویسی که افزونه در حال نوشتن آن است، وجود دارد. برای فعال کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess را در مانیفست خود روی METADATA تنظیم کنید.
gmail.messageId string
شناسه پیام Gmail که در حال حاضر باز است.
gmail.threadId string
شناسه‌ی رشته‌ی جیمیلِ در حال حاضر باز.
gmail.toRecipients[] list of strings
به طور پیش‌فرض غیرفعال است . فهرست آدرس‌های ایمیل گیرنده "To:" که در حال حاضر در پیش‌نویسی که افزونه در حال نوشتن آن است، وجود دارد. برای فعال کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess را در مانیفست خود روی METADATA تنظیم کنید.

شیء رویداد اسناد

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

شیء رویداد اسناد
docs.id string
فقط در صورتی ارائه می‌شود که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد .
شناسه سندی که در رابط کاربری Docs باز است.
docs.title string
فقط در صورتی ارائه می‌شود که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد .
عنوان سند در رابط کاربری Docs باز می‌شود.
docs.addonHasFileScopePermission boolean
اگر مقدار true ، افزونه مجوز دامنه https://www.googleapis.com/auth/drive.file را برای سندی که در رابط کاربری Docs باز است درخواست و دریافت کرده است؛ در غیر این صورت این فیلد false است.
docs.matchedUrl.url string
فقط در صورت احراز شرایط زیر ارائه می‌شود:
  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • این URL با الگوی میزبان مشخص شده در تریگر LinkPreviewTriggers مطابقت دارد.

آدرس اینترنتی (URL) لینکی که پیش‌نمایشی در Google Docs ایجاد می‌کند. برای استفاده از این فیلد، باید LinkPreviewTriggers را در مانیفست افزونه خود پیکربندی کنید. برای جزئیات بیشتر به پیش‌نمایش لینک‌ها با تراشه‌های هوشمند مراجعه کنید.

نمونه‌ای از payload برای زمانی که کاربر پیش‌نمایش لینک https://www.example.com/12345 را مشاهده می‌کند:

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

شیء رویداد Sheets

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

شیء رویداد Sheets
sheets.id string
فقط در صورتی ارائه می‌شود که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد . شناسه صفحه‌گسترده باز شده در رابط کاربری Sheets.
sheets.title string
فقط در صورتی ارائه می‌شود که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد . عنوان صفحه‌گسترده باز شده در رابط کاربری Sheets.
sheets.addonHasFileScopePermission boolean
اگر مقدار true ، افزونه مجوز دامنه https://www.googleapis.com/auth/drive.file را برای صفحه‌گسترده باز شده در رابط کاربری Sheets درخواست و دریافت کرده است؛ در غیر این صورت این فیلد false است.
sheets.matchedUrl.url string
فقط در صورت احراز شرایط زیر ارائه می‌شود:
  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • این URL با الگوی میزبان مشخص شده در تریگر LinkPreviewTriggers مطابقت دارد.

آدرس اینترنتی (URL) لینکی که پیش‌نمایشی در گوگل شیت ایجاد می‌کند. برای استفاده از این فیلد، باید LinkPreviewTriggers را در مانیفست افزونه خود پیکربندی کنید. برای جزئیات بیشتر به پیش‌نمایش لینک‌ها با تراشه‌های هوشمند مراجعه کنید.

نمونه‌ای از payload برای زمانی که کاربر پیش‌نمایش لینک https://www.example.com/12345 را مشاهده می‌کند:

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

شیء رویداد اسلایدها

The Slides event object is the portion of the overall event object that carries information about a user's document and its contents. It's only present in an event object if the add-on extends Google Slides.

Slides event object
slides.id string
Only present if the https://www.googleapis.com/auth/drive.file scope has been authorized by the user . The ID of the presentation open in the Slides UI.
slides.title string
Only present if the https://www.googleapis.com/auth/drive.file scope has been authorized by the user . The title of the presentation open in the Slides UI.
slides.addonHasFileScopePermission boolean
If true , the add-on has requested and received https://www.googleapis.com/auth/drive.file scope authorization for the presentation open in the Slides UI; otherwise this field is false .
slides.matchedUrl.url string
Only present if the following conditions are met:
  • https://www.googleapis.com/auth/workspace.linkpreview has been authorized by the user.
  • The URL matches the host pattern specified in the LinkPreviewTriggers trigger.

The URL of the link that generates a preview in Google Slides. To use this field, you must configure the LinkPreviewTriggers in your add-on's manifest. See Preview links with smart chips for more details.

Example payload for when a user previews the link https://www.example.com/12345 :

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}