- EventObject
- CommonEventObject
- HostApp
- پلاتفرم
- TimeZone
- ورودیها
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- سازماندهنده
- شرکتکننده
- ConferenceData
- ConferenceSolution
- کلید
- EntryPoint
- پارامترها
- AddOnParameters
- قابلیتها
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- تراشه
- نماد
- StyledText
- سبک
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
رویداد تعامل برافزای Google که حاوی دادههایی درباره تعامل کاربر با برافزا در برنامه میزبان است.
وقتی کاربر با برافزایی در برنامه میزبان تعامل برقرار میکند، شیء رویداد بهصورت JSON به تابع بازخوانی یا راهانداز برافزا (برای AppsScript)، یا https نقطه پایانی (برای HTTP) ارسال میشود. شیء رویداد یک شیء رویداد برنامه میزبان را که توسط هر برنامه میزبان تعریف شده است، و همچنین یک شیء رویداد مشترک را که حاوی برخی فیلدهای مشترک مرتبط با رویداد است ذخیره میکند.
برای اطلاعات بیشتر، اشیاء رویداد را ببینید.
| نمایش JSON |
|---|
{ "commonEventObject": { object ( |
| فیلدها | |
|---|---|
commonEventObject |
شیئی حاوی اطلاعات مشترک برای همه اشیای رویداد، صرفنظر از برنامه میزبان. |
authorizationEventObject |
فقط برای درخواستهای ارسالشده به نقاط پایانی HTTP تنظیم شده است |
| در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
calendar |
فقط درصورتی وجود دارد که میزبان تماس «تقویم Google» باشد. شیئی که حاوی اطلاعات تقویم و رویداد است. |
drive |
فقط درصورتی وجود دارد که میزبان تماسگیرنده Google Drive باشد. شیء حاوی اطلاعات Drive. |
gmail |
فقط درصورتی وجود دارد که میزبان تماس Gmail باشد. شیء حاوی اطلاعات Gmail. |
sheets |
فقط درصورتی وجود دارد که میزبان تماسگیرنده «کاربرگنگار Google» باشد. شیء حاوی اطلاعات «کاربرگنگار». |
slides |
فقط درصورتی وجود دارد که میزبان تماس «اسلایدنگار Google» باشد. شیء حاوی اطلاعات «اسلایدنگار». |
docs |
فقط درصورتی وجود دارد که میزبان تماس «سندنگار Google» باشد. شیء حاوی اطلاعات «سندنگار». |
chat |
فقط درصورتی وجود دارد که میزبان تماس Google Chat باشد. شیء حاوی اطلاعات Chat. |
workflow |
فقط درصورتی وجود دارد که میزبان تماس Google Workspace Studio باشد. شیء حاوی اطلاعات گردش کار. |
| پایان فیلدهای متقابلاً انحصاری. | |
CommonEventObject
شیء رویداد مشترک بخشی از شیء رویداد کلی است که اطلاعات عمومی و مستقل از میزبان را از کارخواه کاربر به برافزا منتقل میکند. این اطلاعات شامل جزئیاتی مانند منطقه کاربر، برنامه میزبان، و پلاتفرم است.
علاوهبر راهاندازهای صفحه اصلی و زمینهای، برافزاها هنگام تعامل کاربر با ابزارهها، اشیای رویداد را میسازند و به توابع بازخوانی کنش ارسال میکنند. تابع بازخوانی برافزای شما میتواند شیء رویداد مشترک را پُرسمان کند تا محتوای ابزارههای باز را در کارخواه کاربر تعیین کند. برای مثال، برافزای شما میتواند نوشتاری را که کاربر در ابزاره TextInput در شیء eventObject.commentEventObject.formInputs وارد کرده است پیدا کند.
برای برنامههای Chat، نام تابعی که کاربر هنگام تعامل با ابزاره فراخوانی کرده است.
| نمایش JSON |
|---|
{ "userLocale": string, "hostApp": enum ( |
| فیلدها | |
|---|---|
userLocale |
بهطور پیشفرض غیرفعال است. شناسه زبان و کشور/منطقه کاربر در قالب کد زبان ISO 639-کد کشور/منطقه ISO 3166. بهعنوان مثال، برای روشن کردن این فیلد، باید |
hostApp |
نشاندهنده برنامه میزبانی است که برافزا در آن فعال است، زمانی که شیء رویداد تولید میشود. مقادیر ممکن شامل موارد زیر است:
|
platform |
شمارش پلاتفرم که پلاتفرمی را که رویداد از آن نشئت میگیرد نشان میدهد ( |
timeZone |
بهطور پیشفرض غیرفعال است. شناسه منطقه زمانی و فاصله از ساعت هماهنگ جهانی (UTC). برای روشن کردن این فیلد، باید فقط برای انواع رویداد |
formInputs |
نقشهای حاوی مقادیر فعلی ابزارکها در کارت نمایشدادهشده. کلیدهای نقشه مقادیر رشته ساختار شیء مقدار نقشه به نوع ابزاره بستگی دارد: توجه: نمونههای زیر برای زمان اجرای V8 در Apps Script قالببندی شدهاند. اگر از Rhino runtime استفاده میکنید، باید
مثال: برای ابزاره ورودی نوشتار با
مثال: برای ابزاره چندمقداری با
مثال: برای انتخابگری با
مثال: برای انتخابگری با
مثال: برای انتخابگری با شیئی که حاوی فهرستی از جفتهای |
parameters |
هر پارامتر دیگری که بااستفاده از پیشنمایش توسعهدهندگان نرمافزار: برای برافزاهایی که Google Chat را گسترش میدهند، برای پیشنهاد دادن موارد براساس آنچه کاربران در منوهای چندانتخابی تایپ میکنند، از مقدار کلید شیئی که حاوی فهرستی از جفتهای |
invokedFunction |
نام تابع برای فراخوانی. این فیلد برای «برافزاهای Google Workspace» که Google Chat را گسترش میدهند درج نمیشود. درعوض، برای دریافت دادههای عملکردی مانند شناسهها، برافزاهایی که Chat را گسترش میدهند باید از فیلد |
HostApp
برنامه Google Workspace برای برافزای Google Workspace یا برنامه Google Chat.
برای برافزاها، برنامه Workspace که برافزای Google Workspace از آن راهاندازی میشود. برای برنامههای Chat، برنامه میزبان همیشه CHAT است.
| شمارشیها | |
|---|---|
UNSPECIFIED_HOST_APP |
Google نمیتواند برنامه میزبان را شناسایی کند. |
GMAIL |
برافزا از Gmail راهاندازی میشود. |
CALENDAR |
برافزا از «تقویم Google» راهاندازی میشود. |
DRIVE |
برافزا از Google Drive راهاندازی میشود. |
DEMO |
استفادهنشده. |
DOCS |
برافزا از «سندنگار Google» راهاندازی میشود. |
MEET |
برافزا از Google Meet راهاندازی میشود. |
SHEETS |
برافزا از «کاربرگنگار Google» راهاندازی میشود. |
SLIDES |
برافزا از «اسلایدنگار Google» راهاندازی میشود. |
DRAWINGS |
برافزا از Google Drawings راهاندازی میشود. |
CHAT |
برنامه Google Chat. |
پلاتفرم
مشخص میکند این تماس از کدام پلاتفرم برقرار شده است.
| شمارشیها | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
شناسه منطقه زمانی و فاصله از ساعت هماهنگ جهانی (UTC). فقط برای انواع رویداد CARD_CLICKED و SUBMIT_DIALOG پشتیبانی میشود.
| نمایش JSON |
|---|
{ "id": string, "offset": integer } |
| فیلدها | |
|---|---|
id |
کد پایگاه داده منطقه زمانی IANA TZ، مانند «America/Toronto». |
offset |
فاصله زمانی منطقه زمانی کاربر، برحسب میلیثانیه، از «ساعت هماهنگ جهانی» (UTC). |
ورودیها
انواع دادههایی که کاربران میتوانند در کارتها یا کادرهای گفتگو وارد کنند. نوع ورودی به نوع مقادیری بستگی دارد که ابزاره میپذیرد.
| نمایش JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| فیلدها | |
|---|---|
| در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
stringInputs |
فهرستی از رشتهها که مقادیر ورودی کاربر در ابزاره را نشان میدهد. اگر ابزارک فقط یک مقدار را بپذیرد، مثل ابزارک |
dateTimeInput |
مقادیر ورودی تاریخ و زمان از ابزاره |
dateInput |
مقادیر ورودی تاریخ از ابزاره |
timeInput |
مقادیر ورودی زمان از ابزاره |
| پایان فیلدهای متقابلاً انحصاری. | |
StringInputs
پارامتر ورودی برای ابزارههای معمولی. برای ابزارههای تکمقداری، این فهرست تکمقداری است. برای ابزارههای چندمقداری، مثل چارگوش انتخاب، همه مقادیر ارائه میشود.
| نمایش JSON |
|---|
{ "value": [ string ] } |
| فیلدها | |
|---|---|
value[] |
فهرستی از رشتههای واردشده توسط کاربر. |
DateTimeInput
مقادیر ورودی تاریخ و زمان.
| نمایش JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| فیلدها | |
|---|---|
msSinceEpoch |
زمان سپریشده از تاریخ، برحسب میلیثانیه. |
hasDate |
اینکه ورودی |
hasTime |
آیا ورودی |
DateInput
مقادیر ورودی تاریخ.
| نمایش JSON |
|---|
{ "msSinceEpoch": string } |
| فیلدها | |
|---|---|
msSinceEpoch |
زمان سپریشده از تاریخ، برحسب میلیثانیه. |
TimeInput
مقادیر ورودی زمان.
| نمایش JSON |
|---|
{ "hours": integer, "minutes": integer } |
| فیلدها | |
|---|---|
hours |
ساعت در قالب ۲۴ ساعته. |
minutes |
تعداد دقیقههای گذشته از ساعت. مقادیر معتبر ۰ تا ۵۹ است. |
AuthorizationEventObject
اطلاعات مجوز را برای درخواست برافزا کپسولهسازی میکند
| نمایش JSON |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| فیلدها | |
|---|---|
userOAuthToken |
کد دسترسی OAuth کاربر نهایی، با دامنههای درخواستی مجاز شده است. (پساز جداسازی موافقت oAuth، این مورد با دامنههای مجاز کاربر نهایی مجاز خواهد شد) |
userIdToken |
یک شناسه کاربر نهایی، اگر گسترههای شناسه مناسب درخواست شده باشد |
systemIdToken |
یک شناسه برای حساب سرویس «برافزاهای G Suite» برای این استقرار |
authorizedScopes[] |
فهرست دامنههای OAuth که کاربر مجاز کرده است. |
CalendarEventObject
شیء رویداد «تقویم» بخشی از شیء رویداد کلی است که اطلاعات مربوط به تقویم کاربر و رویدادهای تقویم را حمل میکند. فقط درصورتی در شیء رویداد وجود دارد که برنامه میزبان «تقویم Google» باشد.
جدول زیر فیلدهای موجود در فیلد calendar شیء رویداد را فهرست میکند. فیلدهایی که بهعنوان دادههای تولیدشده توسط کاربر علامتگذاری شدهاند، در شیء رویداد وجود دارند اگر و تنها اگر دادهها در رویداد «تقویم» وجود داشته باشند و برافزا فیلد addOns.calendar.currentEventAccess مانیفست خود را روی READ یا READ_WRITE تنظیم کند.
| نمایش JSON |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| فیلدها | |
|---|---|
id |
شناسه رویداد. |
recurringEventId |
شناسه رویداد تکرارشونده. |
calendarId |
شناسه تقویم. |
organizer |
شیئی که نشاندهنده سازماندهنده رویداد است. |
attendees[] |
دادههای تولیدشده توسط کاربر. فهرستی از شرکتکنندگان رویداد تقویم. |
conferenceData |
دادههای تولیدشده توسط کاربر. شیئی که نشاندهنده هرگونه داده کنفرانس مرتبط با این رویداد است، مانند جزئیات کنفرانس Google Meet. |
capabilities |
دادههای تولیدشده توسط کاربر. شیئی که قابلیتهای برافزا را برای مشاهده یا بهروزرسانی اطلاعات رویداد توصیف میکند. |
سازماندهنده
| نمایش JSON |
|---|
{ "email": string } |
| فیلدها | |
|---|---|
email |
نشانی ایمیل سازماندهنده رویداد. |
شرکتکننده
اشیاء شرکتکننده اطلاعاتی درباره شرکتکنندگان فردی در رویدادهای «تقویم Google» دارند. این اطلاعات در شیء رویداد وجود دارد اگر و تنها اگر دادهها در رویداد «تقویم» وجود داشته باشد و برافزا فیلد addOns.calendar.currentEventAccess مانیفست خود را روی READ یا READ_WRITE تنظیم کند.
| نمایش JSON |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| فیلدها | |
|---|---|
email |
نشانی ایمیل شرکتکننده. |
displayName |
نام نمایشی شرکتکننده. |
organizer |
true اگر شرکتکننده سازماندهنده این رویداد باشد. |
self |
درست اگر این شرکتکننده نشاندهنده تقویمی باشد که این رویداد در آن نمایش داده میشود؛ درغیراینصورت نادرست. |
resource |
true اگر شرکتکننده نماینده منبعی مثل اتاق یا قطعهای از تجهیزات باشد؛ درغیراینصورت false. |
optional |
اگر حضور این شرکتکننده بهعنوان اختیاری علامتگذاری شده باشد، درست است؛ درغیراینصورت نادرست است. |
responseStatus |
وضعیت پاسخ شرکتکننده. مقادیر ممکن شامل موارد زیر است:
|
comment |
نظر پاسخ شرکتکننده، درصورت وجود. |
additionalGuests |
تعداد مهمانان اضافهای که شرکتکننده اعلام کرده است با خود میآورد. پیشفرض صفر است. |
ConferenceData
اشیاء داده کنفرانس حاوی اطلاعاتی درباره کنفرانسهایی هستند که به رویدادهای «تقویم Google» پیوست شدهاند. اینها میتوانند راهحلهای کنفرانس Google، مانند Google Meet، یا کنفرانسهای طرف سوم باشند. این اطلاعات در شیء رویداد وجود دارد اگر و تنها اگر دادهها در رویداد «تقویم» وجود داشته باشد و برافزا فیلد addOns.calendar.currentEventAccess مانیفست خود را روی READ یا READ_WRITE تنظیم کند.
| نمایش JSON |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| فیلدها | |
|---|---|
conferenceId |
شناسه کنفرانس. این شناسه برای این است که برنامهها بتوانند کنفرانسها را پیگیری کنند؛ نباید این شناسه را به کاربران نشان دهید. |
conferenceSolution |
شیء نشاندهنده راهکار کنفرانس، مثل Hangouts یا Google Meet. |
entryPoints[] |
فهرست نقاط ورودی کنفرانس، مانند نشانیهای وب یا شماره تلفنها. |
notes |
یادداشتهای اضافی (مانند دستورالعملهای سرپرست دامنه یا اعلامیههای حقوقی) درباره کنفرانس برای نمایش به کاربر. میتواند حاوی HTML باشد. حداکثر طول ۲۰۴۸ نویسه است. |
parameters |
شیء حاوی نقشهای از دادههای پارامتر تعریفشده برای استفاده توسط برافزا. |
ConferenceSolution
| نمایش JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| فیلدها | |
|---|---|
iconUri |
URI برای نماد قابلمشاهده برای کاربر که نشاندهنده این راهحل کنفرانس است. |
key |
کلیدی که راهکار کنفرانس را برای این رویداد بهطور یکتا شناسایی میکند. |
name |
نام قابلمشاهده برای کاربر این راهحل کنفرانس (بومیسازی نشده). |
کلید
| نمایش JSON |
|---|
{ "type": string } |
| فیلدها | |
|---|---|
type |
نوع راهحل کنفرانس. مقادیر ممکن شامل موارد زیر است:
|
EntryPoint
اشیاء نقطه ورودی حاوی اطلاعاتی درباره روشهای ایجادشده برای دسترسی به کنفرانس موردنظر هستند، مثلاً ازطریق تلفن یا ویدیو. این اطلاعات در شیء رویداد وجود دارد اگر و تنها اگر دادهها در رویداد «تقویم» وجود داشته باشد و برافزا فیلد addOns.calendar.currentEventAccess مانیفست خود را روی READ یا READ_WRITE تنظیم کند.
| نمایش JSON |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| فیلدها | |
|---|---|
accessCode |
کد دسترسی استفادهشده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائهدهندگان کنفرانس معمولاً فقط از زیرمجموعهای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانسها استفاده میکنند. فقط فیلدهایی را که ارائهدهنده کنفرانس استفاده میکند مطابقت دهید و نمایش دهید. |
entryPointType |
نوع نقطه ورودی. مقادیر ممکن عبارتاند از:
|
label |
برچسب قابلمشاهده برای کاربر برای URI نقطه ورودی (بومیسازینشده). |
meetingCode |
کد جلسه استفادهشده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائهدهندگان کنفرانس معمولاً فقط از زیرمجموعهای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانسها استفاده میکنند. فقط فیلدهایی را که ارائهدهنده کنفرانس استفاده میکند مطابقت دهید و نمایش دهید. |
passcode |
گذرنویسه مورداستفاده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائهدهندگان کنفرانس معمولاً فقط از زیرمجموعهای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانسها استفاده میکنند. فقط فیلدهایی را که ارائهدهنده کنفرانس استفاده میکند مطابقت دهید و نمایش دهید. |
password |
گذرواژه مورداستفاده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائهدهندگان کنفرانس معمولاً فقط از زیرمجموعهای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانسها استفاده میکنند. فقط فیلدهایی را که ارائهدهنده کنفرانس استفاده میکند مطابقت دهید و نمایش دهید. |
pin |
پین مورداستفاده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائهدهندگان کنفرانس معمولاً فقط از زیرمجموعهای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانسها استفاده میکنند. فقط فیلدهایی را که ارائهدهنده کنفرانس استفاده میکند مطابقت دهید و نمایش دهید. |
uri |
URI نقطه ورودی. حداکثر طول ۱۳۰۰ نویسه است. قالببندی به نوع نقطه ورودی بستگی دارد:
|
regionCode |
کد منطقه شماره تلفن. اگر URI کد کشور نداشته باشد، کاربران به آن نیاز دارند. مقادیر براساس فهرست عمومی CLDR از کدهای منطقه است. |
entryPointFeatures[] |
ویژگیهای نقطه ورودی. درحالحاضر این ویژگیها فقط برای نقاط ورودی تلفن اعمال میشود:
|
پارامترها
| نمایش JSON |
|---|
{
"addOnParameters": {
object ( |
| فیلدها | |
|---|---|
addOnParameters |
نقشهای از کلیدها و مقادیر رشته پارامتر. این کلیدها و مقادیر توسط توسعهدهنده برافزا تعریف شدهاند تا اطلاعات را برای استفاده برافزا به کنفرانس خاصی پیوست کنند. |
AddOnParameters
| نمایش JSON |
|---|
{ "parameters": { string: string, ... } } |
| فیلدها | |
|---|---|
parameters |
شیئی که حاوی فهرستی از جفتهای |
قابلیتها
| نمایش JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| فیلدها | |
|---|---|
canSeeAttendees |
دادههای تولیدشده توسط کاربر. اگر برافزا بتواند فهرست شرکتکنندگان رویداد را بخواند، true است؛ درغیراینصورت، false است. |
canAddAttendees |
دادههای تولیدشده توسط کاربر. اگر برافزا بتواند شرکتکنندگان جدیدی به فهرست شرکتکنندگان رویداد اضافه کند، true و درغیراینصورت false است. |
canSeeConferenceData |
دادههای تولیدشده توسط کاربر. true اگر برافزا بتواند دادههای کنفرانس رویداد را بخواند؛ درغیراینصورت false. |
canSetConferenceData |
دادههای تولیدشده توسط کاربر. اگر برافزا بتواند دادههای کنفرانس رویداد را بهروز کند، true است؛ درغیراینصورت false است. |
canAddAttachments |
دادههای تولیدشده توسط کاربر. اگر برافزا بتواند پیوستهای جدیدی به رویداد اضافه کند، true است؛ درغیراینصورت false است. |
DriveEventObject
شیء رویداد Drive بخشی از شیء رویداد کلی است که اطلاعاتی درباره Google Drive کاربر و محتوای آن دارد. این فیلد فقط درصورتی در شیء رویداد وجود دارد که برنامه میزبان Google Drive باشد.
| نمایش JSON |
|---|
{ "selectedItems": [ { object ( |
| فیلدها | |
|---|---|
selectedItems[] |
فهرستی از موارد (فایلها یا پوشهها) انتخابشده در Drive. |
activeCursorItem |
مورد Drive که درحالحاضر فعال است. |
DriveItemMetadata
اشیاء مورد Drive حاوی اطلاعاتی درباره موارد خاص Drive، مثل فایلها یا پوشهها، هستند.
| نمایش JSON |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| فیلدها | |
|---|---|
id |
شناسه مورد انتخابشده. |
iconUrl |
نشانی وب نمادی که نشاندهنده مورد انتخابشده است. |
mimeType |
نوع MIME مورد انتخابشده. |
title |
عنوان مورد انتخابشده. |
addonHasFileScopePermission |
اگر true باشد، برافزا برای این مورد درخواست مجوز حوزه https://www.googleapis.com/auth/drive.file کرده و آن را دریافت کرده است. درغیراینصورت، این فیلد نادرست است. اگر برافزا از حوزه مجازتری مثل https://www.googleapis.com/auth/drive یا https://www.googleapis.com/auth/drive.readonly استفاده کند، این فیلد مرتبط نیست. هنگام طراحی برافزاها، همیشه از کمترین دامنههای مجاز ممکن استفاده کنید تا از اطلاعات کاربر محافظت شود. |
GmailEventObject
شیء رویداد Gmail بخشی از شیء رویداد کلی است که اطلاعات مربوط به پیامهای Gmail کاربر را حمل میکند. این ویژگی فقط درصورتی در شیء رویداد وجود دارد که برنامه میزبان Gmail باشد.
| نمایش JSON |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| فیلدها | |
|---|---|
messageId |
شناسه پیام Gmail که درحالحاضر باز است. |
threadId |
شناسه رشته Gmail که درحالحاضر باز است. |
accessToken |
کد دسترسی مختص Gmail. میتوانید از این کد با روش |
toRecipients[] |
بهطور پیشفرض غیرفعال است. فهرست نشانیهای ایمیل گیرنده «به:» که درحالحاضر در پیشنویسی که برافزا درحال نوشتن آن است گنجانده شده است. برای روشن کردن این فیلد، باید فیلد |
ccRecipients[] |
بهطور پیشفرض غیرفعال است. فهرست نشانیهای ایمیل گیرنده «رونوشت:» که درحالحاضر در پیشنویسی که برافزا درحال نوشتن آن است گنجانده شده است. برای روشن کردن این فیلد، باید فیلد |
bccRecipients[] |
بهطور پیشفرض غیرفعال است. فهرست نشانیهای ایمیل گیرنده «رونوشت مخفی:» که درحالحاضر در پیشنویسی که برافزا درحال نوشتن آن است گنجانده شده است. برای روشن کردن این فیلد، باید فیلد |
SheetsEventObject
شیء رویداد «کاربرگنگار» بخشی از شیء رویداد کلی است که اطلاعات مربوط به سند کاربر و محتوای آن را حمل میکند. فقط درصورتی در شیء رویداد وجود دارد که برافزا «کاربرگنگار Google» را گسترش دهد.
| نمایش JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| فیلدها | |
|---|---|
id |
فقط درصورتی وجود دارد که دامنه |
title |
فقط درصورتی وجود دارد که دامنه |
addonHasFileScopePermission |
اگر |
matchedUrl |
فقط درصورت برآورده شدن شرایط زیر وجود دارد:
نشانی وب پیوندی که پیشنمایش را در «کاربرگنگار Google» تولید میکند. برای استفاده از این فیلد، باید نمونه بار داده برای زمانی که کاربر پیوند |
MatchedUrl
شیء رویداد با درخواستهای پیشنمایش پیوند برگردانده شد.
| نمایش JSON |
|---|
{ "url": string } |
| فیلدها | |
|---|---|
url |
نشانی وبی که مطابقت داده شد. |
SlidesEventObject
شیء رویداد «اسلایدنگار» بخشی از شیء رویداد کلی است که اطلاعات مربوط به سند کاربر و محتوای آن را حمل میکند. این ویژگی فقط درصورتی در شیء رویداد وجود دارد که برافزا «اسلایدنگار Google» را گسترش دهد.
| نمایش JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| فیلدها | |
|---|---|
id |
فقط درصورتی وجود دارد که دامنه |
title |
فقط درصورتی وجود دارد که دامنه |
addonHasFileScopePermission |
اگر |
matchedUrl |
فقط درصورت برآورده شدن شرایط زیر وجود دارد:
نشانی وب پیوندی که پیشنمایش را در «اسلایدنگار Google» تولید میکند. برای استفاده از این فیلد، باید نمونه بار داده برای زمانی که کاربر پیوند |
DocsEventObject
شیء رویداد «سندنگار» بخشی از شیء رویداد کلی است که اطلاعات مربوط به سند کاربر و محتوای آن را حمل میکند. فقط درصورتی در شیء رویداد وجود دارد که برافزا «سندنگار Google» را گسترش دهد.
| نمایش JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| فیلدها | |
|---|---|
id |
فقط درصورتی وجود دارد که دامنه |
title |
فقط درصورتی وجود دارد که دامنه |
addonHasFileScopePermission |
اگر |
matchedUrl |
فقط درصورت برآورده شدن شرایط زیر وجود دارد:
نشانی وب پیوندی که پیشنمایش را در «سندنگار Google» تولید میکند. برای استفاده از این فیلد، باید نمونه بار داده برای زمانی که کاربر پیوند |
ChatEventObject
بار داده شیء رویداد برنامه Google Chat که از سرور Google به برافزاها ارسال شده است. از بار داده میتوان برای شناسایی نوع رویداد استفاده کرد.
| نمایش JSON |
|---|
{ "type": enum ( |
| فیلدها | |
|---|---|
type |
نوع رویداد، فقط برای رویدادهای «صفحه اصلی برنامه» در برنامههای Chat که برافزا نیستند درج میشود. |
user |
کاربری که با برنامه Chat تعامل دارد. |
space |
فضایی که رویداد در آن رخ داده است، فقط برای رویدادهای «صفحه اصلی برنامه» در برنامههای Chat که برافزا نیستند درج میشود. |
eventTime |
مُهر زمان نشاندهنده زمان وقوع شیء رویداد. از RFC 3339 استفاده میکند، که در آن برونداد تولیدشده همیشه Z-نرمالسازی میشود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: |
| پایهبار شیء رویداد. بار دادهها به نوع شیء رویداد بستگی دارد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
messagePayload |
کاربری پیامی به برنامه Chat ارسال میکند یا در فضایی از برنامه Chat با @نام میبرد. درعوض، فراخوانیهای فرمان برنامه (مثل فرمانهای خط مورب و فرمانهای سریع) در |
addedToSpacePayload |
کاربری برنامه Chat را به فضای Chat اضافه میکند، یا سرپرست Google Workspace برنامه Chat را در فضاهای پیام مستقیم برای کاربران سازمانش نصب میکند. |
removedFromSpacePayload |
کاربری برنامه Chat را از فضا بردارد. |
buttonClickedPayload |
نشاندهنده دادههای بار مفید است وقتی کاربر با عنصر تعاملی کارت یا چارگوش گفتگویی تعامل میکند که فراخوان بازگشت اگر کاربری با کادر گفتگویی تعامل داشته باشد، فیلد بار داده کامل شامل |
widgetUpdatedPayload |
کاربر ابزارهای را در کارت جاری یا در کادر گفتگویی بهروز میکند. بار مفید کامل شامل |
appCommandPayload |
کاربر فرمان برنامه را فراخوانی میکند. |
systemCommandPayload |
کاربری فرمان سیستم را فراخوانی میکند. |
| پایان فیلدهای متقابلاً انحصاری. | |
EventType
نوع رویداد، فقط برای رویدادهای «صفحه اصلی برنامه» در برنامههای Chat که برافزا نیستند درج میشود.
| شمارشیها | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
مقدار پیشفرض برای enum. استفاده نشود. |
APP_HOME |
کاربری پیام مستقیمی را از برنامه Chat که از صفحه اصلی برنامه استفاده میکند باز میکند. فقط فیلدهای type، user، و space برای رویدادهای این نوع گنجانده شدهاند. برای اطلاعات بیشتر، ساختن صفحه اصلی برای برنامه Google Chat را ببینید. |
SUBMIT_FORM |
کاربر اطلاعاتی را در کارت صفحه اصلی برنامه ارسال میکند. فقط فیلدهای type، user، و space برای رویدادهای این نوع گنجانده شدهاند. برای اطلاعات بیشتر، [ساختن صفحه اصلی برای برنامه Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message) را ببینید. |
MessagePayload
کاربری پیامی به برنامه Chat ارسال میکند یا در فضایی از برنامه Chat با @نام میبرد. فراخوانیهای فرمان برنامه (مانند فرمانهای خط مورب و فرمانهای سریع) بهجای آن از AppCommandPayload استفاده میکنند.
| نمایش JSON |
|---|
{ "space": { object ( |
| فیلدها | |
|---|---|
space |
الزامی. فضای Chat که شیء رویداد در آن رخ میدهد. |
message |
پیامی که شیء رویداد را راهاندازی میکند. |
configCompleteRedirectUri |
اختیاری. نشانی وبی که برنامه Chat باید کاربر را پساز تکمیل جریان پیکربندی یا مجوزدهی در خارج از Google Chat به آن هدایت کند. برای اطلاعات بیشتر، متصل کردن برنامه Chat به سرویسها و ابزارهای دیگر را ببینید. |
AddedToSpacePayload
کاربری برنامه Chat را به فضایی اضافه میکند، یا پیام مستقیمی بین برنامه و کاربر ایجاد میشود.
| نمایش JSON |
|---|
{
"space": {
object ( |
| فیلدها | |
|---|---|
space |
الزامی. فضای Chat که شیء رویداد در آن رخ میدهد. |
interactionAdd |
آیا برنامه با تعامل کاربر به فضا اضافه شده است (برای مثال، با @ نامبری برنامه Chat یا فراخوانی با فرمان خط مورب). اگر این مقدار روی true تنظیم شود، شیء رویداد جداگانهای مرتبط با خود تعامل وجود خواهد داشت که به برنامه Chat ارسال میشود. |
configCompleteRedirectUri |
اختیاری. نشانی وبی که برنامه Chat باید کاربر را پساز تکمیل جریان پیکربندی یا مجوزدهی در خارج از Google Chat به آن هدایت کند. برای اطلاعات بیشتر، متصل کردن برنامه Chat به سرویسها و ابزارهای دیگر را ببینید. |
RemovedFromSpacePayload
کاربری برنامه Chat را از فضا بردارد.
| نمایش JSON |
|---|
{
"space": {
object ( |
| فیلدها | |
|---|---|
space |
الزامی. فضای Chat که شیء رویداد در آن رخ میدهد. |
ButtonClickedPayload
کاربر با عنصر تعاملی کارت یا کادر گفتگویی از «برافزای Chat» تعامل میکند که باعث راهاندازی فراخوانی برگشتی Action میشود. باوجود نام، این بار داده برای همه فراخوانیهای برگشتی کارت و کادر گفتگوی Action، ازجمله کلیکهای دکمه، راهاندازهای onChangeAction، کنشهای onClick، کلیکهای CardAction، و ارسال یا لغو کادر گفتگو (SUBMIT_DIALOG و CANCEL_DIALOG) پر میشود.
اگر کاربری با کادر گفتگویی تعامل داشته باشد، فیلد isDialogEvent مربوط به ButtonClickedPayload روی true تنظیم میشود و شامل DialogEventType است. این بار داده به انواع رویداد SUBMIT_FORM و CARD_CLICKED برای برنامههای Chat که برافزا نیستند نگاشت میشود.
بار داده کامل شامل CommonEventObject.form_inputs و CommonEventObject.parameters نیز میشود.
| نمایش JSON |
|---|
{ "space": { object ( |
| فیلدها | |
|---|---|
space |
الزامی. فضای Chat که شیء رویداد در آن رخ میدهد. |
message |
پیامی که شیء رویداد را راهاندازی میکند. |
isDialogEvent |
برای اشیاء رویداد |
dialogEventType |
نوع شیء رویداد گفتگو دریافت شد. |
DialogEventType
برای اشیای رویداد که حاوی محمولههای رویداد ButtonClicked یا AppCommand هستند، انواع تعاملات با کادرهای گفتگو.
برای کسب اطلاعات بیشتر درباره اشیای رویداد برنامه Google Chat، به دریافت و پاسخ به تعاملات با برنامه Google Chat مراجعه کنید.
| شمارشیها | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
مقدار پیشفرض. نامشخص. |
REQUEST_DIALOG |
کاربر کادر گفتگویی را باز میکند. |
SUBMIT_DIALOG |
کاربر روی عنصر تعاملی کادر گفتگویی کلیک میکند. برای مثال، کاربر اطلاعاتی را در کادر گفتگویی تکمیل میکند و روی دکمهای کلیک میکند تا اطلاعات را ارسال کند. |
CANCEL_DIALOG |
کاربر کادر گفتگویی را بدون ارسال اطلاعات میبندد، یا کادر گفتگو لغو میشود. |
WidgetUpdatedPayload
کاربر ابزارهای را در کارت یا کادر گفتگوی جاری بهروز میکند.
بار مفید کامل شامل CommonEventObject.parameters['autocomplete_widget_query'] نیز میشود.
| نمایش JSON |
|---|
{
"space": {
object ( |
| فیلدها | |
|---|---|
space |
الزامی. فضای Chat که شیء رویداد در آن رخ میدهد. |
AppCommandPayload
کاربر فرمان برنامه را فراخوانی میکند.
| نمایش JSON |
|---|
{ "appCommandMetadata": { object ( |
| فیلدها | |
|---|---|
appCommandMetadata |
برای فرمانهای برنامه، ازجمله فرمانهای خط مورب و فرمانهای سریع، تکمیل شده است. |
space |
اختیاری. فضای Chat که شیء رویداد در آن رخ میدهد. |
thread |
اختیاری. رشتهای که شیء رویداد در آن رخ میدهد، درصورت وجود. اگر شیء رویداد با پیام یا رشته خاصی مرتبط باشد، این فیلد تکمیل میشود. |
message |
اختیاری. پیامی که شیء رویداد را راهاندازی میکند، درصورت وجود. این فیلد فقط برای فرمانهای خط مورب پر میشود. |
configCompleteRedirectUri |
اختیاری. نشانی وبی که کاربر باید پساز تکمیل جریان پیکربندی یا صدور مجوز در خارج از Google Chat به آن هدایت شود. برای اطلاعات بیشتر، متصل کردن برنامه Chat به سرویسها و ابزارهای دیگر را ببینید. |
isDialogEvent |
اختیاری. آیا کاربر درحال تعامل با کادر گفتگویی است یا میخواهد با آن تعامل داشته باشد. |
dialogEventType |
اختیاری. نوع شیء رویداد گفتگو دریافت شد. این فیلد فقط درصورتی اعمال میشود که |
AppCommandMetadata
فراداده درباره فرمان برنامه Chat.
| نمایش JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| فیلدها | |
|---|---|
appCommandId |
شناسه فرمان مشخصشده در پیکربندی Chat API. |
appCommandType |
نوع فرمان برنامه Chat. |
AppCommandType
نوع فرمان برنامه Chat. برای جزئیات، به انواع فرمانهای برنامه Chat مراجعه کنید.
| شمارشیها | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
مقدار پیشفرض. نامشخص. |
SLASH_COMMAND |
فرمان خط مورب. کاربر فرمان را در پیام Chat ارسال میکند. |
QUICK_COMMAND |
فرمان سریع. کاربر فرمان را از منو Chat در قسمت پاسخ پیام انتخاب میکند. |
MESSAGE_ACTION |
کنش پیام. کاربر فرمان را از منوِ بافت پیام در Chat انتخاب میکند. |
SystemCommandPayload
کاربری فرمان سیستم را فراخوانی میکند.
| نمایش JSON |
|---|
{ "systemCommandMetadata": { object ( |
| فیلدها | |
|---|---|
systemCommandMetadata |
فراداده مربوط به فرمان سیستم که فراخوانی شده است. |
space |
اختیاری. فضای Chat که شیء رویداد در آن رخ میدهد. |
thread |
اختیاری. رشتهای که شیء رویداد در آن رخ میدهد، درصورت وجود. اگر شیء رویداد با پیام یا رشته خاصی مرتبط باشد، این فیلد تکمیل میشود. |
SystemCommandMetadata
فراداده مربوط به فرمان سیستم که توسط کاربر راهاندازی شده است.
| نمایش JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| فیلدها | |
|---|---|
| فرمان سیستم فراخوانده شد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
cancelStream |
فرمان لغو پیام جاریسازی فعال. |
| پایان فیلدهای متقابلاً انحصاری. | |
CancelStream
فرمان لغو پیام جاریسازی فعال.
| نمایش JSON |
|---|
{ "streamMessage": string } |
| فیلدها | |
|---|---|
streamMessage |
الزامی. نام منبع پیام جاریسازی که فرمان لغو روی آن اجرا شده است. قالب: |
WorkflowEventObject
LINT.IfChange شیء رویداد به برافزاهای «گردش کار» منتقل شد.
| نمایش JSON |
|---|
{ "executionMetadata": { object ( |
| فیلدها | |
|---|---|
executionMetadata |
فراداده مربوط به اجرای گردش کار. |
triggerEventSource |
منبع رویدادهای راهانداز. |
| نوع بار داده رویداد گردش کار. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
actionInvocation |
فراخوانی کنش گردش کار. |
triggerCreation |
ایجاد راهانداز گردش کار. |
triggerDeletion |
حذف راهانداز گردش کار. |
resourceRetrieval |
بازیابی منبع (برای تورم متغیر استفاده میشود). |
elementConfiguration |
پیکربندی عنصر گردش کار. |
resourceFieldsDefinitionRetrieval |
بازیابی تعریف فیلد پشتیبانیشده توسط منبع. |
elementUiAutocomplete |
پیشنهادهای تکمیل خودکار برای کارت ارائهشده فعلی. |
| پایان فیلدهای متقابلاً انحصاری. | |
ActionInvocation
فراخوانی کنش گردش کار.
| نمایش JSON |
|---|
{ "inputs": { string: { object ( |
| فیلدها | |
|---|---|
inputs |
نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است. شیئی که حاوی فهرستی از جفتهای |
triggerId |
شناسه راهانداز برای استفاده در پاسخهای کنش ناهمگام. |
flowLevelContext |
اختیاری. بافت سطح جریان از مراحل قبلی. |
VariableData
نشاندهنده دادههای متغیر است که میتواند چندین مقدار از انواع مختلف را در خود نگه دارد.
| نمایش JSON |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| فیلدها | |
|---|---|
booleanValues[] |
مقادیر بولی. |
integerValues[] |
مقادیر صحیح. |
floatValues[] |
مقادیر شناور. |
stringValues[] |
مقادیر رشتهای. |
timestampValues[] |
مقادیر مُهر زمان. از RFC 3339 استفاده میکند، که در آن برونداد تولیدشده همیشه Z-نرمالسازی میشود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: |
resourceReferences[] |
مرجعهای منبع (شناسهها). |
emailAddressValues[] |
مقادیر نشانی ایمیل. |
googleUserValues[] |
مقادیر کاربر Google در قالب |
textFormatValues[] |
مقادیر قالب نوشتار گردش کار. |
ResourceReference
مقدار شناسه منبع خاص برنامه.
| نمایش JSON |
|---|
{
"resourceType": {
object ( |
| فیلدها | |
|---|---|
resourceType |
نوع منبعی که این شناسه به آن اشاره میکند. |
resourceId |
شناسه منبع. |
ResourceType
نام نوع منبع سفارشی.
| نمایش JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| فیلدها | |
|---|---|
workflowBundleId |
شناسه بسته گردش کار که مالک این نوع منبع است. این مورد اختیاری است و اگر خالی باشد، همان دستهای درنظر گرفته میشود که در آن استفاده میشود. |
workflowResourceDefinitionId |
شناسه یکتای منبع. این فقط باید در همان بسته منحصربهفرد باشد. |
WorkflowTextFormat
بلوکی از نوشتار با گزینههای قالببندی غنی شامل سبکها، پیوندها، و عناصر تعاملی.
| نمایش JSON |
|---|
{
"textFormatElements": [
{
object ( |
| فیلدها | |
|---|---|
textFormatElements[] |
مجموعهای از عناصر قالب نوشتار. |
TextFormatElement
عنصری تکی در پیام WorkflowTextFormat که میتواند تراشه، نوشتار سبکدار، اَبَرپیوند، یا ظرف فهرست باشد.
| نمایش JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "chip": { object ( |
| فیلدها | |
|---|---|
| عنصری که نشاندهنده یکی از چندین عنصر قالب نوشتار ممکن است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
text |
نوشتار در قالب نوشتاری. |
chip |
تراشه کلیککردنی در قالب نوشتار. |
styledText |
نوشتار سبکدار در قالب نوشتار. |
hyperlink |
اَبَرپیوند در قالب نوشتاری. |
listContainer |
محتوی فهرست در قالب نوشتار. |
| پایان فیلدهای متقابلاً انحصاری. | |
تراشه
تراشه کلیککردنی در قالب نوشتار.
| نمایش JSON |
|---|
{
"icon": {
object ( |
| فیلدها | |
|---|---|
icon |
نمادی که در تراشه نمایش داده میشود. |
label |
نوشتاری که در تراشه نمایش داده میشود. |
url |
نشانی وب برای پیمایش به آن وقتی روی تراشه کلیک میشود. |
نماد
نمادی در تراشه.
| نمایش JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "iconUrl": string, "materialIconName": string // End of mutually exclusive fields. } |
| فیلدها | |
|---|---|
| نمادی که در تراشه نمایش داده میشود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
iconUrl |
نماد سفارشی میزبانیشده در نشانی وب HTTPS را نمایش میدهد. برای مثال: انواع فایلهای پشتیبانیشده شامل |
materialIconName |
نام نماد تعریفشده در نماد Google Material، برای مثال، |
| پایان فیلدهای متقابلاً انحصاری. | |
StyledText
عنصر نوشتاری با سبکهایی مثل پررنگ، ایتالیک، و رنگ.
| نمایش JSON |
|---|
{ "text": string, "styles": [ enum ( |
| فیلدها | |
|---|---|
text |
محتوای اصلی نوشتار. |
styles[] |
مجموعهای از سبکها که بر نوشتار اعمال شده است. |
fontWeight |
سیاهی قلم نوشتار. |
color |
رنگ نوشتار. |
wrapStyle |
سبک دورتادور نوشتار. |
سبک
Enum برای سبکهای مختلف نوشتار مانند ایتالیک، زیرخط، و غیره.
| شمارشیها | |
|---|---|
STYLE_UNSPECIFIED |
سبکی اعمال نشده است. استفاده نشود. |
ITALIC |
سبک ایتالیک. |
UNDERLINE |
سبک زیرخط. |
STRIKETHROUGH |
سبک خطخورده. |
LINE_BREAK |
شکست خط. |
UPPERCASE |
سبک حروف بزرگ. |
CODE |
کد. |
CODE_BLOCK |
بلوک کد. |
FontWeight
Enum برای سیاهیهای مختلف قلم.
| شمارشیها | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
وزن استاندارد با ضخامت معمولی. استفاده نشود. |
LIGHT |
وزن سبکتر با ضخامت کمتر. |
MEDIUM |
وزن متوسط بین روشن و پررنگ. |
BOLD |
وزن سنگینتر با ضخامت بیشتر. |
WrapStyle
Enum برای سبکهای مختلف پیچیدن.
| شمارشیها | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
سبک پیچیدن مشخص نشده است. |
NO_WRAP |
بدون سبک دورتادور. |
Hyperlink
عنصر اَبَرپیوند با نوشتار و پیوند.
| نمایش JSON |
|---|
{ "link": string, "text": string } |
| فیلدها | |
|---|---|
link |
نشانی وب مقصد اَبَرپیوند. |
text |
نوشتار اَبَرپیوند. |
ListContainer
محفظه برای موارد فهرست، که هر مورد فهرست میتواند حاوی چندین TextFormatElement باشد.
| نمایش JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| فیلدها | |
|---|---|
listNestLevel |
سطح درونی فهرست. از ۰ برای سطح بالا شروع میشود و برای هر فهرست تودرتو ۱ عدد افزایش مییابد. |
listType |
نوع فهرست. |
listItems[] |
مجموعهای از موارد فهرست. |
ListType
Enum برای انواع مختلف فهرست.
| شمارشیها | |
|---|---|
LIST_TYPE_UNSPECIFIED |
نوع فهرست مشخص نشده است. استفاده نشود. |
ORDERED |
فهرست مرتبشده. |
UNORDERED |
فهرست مرتبنشده. |
BLOCKQUOTE |
نشاندهنده فهرست نقلقول است. |
ListItem
مورد فهرست.
| نمایش JSON |
|---|
{
"textFormatElements": [
{
object ( |
| فیلدها | |
|---|---|
textFormatElements[] |
مجموعهای از عناصر قالب نوشتار. |
FlowLevelContext
بافت سطح جریان کار حاوی خروجیهای مراحل قبلی.
| نمایش JSON |
|---|
{
"stepContexts": [
{
object ( |
| فیلدها | |
|---|---|
stepContexts[] |
اختیاری. فهرست مراحل قبلی. ترتیب مهم است، بنابراین مطمئن شوید که ترتیب اجرا در این فهرست حفظ شود. |
StepContext
فرادادههای بافت مرحله و خروجیها برای بافت سطح جریان.
| نمایش JSON |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| فیلدها | |
|---|---|
stepId |
اختیاری. شناسه یکتای مرحله در نمودار گردش کار. |
outputs |
اختیاری. نقشه متغیرهای برونداد تولیدشده توسط این مرحله، که با نام متغیر کلیدگذاری شده است. شیئی که حاوی فهرستی از جفتهای |
TriggerCreation
ایجاد راهانداز گردش کار.
| نمایش JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| فیلدها | |
|---|---|
triggerId |
شناسه یکتای راهانداز ارائهشده درطول ایجاد. |
triggerType |
نوع راهانداز. |
inputs |
نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است. شیئی که حاوی فهرستی از جفتهای |
notifyUri |
نقطه پایانی که هنگام فعال شدن راهانداز فراخوانی میشود. |
TriggerType
نوع راهانداز.
| شمارشیها | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
مقدار پیشفرض. استفاده نشود. |
REPEATING |
هر بار که شرایط ورودی برآورده شود، راهانداز فعال میشود. |
TriggerDeletion
حذف راهانداز گردش کار.
| نمایش JSON |
|---|
{ "triggerId": string } |
| فیلدها | |
|---|---|
triggerId |
شناسه یکتای راهانداز ارائهشده درطول ایجاد. |
ResourceRetrieval
بازیابی منبع.
| نمایش JSON |
|---|
{
"resourceReference": {
object ( |
| فیلدها | |
|---|---|
resourceReference |
نوع و شناسه منبعی که باید بازیابی شود. |
ElementConfiguration
فراخوانی هنگام پیکربندی عنصر گردش کار.
| نمایش JSON |
|---|
{ "inputs": { string: { object ( |
| فیلدها | |
|---|---|
inputs |
نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است. این نقشه ممکن است خالی باشد. Used when configuring single workflow element (trigger or action) in workflow home. شیئی که حاوی فهرستی از جفتهای |
displayDestination |
مقصد کارت پیکربندی عنصر. عناصر میتوانند از این فیلد برای برگرداندن طرحبندیهای مختلف کارت پیکربندی براساس مقصد استفاده کنند. |
nodeId |
شناسه گره پیکربندی اصلی که درحال ارائه است. |
workflowId |
شناسه گردش کار پیکربندی اولیه که درحال رندر شدن است. |
availableVariables[] |
متغیرهای دردسترس براساس موقعیت گره مرتب شدهاند. |
DisplayDestination
نشان میدهد کارت پیکربندی عنصر برگشتی کجا نمایش داده خواهد شد.
| شمارشیها | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
مقدار پیشفرض. استفاده نشود. |
DISPLAY_DESTINATION_SIDE_PANEL |
کارت پیکربندی قرار است در «پانل کناری» نمایش داده شود. |
DISPLAY_DESTINATION_FULL_SCREEN |
کارت پیکربندی باید در برنامه «تمامصفحه» نمایش داده شود. |
VariableReference
مرجع متغیر به متغیری در گردش کار.
| نمایش JSON |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| فیلدها | |
|---|---|
parentElementId |
شناسه اصلی عنصری که متغیر را تولید میکند. درصورت نیاز میتوانیم این را به WorkflowElement یا فراداده دقیقتر proto گسترش دهیم. |
nodeId |
شناسه مرجع گره |
path |
امضای مسیر گزینشگر متغیر |
dataType |
نوع داده متغیر |
iconUrl |
نشانی وب نماد اولیه که این متغیر را تولید میکند. |
stepNumber |
شماره مرحله از دستور اولیهای که این متغیر را تولید میکند. |
descriptionText |
شرح متغیر. |
displayText |
نوشتار نمایشی تراشه متغیر. |
DataType
نوع متغیر.
| نمایش JSON |
|---|
{ "valueMetadata": { object ( |
| فیلدها | |
|---|---|
valueMetadata |
فراداده درباره مقادیر بالقوه متغیر. |
| نوع داده. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
basicType |
نوع داده پایه. |
resourceType |
نوع شناسه منبع برنامه. |
| پایان فیلدهای متقابلاً انحصاری. | |
BasicType
انواع دادههای عمومی پایه.
| شمارشیها | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
مقدار پیشفرض. استفاده نشود. |
STRING |
رشتهای از نویسهها. |
INTEGER |
عدد صحیح. |
FLOAT |
عدد ممیز شناور. |
TIMESTAMP |
مُهر زمان در قالب ISO 8601. |
BOOLEAN |
مقداری که میتواند درست یا نادرست باشد. |
EMAIL_ADDRESS |
نشانی ایمیل، که رشتهای در قالب نشانی ایمیل است. |
GOOGLE_USER |
کاربر سرویسهای Google، در قالب users/{user}. |
FILE |
مرجع فایل. |
FORMATTED_TEXT |
نوشتار با قالببندی غنی. |
ValueMetadata
اطلاعاتی درباره مقادیر بالقوه متغیر.
| نمایش JSON |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| فیلدها | |
|---|---|
enumValues[] |
اختیاری. مقادیر مجاز برای رشته را مشخص میکند. این مورد فقط درصورتی تنظیم میشود که |
dynamicTypes[] |
اختیاری. انواع مجاز را که میتوانند بهطور پویا برای متغیر قالببندی شوند مشخص میکند. این مورد فقط زمانی میتواند تنظیم شود که DataType (نوع داده) از نوع String (رشته) باشد و متغیر از نوع برونداد باشد. |
semanticDescriptors[] |
اختیاری. به توصیف معنای معنایی متغیر کمک میکند. |
dynamicSchema |
اختیاری. پیکربندی برای حل پویای طرحواره این متغیر. |
defaultValue |
اختیاری. رشتهای که مقدار پیشفرض را برای این متغیر مشخص میکند. برای مثال، برای مقادیر بولی، |
SemanticDescriptor
فراداده درباره معنی معنایی متغیر.
| نمایش JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| فیلدها | |
|---|---|
resourceAttribute |
نشان میدهد که متغیر با مشخصه خاصی از منبع مطابقت دارد. این بهویژه برای متغیرهایی مفید است که نشاندهنده شناسه منبع (شناسه، نشانی وب، کلید، و غیره) هستند. قالب توصیهشده این است: - مثالها: - کارخواه از این اطلاعات استفاده میکند تا به کاربر اشاره کند که کدام متغیرهای خروجی با ورودی خاصی سازگار هستند. |
disallowedResourceAttributes[] |
اختیاری. فقط برای ورودیها قابلاعمال است و برای خروجیها نادیده گرفته میشود. مشخصههای غیرمجازی که با این توصیفگر معنایی مطابقت دارند. کارخواه بهطور صریح از انتخاب متغیر برای خروجیهایی که با هریک از این مشخصههای منبع غیرمجاز مطابقت دارند جلوگیری خواهد کرد. |
DynamicSchema
پیکربندی برای حل پویای طرحواره این متغیر در زمان اجرا.
| نمایش JSON |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| فیلدها | |
|---|---|
requiredInputIds[] |
شناسههای متغیرهای ورودی همرده که باید قبلاز اینکه طرحواره این متغیر بهطور پویا حل شود ارائه شوند. |
strictEnum |
وقتی درست باشد، مقدار متغیر باید با یکی از مقادیر شمارشی حلشده پویا مطابقت داشته باشد. وقتی نادرست باشد، مقادیر حلشده پویا بهعنوان پیشنهادهای غیردقیق درنظر گرفته میشوند. |
ResourceFieldsDefinitionRetrieval
تعریف فیلدهای پشتیبانیشده توسط منبع را بازیابی میکند.
| نمایش JSON |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| فیلدها | |
|---|---|
elementId |
شناسه عنصری را که طرحواره منبع پویای آن باید واکشی شود مشخص میکند. |
inputs |
این شامل ورودیهای فیلد گرهای است که متغیر را ارائه میدهد. نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است. شیئی که حاوی فهرستی از جفتهای |
ElementUiAutocomplete
پیشنهادهای تکمیل خودکار برای کارت ارائهشده فعلی.
| نمایش JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| فیلدها | |
|---|---|
query |
پرسمان برای تکمیل خودکار. |
inputs |
نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است. شیئی که حاوی فهرستی از جفتهای |
invokedFunction |
تابع فراخواندهشده مرتبط با ابزاره. |
resourceId |
شناسه منبعی که باید برای آن تکمیل خودکار انجام شود. این فیلد اختیاری است و ممکن است تنظیم نشده باشد. |
operationId |
شناسه عملیاتی که منبع را برای تکمیل خودکار ارائه کرده است. این فیلد اختیاری است و ممکن است تنظیم نشده باشد. |
ExecutionMetadata
فراداده مربوط به اجرای گردش کار.
| نمایش JSON |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| فیلدها | |
|---|---|
versionId |
نسخه عنصر گردش کار که فراخوانی میشود. |
timeZone |
منطقه زمانی گردش کاری که ذخیره میشود. برای نمونه، «America/Los_Angeles». |
stepNumber |
نشاندهنده شماره مرحله دستور اولیهای است که فراخوانی میشود. |
TriggerEventSource
منبع رویداد راهاندازی که این اجرا را راهاندازی کرده است.
| شمارشیها | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
مقدار پیشفرض. استفاده نشود. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
اجرا بهطور خودکار توسط رویدادها راهاندازی میشود. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
اجرا ازطریق اجرای آزمایشی راهاندازی میشود. |