اشیای رویداد

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

شیء 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 می‌توانند از این شیء رویداد برای پر کردن موارد پیشنهادی از منبع داده پویا استفاده کنند. برای مثال، برای پر کردن پرونده‌های پشتیبانی از منبع داده خارجی، برنامه 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
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 برای 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: ازطریق شماره تلفن به کنفرانس بپیوندید. کنفرانس می‌تواند صفر یا چند نقطه ورودی 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
کد منطقه شماره تلفن. اگر URI شامل کد کشور نباشد، کاربران به آن نیاز دارند. مقادیر براساس فهرست عمومی کدهای منطقه CLDR است.
entryPoint.uri string
URI نقطه ورودی. حداکثر طول ۱۳۰۰ نویسه است. قالب‌بندی به نوع نقطه ورودی بستگی دارد:
  • 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 تنظیم کنید.

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

شیء رویداد Docs بخشی از شیء رویداد کلی است که اطلاعات مربوط به سند کاربر و محتوای آن را حمل می‌کند. این ویژگی فقط درصورتی در شیء رویداد وجود دارد که برافزا «سندنگار 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
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"
  }
}