اشیای رویداد

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

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

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

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

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

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

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

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

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

  • راه‌اندازهای پیوند پیش‌نمایش. در «سندنگار»، «کاربرگ‌نگار»، و «اسلایدنگار» Google می‌توانید پیش‌نمایش پیوند را برای سرویس‌های طرف سوم براساس الگوهای نشانی وب خاص پیکربندی کنید. وقتی کاربران با پیوندی که با الگو مطابقت دارد تعامل می‌کنند، linkPreviewTriggers راه‌اندازی می‌شود و یک شیء رویداد حاوی پیوند به تابع برگشتی راه‌انداز منتقل می‌شود. برافزایتان می‌تواند از این شیء رویداد برای ساختن تراشه هوشمند و کارتی استفاده کند که اطلاعات مربوط به پیوند را در برنامه میزبان نشان دهد. همچنین می‌توانید کنش‌های ابزاره بسازید تا کاربران بتوانند با کارت پیش‌نمایش و محتوای آن تعامل داشته باشند.

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

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

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

برای سازگاری با نسخه‌های قبلی، اشیای رویداد برافزاهای Google Workspace شامل فیلدهای اصلی استفاده‌شده در اشیای رویداد کنش برافزای Gmail است. این فیلدها در بخش «فیلدهای برافزای اصلی Gmail» قرار دارند و بخشی از commonEventObject نیستند.

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

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

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

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

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

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

برای برافزاهای 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 بااستفاده از Action.setParameters ارائه می‌دهید. کلیدها و مقادیر نقشه رشته‌ای هستند.

برای برافزاهای 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: a DateTimeInput object.

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

  • ‫A date-only picker: a DateInput object.

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

  • ‫A time-only picker: a 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 دریافت کنند. این شامل مقادیر تاریخ یا زمان انتخاب‌شده کاربر در ابزارک‌های انتخاب‌گر تاریخ یا زمان می‌شود. ساختار اطلاعات بسته به اینکه ابزارک به‌عنوان انتخاب‌گر تاریخ-زمان، انتخاب‌گر فقط تاریخ، یا انتخاب‌گر فقط زمان پیکربندی شده باشد متفاوت است. تفاوت‌های ساختاری در جدول زیر شرح داده شده است:

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

شیء رویداد گپ

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

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

string (Timestamp format)

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

فیلد اتحادیه payload. برای راه‌انداز صفحه اصلی برنامه (وقتی کاربر زبانه صفحه اصلی را باز می‌کند)، payload تنظیم نشده است و chat حاوی chat.user و chat.eventTime است.

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

object (MessagePayload)

بار ارسالی که برنامه‌های Chat از راه‌انداز پیام دریافت می‌کنند.
chat.addedToSpacePayload

object (AddedToSpacePayload)

بار ارسالی که برنامه‌های Chat از راه‌انداز افزوده‌شده به فضا دریافت می‌کنند.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

بار ارسالی که برنامه‌های Chat از راه‌انداز برداشته‌شده از فضا دریافت می‌کنند.
chat.buttonClickedPayload

object (ButtonClickedPayload)

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

object (WidgetUpdatedPayload)

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

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

chat.appCommandPayload

object (AppCommandPayload)

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

پایه‌بار

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

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

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

chat.addedToSpacePayload.interactionAdd boolean
اینکه کاربر برنامه Chat را به فضا اضافه کند بااستفاده از پیام. برای مثال، برنامه Chat را @نامبری می‌کند یا از فرمان استفاده می‌کند. اگر true، Chat شیء رویداد دیگری با messagePayload که حاوی اطلاعاتی درباره پیام است ارسال می‌کند.
chat.addedToSpacePayload.configCompleteRedirectUri string
نشانی وبی که برنامه Chat باید کاربر را پس‌از تکمیل جریان مجوز یا پیکربندی در خارج از Google Chat به آن هدایت کند. برای اطلاعات بیشتر، اتصال برافزای Google Workspace به سرویس طرف سوم را ببینید.
از محتوای فضای کاری برداشته شد
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
فضای Chat که کاربر برنامه Chat را از آن برداشته یا حذف نصب کرده است.

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

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

شمارشی DialogEventType.

مقدار dialogEventType فقط می‌تواند یکی از موارد زیر باشد:
TYPE_UNSPECIFIED مقدار پیش‌فرض. نامشخص.
REQUEST_DIALOG کاربر کادر گفتگویی را درخواست می‌کند. برای مثال، از فرمان استفاده می‌کنند یا روی دکمه‌ای در پیام کلیک می‌کنند.
SUBMIT_DIALOG کاربری روی عنصر تعاملی در کادر گفتگو کلیک می‌کند. برای مثال، کاربر اطلاعاتی را در یک کادر گفتگو تکمیل می‌کند و روی دکمه‌ای برای ارسال اطلاعات کلیک می‌کند.
بار ابزاره به‌روزرسانی‌شده
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
فضای Chat که تعامل در آن رخ داده است.
پایه بار فرمان برنامه
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
فراداده درباره اینکه کاربر از کدام فرمان استفاده کرده است و چگونه آن را راه‌اندازی کرده است.
chat.appCommandPayload.space object (Space)
فضای Chat که کاربر در آن از فرمان استفاده کرده است.
chat.appCommandPayload.thread object (Thread)
اگر تعامل در رشته‌ای رخ داده باشد، رشته Chat که کاربر از فرمان استفاده کرده است.
chat.appCommandPayload.message object (Message)
برای فرمان‌های خط مورب، پیام حاوی فرمان خط مورب.
chat.appCommandPayload.configCompleteRedirectUri string
اگر برای فرمان، مجوز یا پیکربندی لازم باشد، نشانی وبی برای بازهدایت کاربر پس‌از تکمیل فرایند در خارج از Google Chat.
chat.appCommandPayload.isDialogEvent boolean
اینکه آیا فرمان کادر گفتگویی را باز می‌کند یا نه.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
نوع تعامل با کادر گفتگو.

