اشیاء رویداد

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

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

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

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

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

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

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

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

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

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

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

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

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

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

شی رویداد
eventObject.commonEventObject Common fields object
یک شی حاوی اطلاعات مشترک برای همه اشیاء رویداد، صرف نظر از برنامه میزبان.
eventObject.calendar Calendar event object
فقط در صورتی ارائه شود که میزبان تماس گیرنده Google Calendar باشد . یک شی حاوی اطلاعات تقویم و رویداد.
eventObject.chat Chat event object
فقط در صورتی ارائه شود که میزبان تماس Google Chat باشد . یک شی حاوی اطلاعات چت.
eventObject.drive Drive event object
فقط در صورتی ارائه شود که میزبان تماس گیرنده Google Drive باشد . یک شی حاوی اطلاعات Drive.
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 باشد . یک شی حاوی اطلاعات اسلایدها.
فیلدهای افزودنی اصلی 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 مراجعه کنید.

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
زمان انتخاب شده توسط کاربر، بر حسب میلی ثانیه از زمان (00:00:00 UTC در 1 ژانویه 1970).
شیء DateInput
dateInput.msSinceEpoch string
زمان انتخاب شده توسط کاربر، بر حسب میلی ثانیه از زمان (00:00:00 UTC در 1 ژانویه 1970).
شیء TimeInput
timeInput.hours number
تعداد ساعت انتخاب شده توسط کاربر.
timeInput.minutes number
تعداد دقیقه انتخاب شده توسط کاربر.

شی رویداد چت

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

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

string ( Timestamp format)

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

payload میدان اتحادیه

payload می تواند تنها یکی از موارد زیر باشد:

chat.messagePayload

object ( MessagePayload )

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

chat.addedToSpacePayload

object ( AddedToSpacePayload )

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

chat.removedFromSpacePayload

object ( RemovedFromSpacePayload )

محموله‌ای که برنامه‌های چت از راه‌انداز Removed from space دریافت می‌کنند.

chat.buttonClickedPayload

object ( ButtonClickedPayload )

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

chat.widgetUpdatedPayload

object ( WidgetUpdatedPayload )

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

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

chat.appCommandPayload

object ( AppCommandPayload )

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

بار

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

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

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

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

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

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

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

بار فشاری روی دکمه کلیک کرد
ButtonClickedPayload
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 کاربر روی یک عنصر تعاملی در یک گفتگو کلیک می کند. به عنوان مثال، یک کاربر اطلاعات را در یک گفتگو پر می کند و برای ارسال اطلاعات روی دکمه ای کلیک می کند.

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

بار فرمان برنامه
AppCommandPayload
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 کاربر روی یک عنصر تعاملی در یک گفتگو کلیک می کند. به عنوان مثال، یک کاربر اطلاعات را در یک گفتگو پر می کند و برای ارسال اطلاعات روی دکمه ای کلیک می کند.
فراداده فرمان برنامه
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string ( int64 format)

شناسه فرمان

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

Enum AppCommandType .

مقدار AppCommandType می تواند تنها یکی از موارد زیر باشد:

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

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

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

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

شرکت کننده

اشیاء شرکت‌کننده اطلاعات مربوط به شرکت‌کنندگان را به رویدادهای Google Calendar حمل می‌کنند. این اطلاعات در شیء رویداد وجود دارد اگر و فقط اگر داده ها در رویداد تقویم وجود داشته باشد و افزودنی آن را 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
فهرست نقاط ورودی کنفرانس، مانند URL ها یا شماره تلفن.
conferenceData.notes string
یادداشت‌های اضافی (مانند دستورالعمل‌های مدیر دامنه یا اطلاعیه‌های قانونی) درباره کنفرانس برای نمایش به کاربر. می تواند حاوی HTML باشد. حداکثر طول 2048 کاراکتر است.
conferenceData.parameters object
یک شی حاوی نقشه ای از داده های پارامتر تعریف شده برای استفاده توسط افزونه.
conferenceData.parameters.addOnParameters object
نقشه ای از کلیدهای رشته پارامتر و مقادیر. این کلیدها و مقادیر توسط توسعه دهنده افزونه برای پیوست کردن اطلاعات به یک کنفرانس خاص برای استفاده افزونه تعریف شده است.

نقطه ورود

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

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

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

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

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

مورد Drive

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

شی مورد درایو
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 باشد.

شی رویداد Gmail
gmail.accessToken string
نشانه دسترسی خاص Gmail. شما می توانید از این Token با روش GmailApp.setCurrentMessageAccessToken(accessToken) استفاده کنید تا دسترسی موقت خود را به پیام Gmail در حال حاضر کاربر باز کنید یا به شما اجازه دهید افزودنی شما را تهیه کند.
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.threadId string
شناسه رشته Gmail که در حال حاضر باز است.
gmail.toRecipients[] list of strings
به طور پیش فرض غیرفعال است . فهرست آدرس‌های ایمیل گیرنده «به:» که در حال حاضر در پیش‌نویسی که افزونه در حال نوشتن است، گنجانده شده است. برای روشن کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess در مانیفست خود روی METADATA تنظیم کنید.

شی رویداد Docs

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

شی رویداد 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 UI را درخواست کرده و دریافت کرده است. در غیر این صورت این فیلد false است.
docs.matchedUrl.url string
فقط در صورت رعایت شرایط زیر ارائه می شود:
  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • URL با الگوی میزبان مشخص شده در راه‌انداز LinkPreviewTriggers مطابقت دارد.

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

بار نمونه برای زمانی که کاربر پیوند را پیش‌نمایش می‌کند 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.title string
فقط در صورتی ارائه شود که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز باشد . عنوان صفحه‌گسترده در رابط کاربر کاربرگ‌نگار باز می‌شود.
sheets.addonHasFileScopePermission boolean
اگر true ، افزودنی درخواست کرده و https://www.googleapis.com/auth/drive.file مجوز دامنه برای صفحه گسترده باز در برگه های UI را درخواست کرده و دریافت کرده است. در غیر این صورت این فیلد false است.
sheets.matchedUrl.url string
فقط در صورت رعایت شرایط زیر ارائه می شود:
  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • URL با الگوی میزبان مشخص شده در راه‌انداز LinkPreviewTriggers مطابقت دارد.

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

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

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

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

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

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

URL پیوندی که پیش نمایش در Google Slides ایجاد می کند. برای استفاده از این قسمت ، باید LinkPreviewTriggers در مانیفست افزودنی خود پیکربندی کنید. برای اطلاعات بیشتر به پیوندهای پیش نمایش با تراشه های هوشمند مراجعه کنید.

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

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