شمارشی DialogEventType.

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

string (int64 format)

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

شمارشی AppCommandType.

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

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

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

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

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

شیء رویداد تقویم
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
شناسه رویداد تکرارشونده.

شرکت‌کننده

اشیا شرکت‌کننده اطلاعات مربوط به شرکت‌کنندگان را به رویدادهای «تقویم Google» منتقل می‌کنند. این اطلاعات در شیء رویداد وجود دارد اگر و فقط اگر داده‌ها در رویداد «تقویم» وجود داشته باشد و برافزا فیلد 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» پیوست شده‌اند حمل می‌کنند. این‌ها می‌توانند راه‌حل‌های کنفرانس Google مثل Google Meet، یا کنفرانس‌های طرف سوم باشند. این اطلاعات در شیء رویداد وجود دارد اگر و فقط اگر داده‌ها در رویداد «تقویم» وجود داشته باشد و برافزا فیلد addOns.calendar.currentEventAccess مانیفست را روی READ یا READ_WRITE تنظیم کند.

شیء داده‌های کنفرانس
conferenceData.conferenceId string
شناسه کنفرانس. این شناسه برای این منظور است که به برنامه‌ها اجازه دهد کنفرانس‌ها را پیگیری کنند؛ نباید این شناسه را به کاربران نمایش دهید.
conferenceData.conferenceSolution object
شیئی که نشان‌دهنده راهکار کنفرانس است، مثل Hangouts یا Google Meet.
conferenceData.conferenceSolution.iconUri string
نشانی وب نماد نمایان برای کاربر که نشان‌دهنده این راه‌حل کنفرانس است.
conferenceData.conferenceSolution.key object
کلیدی که راه‌حل کنفرانس را برای این رویداد به‌طور یکتا شناسایی می‌کند.
conferenceData.conferenceSolution.key.type string
نوع راه‌حل کنفرانس. مقادیر ممکن شامل موارد زیر است:
  • eventHangout برای Hangouts ویژه مصرف‌کنندگان (http://hangouts.google.com).
  • eventNamedHangout برای «نسخه قدیمی Hangouts» ویژه کاربران Google Workspace (http://hangouts.google.com).
  • ‫hangoutsMeet برای Google Meet (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: ازطریق شماره تلفن به کنفرانس بپیوندید. A کنفرانس می‌تواند صفر یا چند نقطه ورود phone داشته باشد. «تقویم Google» فقط دو نقطه ورودی تلفن اول را پس‌از قالب‌بندی و مرتب‌سازی الفبایی نمایش می‌دهد.
  • ‫sip: ازطریق SIP به کنفرانس بپیوندید. کنفرانس می‌تواند حداکثر یک نقطه ورود sip داشته باشد.
  • ‫video: ازطریق HTTP به کنفرانس بپیوندید. کنفرانس می‌تواند حداکثر یک نقطه ورود video داشته باشد.
entryPoint.label string
برچسب قابل‌مشاهده کاربر برای نشانی وب نقطه ورودی (بومی‌سازی‌نشده).
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
کد منطقه شماره تلفن. اگر نشانی وب کد کشور نداشته باشد، کاربران به آن نیاز دارند. مقادیر براساس فهرست عمومی کدهای منطقه CLDR است.
entryPoint.uri string
نشانی وب نقطه ورودی. حداکثر طول ۱۳۰۰ نویسه است. قالب‌بندی به نوع نقطه ورودی بستگی دارد:
  • ‫more: طرحواره http: یا https: الزامی است.
  • ‫phone: طرحواره tel: الزامی است. نشانی وب باید شامل کل توالی شماره‌گیری باشد (برای مثال، «tel:+12345678900,,,12345678;1234»).
  • ‫sip: طرحواره sip: یا sips: الزامی است. برای مثال «sip:12345678@myprovider.com».
  • ‫video: طرحواره http: یا https: الزامی است.

شیء رویداد Drive

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

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

مورد Drive

اشیا مورد Drive اطلاعاتی درباره موارد خاص Drive، مانند فایل‌ها یا پوشه‌ها، دارند.

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

شیء رویداد Gmail

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

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

شیء رویداد «سندنگار»

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

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

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

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

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

شیء رویداد «کاربرگ‌نگار»

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

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

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

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

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

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

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

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

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

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

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