EventObject

EventObject

رویداد تعامل برافزای Google که حاوی داده‌هایی درباره تعامل کاربر با برافزا در برنامه میزبان است.

وقتی کاربر با برافزایی در برنامه میزبان تعامل برقرار می‌کند، شیء رویداد به‌صورت JSON به تابع بازخوانی یا راه‌انداز برافزا (برای AppsScript)، یا https نقطه پایانی (برای HTTP) ارسال می‌شود. شیء رویداد یک شیء رویداد برنامه میزبان را که توسط هر برنامه میزبان تعریف شده است، و همچنین یک شیء رویداد مشترک را که حاوی برخی فیلدهای مشترک مرتبط با رویداد است ذخیره می‌کند.

برای اطلاعات بیشتر، اشیاء رویداد را ببینید.

نمایش JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
فیلدها
commonEventObject

object (CommonEventObject)

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

authorizationEventObject

object (AuthorizationEventObject)

فقط برای درخواست‌های ارسال‌شده به نقاط پایانی HTTP تنظیم شده است

در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
calendar

object (CalendarEventObject)

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

drive

object (DriveEventObject)

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

gmail

object (GmailEventObject)

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

sheets

object (SheetsEventObject)

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

slides

object (SlidesEventObject)

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

docs

object (DocsEventObject)

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

chat

object (ChatEventObject)

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

workflow

object (WorkflowEventObject)

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

پایان فیلدهای متقابلاً انحصاری.

CommonEventObject

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

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

برای برنامه‌های Chat، نام تابعی که کاربر هنگام تعامل با ابزاره فراخوانی کرده است.

نمایش JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
فیلدها
userLocale

string

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

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

hostApp

enum (HostApp)

نشان‌دهنده برنامه میزبانی است که برافزا در آن فعال است، زمانی که شیء رویداد تولید می‌شود. مقادیر ممکن شامل موارد زیر است:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

شمارش پلاتفرم که پلاتفرمی را که رویداد از آن نشئت می‌گیرد نشان می‌دهد (WEB، IOS، یا ANDROID). توسط برنامه‌های Chat پشتیبانی نمی‌شود.

timeZone

object (TimeZone)

به‌طور پیش‌فرض غیرفعال است. شناسه منطقه زمانی و فاصله از ساعت هماهنگ جهانی (UTC). برای روشن کردن این فیلد، باید addOns.common.useLocaleFromApp را در مانیفست برافزایتان روی true تنظیم کنید. فهرست دامنه برافزایتان باید شامل https://www.googleapis.com/auth/script.locale نیز باشد. برای جزئیات بیشتر، دسترسی به منطقه زبانی و منطقه زمانی کاربر را ببینید.

فقط برای انواع رویداد CARD_CLICKED و SUBMIT_DIALOG پشتیبانی می‌شود.

formInputs

map (key: string, value: object (Inputs))

نقشه‌ای حاوی مقادیر فعلی ابزارک‌ها در کارت نمایش‌داده‌شده. کلیدهای نقشه مقادیر رشته name هستند که به هر ابزارک ورودی (مانند TextInput.name، SelectionInput.name، DateTimePicker.name، یا DecoratedText.SwitchControl.name) اختصاص داده شده‌اند.

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

توجه: نمونه‌های زیر برای زمان اجرای V8 در Apps Script قالب‌بندی شده‌اند. اگر از Rhino runtime استفاده می‌کنید، باید [""] را بعداز مقدار اضافه کنید. برای مثال، به‌جای e.commonEventObject.formInputs.employeeName.stringInputs.value[0]، شیء رویداد را به‌صورت e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] قالب‌بندی کنید. برای کسب اطلاعات بیشتر درباره زمان‌های اجرا در Apps Script، به نمای کلی زمان اجرا V8 مراجعه کنید.

  • ابزارهایی با مقدار واحد (برای مثال، ابزارک TextInput، یا ابزارک SelectionInput از نوع DROPDOWN یا RADIO_BUTTON): شیء StringInputs حاوی فهرست تک‌عنصری (یا فهرست خالی اگر انتخابی انجام نشده باشد).

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

  • ابزارک‌های چندمقداری (برای مثال، ابزارک SelectionInput از نوع CHECK_BOX، SWITCH، یا MULTI_SELECT): شیء StringInputs حاوی فهرست رشته‌های value مورد انتخاب‌شده.

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

  • ابزاره DecoratedText.SwitchControl: شیء StringInputs. وقتی selected true است، stringInputs.value حاوی فیلد value کلید است (یا "" اگر value مشخص نشده باشد؛ اگر چند کلید name یکسانی داشته باشند، value هر کلید انتخاب‌شده در فهرست گنجانده می‌شود). وقتی selected false است، value کلید از stringInputs.value حذف می‌شود.

  • انتخابگر تاریخ-زمان (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

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

  • انتخابگر فقط تاریخ (DateTimePickerType.DATE_ONLY): DateInput object.

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

  • انتخابگر فقط زمان (DateTimePickerType.TIME_ONLY): TimeInput object.

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

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

هر پارامتر دیگری که بااستفاده از actionParameters یا Action.setParameters() برای کنش ارائه می‌کنید.

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

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

نام تابع برای فراخوانی.

این فیلد برای «برافزاهای Google Workspace» که Google Chat را گسترش می‌دهند درج نمی‌شود. درعوض، برای دریافت داده‌های عملکردی مانند شناسه‌ها، برافزاهایی که Chat را گسترش می‌دهند باید از فیلد parameters استفاده کنند. ساختن میاناهای تعاملی برای برنامه‌های 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

string

کد پایگاه داده منطقه زمانی IANA TZ، مانند «America/Toronto».

offset

integer

فاصله زمانی منطقه زمانی کاربر، برحسب میلی‌ثانیه، از «ساعت هماهنگ جهانی» (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": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
فیلدها
در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
stringInputs

object (StringInputs)

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

اگر ابزارک فقط یک مقدار را بپذیرد، مثل ابزارک TextInput، فهرست حاوی یک شیء رشته‌ای است. اگر ابزاره چندین مقدار را بپذیرد، مثل ابزاره SelectionInput چارگوش‌های انتخاب، فهرست حاوی یک شیء رشته‌ای برای هر مقداری است که کاربر وارد یا انتخاب می‌کند.

dateTimeInput

object (DateTimeInput)

مقادیر ورودی تاریخ و زمان از ابزاره DateTimePicker که هم تاریخ و هم زمان را می‌پذیرد.

dateInput

object (DateInput)

مقادیر ورودی تاریخ از ابزاره DateTimePicker که فقط مقادیر تاریخ را می‌پذیرد.

timeInput

object (TimeInput)

مقادیر ورودی زمان از ابزاره DateTimePicker که فقط مقادیر زمان را می‌پذیرد.

پایان فیلدهای متقابلاً انحصاری.

StringInputs

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

نمایش JSON
{
  "value": [
    string
  ]
}
فیلدها
value[]

string

فهرستی از رشته‌های واردشده توسط کاربر.

DateTimeInput

مقادیر ورودی تاریخ و زمان.

نمایش JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
فیلدها
msSinceEpoch

string (int64 format)

زمان سپری‌شده از تاریخ، برحسب میلی‌ثانیه.

hasDate

boolean

اینکه ورودی datetime شامل تاریخ تقویم باشد یا نه.

hasTime

boolean

آیا ورودی datetime شامل مُهر زمان است.

DateInput

مقادیر ورودی تاریخ.

نمایش JSON
{
  "msSinceEpoch": string
}
فیلدها
msSinceEpoch

string (int64 format)

زمان سپری‌شده از تاریخ، برحسب میلی‌ثانیه.

TimeInput

مقادیر ورودی زمان.

نمایش JSON
{
  "hours": integer,
  "minutes": integer
}
فیلدها
hours

integer

ساعت در قالب ۲۴ ساعته.

minutes

integer

تعداد دقیقه‌های گذشته از ساعت. مقادیر معتبر ۰ تا ۵۹ است.

AuthorizationEventObject

اطلاعات مجوز را برای درخواست برافزا کپسوله‌سازی می‌کند

نمایش JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
فیلدها
userOAuthToken

string

کد دسترسی OAuth کاربر نهایی، با دامنه‌های درخواستی مجاز شده است. (پس‌از جداسازی موافقت oAuth، این مورد با دامنه‌های مجاز کاربر نهایی مجاز خواهد شد)

userIdToken

string

یک شناسه کاربر نهایی، اگر گستره‌های شناسه مناسب درخواست شده باشد

systemIdToken

string

یک شناسه برای حساب سرویس «برافزاهای G Suite» برای این استقرار

authorizedScopes[]

string

فهرست دامنه‌های OAuth که کاربر مجاز کرده است.

CalendarEventObject

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

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

نمایش JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
فیلدها
id

string

شناسه رویداد.

recurringEventId

string

شناسه رویداد تکرارشونده.

calendarId

string

شناسه تقویم.

organizer

object (Organizer)

شیئی که نشان‌دهنده سازمان‌دهنده رویداد است.

attendees[]

object (Attendee)

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

conferenceData

object (ConferenceData)

داده‌های تولیدشده توسط کاربر. شیئی که نشان‌دهنده هرگونه داده کنفرانس مرتبط با این رویداد است، مانند جزئیات کنفرانس Google Meet.

capabilities

object (Capabilities)

داده‌های تولیدشده توسط کاربر. شیئی که قابلیت‌های برافزا را برای مشاهده یا به‌روزرسانی اطلاعات رویداد توصیف می‌کند.

سازمان‌دهنده

نمایش JSON
{
  "email": string
}
فیلدها
email

string

نشانی ایمیل سازمان‌دهنده رویداد.

شرکت‌کننده

اشیاء شرکت‌کننده اطلاعاتی درباره شرکت‌کنندگان فردی در رویدادهای «تقویم 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

string

نشانی ایمیل شرکت‌کننده.

displayName

string

نام نمایشی شرکت‌کننده.

organizer

boolean

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

self

boolean

درست اگر این شرکت‌کننده نشان‌دهنده تقویمی باشد که این رویداد در آن نمایش داده می‌شود؛ درغیراین‌صورت نادرست.

resource

boolean

true اگر شرکت‌کننده نماینده منبعی مثل اتاق یا قطعه‌ای از تجهیزات باشد؛ درغیراین‌صورت false.

optional

boolean

اگر حضور این شرکت‌کننده به‌عنوان اختیاری علامت‌گذاری شده باشد، درست است؛ درغیراین‌صورت نادرست است.

responseStatus

string

وضعیت پاسخ شرکت‌کننده. مقادیر ممکن شامل موارد زیر است:

  • پذیرفته‌شده: شرکت‌کننده دعوت رویداد را پذیرفته است.
  • ردشده: شرکت‌کننده دعوت رویداد را رد کرده است.
  • needsAction: شرکت‌کننده به دعوت رویداد پاسخ نداده است.
  • tentative: شرکت‌کننده دعوت رویداد را با تردید پذیرفته است.
comment

string

نظر پاسخ شرکت‌کننده، درصورت وجود.

additionalGuests

integer

تعداد مهمانان اضافه‌ای که شرکت‌کننده اعلام کرده است با خود می‌آورد. پیش‌فرض صفر است.

ConferenceData

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

نمایش JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
فیلدها
conferenceId

string

شناسه کنفرانس. این شناسه برای این است که برنامه‌ها بتوانند کنفرانس‌ها را پیگیری کنند؛ نباید این شناسه را به کاربران نشان دهید.

conferenceSolution

object (ConferenceSolution)

شیء نشان‌دهنده راهکار کنفرانس، مثل Hangouts یا Google Meet.

entryPoints[]

object (EntryPoint)

فهرست نقاط ورودی کنفرانس، مانند نشانی‌های وب یا شماره تلفن‌ها.

notes

string

یادداشت‌های اضافی (مانند دستورالعمل‌های سرپرست دامنه یا اعلامیه‌های حقوقی) درباره کنفرانس برای نمایش به کاربر. می‌تواند حاوی HTML باشد. حداکثر طول ۲۰۴۸ نویسه است.

parameters

object (Parameters)

شیء حاوی نقشه‌ای از داده‌های پارامتر تعریف‌شده برای استفاده توسط برافزا.

ConferenceSolution

نمایش JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
فیلدها
iconUri

string

URI برای نماد قابل‌مشاهده برای کاربر که نشان‌دهنده این راه‌حل کنفرانس است.

key

object (Key)

کلیدی که راهکار کنفرانس را برای این رویداد به‌طور یکتا شناسایی می‌کند.

name

string

نام قابل‌مشاهده برای کاربر این راه‌حل کنفرانس (بومی‌سازی نشده).

کلید

نمایش JSON
{
  "type": string
}
فیلدها
type

string

نوع راه‌حل کنفرانس. مقادیر ممکن شامل موارد زیر است:

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

string

کد دسترسی استفاده‌شده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فقط فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند مطابقت دهید و نمایش دهید.

entryPointType

string

نوع نقطه ورودی. مقادیر ممکن عبارت‌اند از:

  • بیشتر: دستورالعمل‌های اضافی برای پیوستن به کنفرانس، مانند شماره تلفن‌های جایگزین. کنفرانس فقط می‌تواند یک نقطه ورودی بیشتر داشته باشد؛ اگر وجود داشته باشد، حداقل یک نوع دیگر نقطه ورودی نیز لازم است.
  • تلفن: ازطریق شماره تلفن به کنفرانس بپیوندید. کنفرانس می‌تواند صفر یا چند نقطه ورودی تلفن داشته باشد. «تقویم Google» فقط دو نقطه ورودی تلفن اول را پس‌از قالب‌بندی و مرتب‌سازی براساس حروف الفبا نمایش می‌دهد.
  • sip: پیوستن به کنفرانس ازطریق SIP. هر کنفرانس می‌تواند حداکثر یک نقطه ورودی sip داشته باشد.
  • video: پیوستن به کنفرانس ازطریق HTTP. کنفرانس می‌تواند حداکثر یک نقطه ورودی ویدیویی داشته باشد.
label

string

برچسب قابل‌مشاهده برای کاربر برای URI نقطه ورودی (بومی‌سازی‌نشده).

meetingCode

string

کد جلسه استفاده‌شده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فقط فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند مطابقت دهید و نمایش دهید.

passcode

string

گذرنویسه مورداستفاده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فقط فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند مطابقت دهید و نمایش دهید.

password

string

گذرواژه مورداستفاده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فقط فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند مطابقت دهید و نمایش دهید.

pin

string

پین مورداستفاده برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ نویسه است. ارائه‌دهندگان کنفرانس معمولاً فقط از زیرمجموعه‌ای از {accessCode, meetingCode, passcode, password, pin} برای ارائه دسترسی به کنفرانس‌ها استفاده می‌کنند. فقط فیلدهایی را که ارائه‌دهنده کنفرانس استفاده می‌کند مطابقت دهید و نمایش دهید.

uri

string

URI نقطه ورودی. حداکثر طول ۱۳۰۰ نویسه است. قالب‌بندی به نوع نقطه ورودی بستگی دارد:

  • بیشتر: طرح‌واره http: یا https: لازم است.
  • تلفن: طرح‌واره tel: لازم است. شناسه منبع یکسان باید شامل کل توالی شماره‌گیری باشد (برای مثال، «tel:+12345678900,,,12345678;1234»).
  • sip: طرح‌واره sip: یا sips: لازم است. برای مثال «sip:12345678@myprovider.com».
  • video: طرح‌واره http: یا https: لازم است.
regionCode

string

کد منطقه شماره تلفن. اگر URI کد کشور نداشته باشد، کاربران به آن نیاز دارند. مقادیر براساس فهرست عمومی CLDR از کدهای منطقه است.

entryPointFeatures[]

string

ویژگی‌های نقطه ورودی. درحال‌حاضر این ویژگی‌ها فقط برای نقاط ورودی تلفن اعمال می‌شود:

  • toll: نقطه ورودی تماس تلفنی با هزینه است.
  • toll_free: نقطه ورود تماس تلفنی رایگان است.

پارامترها

نمایش JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
فیلدها
addOnParameters

object (AddOnParameters)

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

AddOnParameters

نمایش JSON
{
  "parameters": {
    string: string,
    ...
  }
}
فیلدها
parameters

map (key: string, value: string)

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

قابلیت‌ها

نمایش JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
فیلدها
canSeeAttendees

boolean

داده‌های تولیدشده توسط کاربر. اگر برافزا بتواند فهرست شرکت‌کنندگان رویداد را بخواند، true است؛ درغیراین‌صورت، false است.

canAddAttendees

boolean

داده‌های تولیدشده توسط کاربر. اگر برافزا بتواند شرکت‌کنندگان جدیدی به فهرست شرکت‌کنندگان رویداد اضافه کند، true و درغیراین‌صورت false است.

canSeeConferenceData

boolean

داده‌های تولیدشده توسط کاربر. true اگر برافزا بتواند داده‌های کنفرانس رویداد را بخواند؛ درغیراین‌صورت false.

canSetConferenceData

boolean

داده‌های تولیدشده توسط کاربر. اگر برافزا بتواند داده‌های کنفرانس رویداد را به‌روز کند، true است؛ درغیراین‌صورت false است.

canAddAttachments

boolean

داده‌های تولیدشده توسط کاربر. اگر برافزا بتواند پیوست‌های جدیدی به رویداد اضافه کند، true است؛ درغیراین‌صورت false است.

DriveEventObject

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

نمایش JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
فیلدها
selectedItems[]

object (DriveItemMetadata)

فهرستی از موارد (فایل‌ها یا پوشه‌ها) انتخاب‌شده در Drive.

activeCursorItem

object (DriveItemMetadata)

مورد Drive که درحال‌حاضر فعال است.

DriveItemMetadata

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

نمایش JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
فیلدها
id

string

شناسه مورد انتخاب‌شده.

iconUrl

string

نشانی وب نمادی که نشان‌دهنده مورد انتخاب‌شده است.

mimeType

string

نوع MIME مورد انتخاب‌شده.

title

string

عنوان مورد انتخاب‌شده.

addonHasFileScopePermission

boolean

اگر 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

string

شناسه پیام Gmail که درحال‌حاضر باز است.

threadId

string

شناسه رشته Gmail که درحال‌حاضر باز است.

accessToken

string

کد دسترسی مختص Gmail. می‌توانید از این کد با روش GmailApp.setCurrentMessageAccessToken(accessToken) استفاده کنید تا به برافزایتان اجازه دهید به‌طور موقت به پیام Gmail کاربر که درحال‌حاضر باز است دسترسی داشته باشد یا به برافزایتان اجازه دهید پیش‌نویس‌های جدید بنویسد.

toRecipients[]

string

به‌طور پیش‌فرض غیرفعال است. فهرست نشانی‌های ایمیل گیرنده «به:» که درحال‌حاضر در پیش‌نویسی که برافزا درحال نوشتن آن است گنجانده شده است. برای روشن کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess را در مانیفست روی METADATA تنظیم کنید.

ccRecipients[]

string

به‌طور پیش‌فرض غیرفعال است. فهرست نشانی‌های ایمیل گیرنده «رونوشت:» که درحال‌حاضر در پیش‌نویسی که برافزا درحال نوشتن آن است گنجانده شده است. برای روشن کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess را در مانیفست روی METADATA تنظیم کنید.

bccRecipients[]

string

به‌طور پیش‌فرض غیرفعال است. فهرست نشانی‌های ایمیل گیرنده «رونوشت مخفی:» که درحال‌حاضر در پیش‌نویسی که برافزا درحال نوشتن آن است گنجانده شده است. برای روشن کردن این فیلد، باید فیلد addOns.gmail.composeTrigger.draftAccess را در مانیفست روی METADATA تنظیم کنید.

SheetsEventObject

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

نمایش JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
فیلدها
id

string

فقط درصورتی وجود دارد که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد. شناسه صفحه‌گسترده بازشده در میانای کاربر «کاربرگ‌نگار».

title

string

فقط درصورتی وجود دارد که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد. عنوان صفحه‌گسترده در میانای کاربر «کاربرگ‌نگار» باز می‌شود.

addonHasFileScopePermission

boolean

اگر true، برافزا درخواست کرده و مجوز محدوده https://www.googleapis.com/auth/drive.file را برای صفحه‌گسترده باز در میانای کاربر «کاربرگ‌نگار» دریافت کرده است؛ درغیراین‌صورت این فیلد false است.

matchedUrl

object (MatchedUrl)

فقط درصورت برآورده شدن شرایط زیر وجود دارد:

  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • نشانی وب با الگوی میزبان مشخص‌شده در راه‌انداز LinkPreviewTriggers مطابقت دارد.

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

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

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

MatchedUrl

شیء رویداد با درخواست‌های پیش‌نمایش پیوند برگردانده شد.

نمایش JSON
{
  "url": string
}
فیلدها
url

string

نشانی وبی که مطابقت داده شد.

SlidesEventObject

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

نمایش JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
فیلدها
id

string

فقط درصورتی وجود دارد که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد. شناسه ارائه بازشده در میانای کاربر «اسلایدنگار».

title

string

فقط درصورتی وجود دارد که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد. عنوان ارائه در میانای کاربر «اسلایدنگار» باز می‌شود.

addonHasFileScopePermission

boolean

اگر true، برافزا مجوز محدوده https://www.googleapis.com/auth/drive.file را برای ارائه باز در میانای کاربر «اسلایدنگار» درخواست و دریافت کرده است؛ درغیراین‌صورت این فیلد false است.

matchedUrl

object (MatchedUrl)

فقط درصورت برآورده شدن شرایط زیر وجود دارد:

  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • نشانی وب با الگوی میزبان مشخص‌شده در راه‌انداز LinkPreviewTriggers مطابقت دارد.

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

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

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

DocsEventObject

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

نمایش JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
فیلدها
id

string

فقط درصورتی وجود دارد که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد. شناسه سند بازشده در میانای کاربر «سندنگار».

title

string

فقط درصورتی وجود دارد که دامنه https://www.googleapis.com/auth/drive.file توسط کاربر مجاز شده باشد. عنوان سند بازشده در میانای کاربر «سندنگار».

addonHasFileScopePermission

boolean

اگر true، برافزا برای سند باز در میانای کاربر «سندنگار» درخواست https://www.googleapis.com/auth/drive.file مجوز دامنه کرده و آن را دریافت کرده است؛ درغیراین‌صورت این فیلد false است.

matchedUrl

object (MatchedUrl)

فقط درصورت برآورده شدن شرایط زیر وجود دارد:

  • https://www.googleapis.com/auth/workspace.linkpreview توسط کاربر مجاز شده است.
  • نشانی وب با الگوی میزبان مشخص‌شده در راه‌انداز LinkPreviewTriggers مطابقت دارد.

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

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

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

ChatEventObject

بار داده شیء رویداد برنامه Google Chat که از سرور Google به برافزاها ارسال شده است. از بار داده می‌توان برای شناسایی نوع رویداد استفاده کرد.

نمایش JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
فیلدها
type

enum (EventType)

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

user

object (User)

کاربری که با برنامه Chat تعامل دارد.

space

object (Space)

فضایی که رویداد در آن رخ داده است، فقط برای رویدادهای «صفحه اصلی برنامه» در برنامه‌های Chat که برافزا نیستند درج می‌شود.

eventTime

string (Timestamp format)

مُهر زمان نشان‌دهنده زمان وقوع شیء رویداد.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

پایه‌بار شیء رویداد. بار داده‌ها به نوع شیء رویداد بستگی دارد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
messagePayload

object (MessagePayload)

کاربری پیامی به برنامه Chat ارسال می‌کند یا در فضایی از برنامه Chat با @نام می‌برد. درعوض، فراخوانی‌های فرمان برنامه (مثل فرمان‌های خط مورب و فرمان‌های سریع) در appCommandPayload ارائه می‌شود.

addedToSpacePayload

object (AddedToSpacePayload)

کاربری برنامه Chat را به فضای Chat اضافه می‌کند، یا سرپرست Google Workspace برنامه Chat را در فضاهای پیام مستقیم برای کاربران سازمانش نصب می‌کند.

removedFromSpacePayload

object (RemovedFromSpacePayload)

کاربری برنامه Chat را از فضا بردارد.

buttonClickedPayload

object (ButtonClickedPayload)

نشان‌دهنده داده‌های بار مفید است وقتی کاربر با عنصر تعاملی کارت یا چارگوش گفتگویی تعامل می‌کند که فراخوان بازگشت Action را راه‌اندازی می‌کند. Despite the name, this payload is populated for all card and dialog Action callbacks—not only button clicks, but also onChangeAction triggers, onClick actions, CardAction clicks, and dialog submission or cancellation (SUBMIT_DIALOG and CANCEL_DIALOG).

اگر کاربری با کادر گفتگویی تعامل داشته باشد، فیلد isDialogEvent مربوط به ButtonClickedPayload روی true تنظیم می‌شود و شامل DialogEventType است.

بار داده کامل شامل commonEventObject.formInputs و commonEventObject.parameters نیز می‌شود.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

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

بار مفید کامل شامل CommonEventObject.parameters['autocomplete_widget_query'] نیز می‌شود.

appCommandPayload

object (AppCommandPayload)

کاربر فرمان برنامه را فراخوانی می‌کند.

systemCommandPayload

object (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)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
فیلدها
space

object (Space)

الزامی. فضای Chat که شیء رویداد در آن رخ می‌دهد.

message

object (Message)

پیامی که شیء رویداد را راه‌اندازی می‌کند.

configCompleteRedirectUri

string

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

AddedToSpacePayload

کاربری برنامه Chat را به فضایی اضافه می‌کند، یا پیام مستقیمی بین برنامه و کاربر ایجاد می‌شود.

نمایش JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
فیلدها
space

object (Space)

الزامی. فضای Chat که شیء رویداد در آن رخ می‌دهد.

interactionAdd

boolean

آیا برنامه با تعامل کاربر به فضا اضافه شده است (برای مثال، با @ نامبری برنامه Chat یا فراخوانی با فرمان خط مورب). اگر این مقدار روی true تنظیم شود، شیء رویداد جداگانه‌ای مرتبط با خود تعامل وجود خواهد داشت که به برنامه Chat ارسال می‌شود.

configCompleteRedirectUri

string

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

RemovedFromSpacePayload

کاربری برنامه Chat را از فضا بردارد.

نمایش JSON
{
  "space": {
    object (Space)
  }
}
فیلدها
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)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
فیلدها
space

object (Space)

الزامی. فضای Chat که شیء رویداد در آن رخ می‌دهد.

message

object (Message)

پیامی که شیء رویداد را راه‌اندازی می‌کند.

isDialogEvent

boolean

برای اشیاء رویداد ButtonClicked و Message، اینکه آیا کاربر با کادر گفتگو تعامل دارد یا در آستانه تعامل با آن است.

dialogEventType

enum (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)
  }
}
فیلدها
space

object (Space)

الزامی. فضای Chat که شیء رویداد در آن رخ می‌دهد.

AppCommandPayload

کاربر فرمان برنامه را فراخوانی می‌کند.

نمایش JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
فیلدها
appCommandMetadata

object (AppCommandMetadata)

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

space

object (Space)

اختیاری. فضای Chat که شیء رویداد در آن رخ می‌دهد.

thread

object (Thread)

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

message

object (Message)

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

configCompleteRedirectUri

string

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

isDialogEvent

boolean

اختیاری. آیا کاربر درحال تعامل با کادر گفتگویی است یا می‌خواهد با آن تعامل داشته باشد.

dialogEventType

enum (DialogEventType)

اختیاری. نوع شیء رویداد گفتگو دریافت شد. این فیلد فقط درصورتی اعمال می‌شود که isDialogEvent true باشد.

AppCommandMetadata

فراداده درباره فرمان برنامه Chat.

نمایش JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
فیلدها
appCommandId

integer

شناسه فرمان مشخص‌شده در پیکربندی Chat API.

appCommandType

enum (AppCommandType)

نوع فرمان برنامه Chat.

AppCommandType

نوع فرمان برنامه Chat. برای جزئیات، به انواع فرمان‌های برنامه Chat مراجعه کنید.

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

SystemCommandPayload

کاربری فرمان سیستم را فراخوانی می‌کند.

نمایش JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
فیلدها
systemCommandMetadata

object (SystemCommandMetadata)

فراداده مربوط به فرمان سیستم که فراخوانی شده است.

space

string

اختیاری. فضای Chat که شیء رویداد در آن رخ می‌دهد.

thread

object (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)
  }
  // End of mutually exclusive fields.
}
فیلدها
فرمان سیستم فراخوانده شد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
cancelStream

object (CancelStream)

فرمان لغو پیام جاری‌سازی فعال.

پایان فیلدهای متقابلاً انحصاری.

CancelStream

فرمان لغو پیام جاری‌سازی فعال.

نمایش JSON
{
  "streamMessage": string
}
فیلدها
streamMessage

string

الزامی. نام منبع پیام جاری‌سازی که فرمان لغو روی آن اجرا شده است.

قالب: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange شیء رویداد به برافزاهای «گردش کار» منتقل شد.

نمایش JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
فیلدها
executionMetadata

object (ExecutionMetadata)

فراداده مربوط به اجرای گردش کار.

triggerEventSource

enum (TriggerEventSource)

منبع رویدادهای راه‌انداز.

نوع بار داده رویداد گردش کار. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
actionInvocation

object (ActionInvocation)

فراخوانی کنش گردش کار.

triggerCreation

object (TriggerCreation)

ایجاد راه‌انداز گردش کار.

triggerDeletion

object (TriggerDeletion)

حذف راه‌انداز گردش کار.

resourceRetrieval

object (ResourceRetrieval)

بازیابی منبع (برای تورم متغیر استفاده می‌شود).

elementConfiguration

object (ElementConfiguration)

پیکربندی عنصر گردش کار.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

بازیابی تعریف فیلد پشتیبانی‌شده توسط منبع.

elementUiAutocomplete

object (ElementUiAutocomplete)

پیشنهادهای تکمیل خودکار برای کارت ارائه‌شده فعلی.

پایان فیلدهای متقابلاً انحصاری.

ActionInvocation

فراخوانی کنش گردش کار.

نمایش JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
فیلدها
inputs

map (key: string, value: object (VariableData))

نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

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

flowLevelContext

object (FlowLevelContext)

اختیاری. بافت سطح جریان از مراحل قبلی.

VariableData

نشان‌دهنده داده‌های متغیر است که می‌تواند چندین مقدار از انواع مختلف را در خود نگه دارد.

نمایش JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
فیلدها
booleanValues[]

boolean

مقادیر بولی.

integerValues[]

string (int64 format)

مقادیر صحیح.

floatValues[]

number

مقادیر شناور.

stringValues[]

string

مقادیر رشته‌ای.

timestampValues[]

string (Timestamp format)

مقادیر مُهر زمان.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

مرجع‌های منبع (شناسه‌ها).

emailAddressValues[]

string

مقادیر نشانی ایمیل.

googleUserValues[]

string

مقادیر کاربر Google در قالب users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

مقادیر قالب نوشتار گردش کار.

ResourceReference

مقدار شناسه منبع خاص برنامه.

نمایش JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
فیلدها
resourceType

object (ResourceType)

نوع منبعی که این شناسه به آن اشاره می‌کند.

resourceId

string

شناسه منبع.

ResourceType

نام نوع منبع سفارشی.

نمایش JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
فیلدها
workflowBundleId

string

شناسه بسته گردش کار که مالک این نوع منبع است. این مورد اختیاری است و اگر خالی باشد، همان دسته‌ای درنظر گرفته می‌شود که در آن استفاده می‌شود.

workflowResourceDefinitionId

string

شناسه یکتای منبع. این فقط باید در همان بسته منحصربه‌فرد باشد.

WorkflowTextFormat

بلوکی از نوشتار با گزینه‌های قالب‌بندی غنی شامل سبک‌ها، پیوندها، و عناصر تعاملی.

نمایش JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
فیلدها
textFormatElements[]

object (TextFormatElement)

مجموعه‌ای از عناصر قالب نوشتار.

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 (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
فیلدها
عنصری که نشان‌دهنده یکی از چندین عنصر قالب نوشتار ممکن است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
text

string

نوشتار در قالب نوشتاری.

chip

object (Chip)

تراشه کلیک‌کردنی در قالب نوشتار.

styledText

object (StyledText)

نوشتار سبک‌دار در قالب نوشتار.

listContainer

object (ListContainer)

محتوی فهرست در قالب نوشتار.

پایان فیلدهای متقابلاً انحصاری.

تراشه

تراشه کلیک‌کردنی در قالب نوشتار.

نمایش JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
فیلدها
icon

object (Icon)

نمادی که در تراشه نمایش داده می‌شود.

label

string

نوشتاری که در تراشه نمایش داده می‌شود.

url

string

نشانی وب برای پیمایش به آن وقتی روی تراشه کلیک می‌شود.

نماد

نمادی در تراشه.

نمایش 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

string

نماد سفارشی میزبانی‌شده در نشانی وب HTTPS را نمایش می‌دهد.

برای مثال:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

انواع فایل‌های پشتیبانی‌شده شامل .png و .jpg است.

materialIconName

string

نام نماد تعریف‌شده در نماد Google Material، برای مثال، check_box. هر نام نامعتبری رها می‌شود و با رشته خالی جایگزین می‌شود و درنتیجه نماد پرداز نمی‌شود.

پایان فیلدهای متقابلاً انحصاری.

StyledText

عنصر نوشتاری با سبک‌هایی مثل پررنگ، ایتالیک، و رنگ.

نمایش JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
فیلدها
text

string

محتوای اصلی نوشتار.

styles[]

enum (Style)

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

fontWeight

enum (FontWeight)

سیاهی قلم نوشتار.

color

object (Color)

رنگ نوشتار.

wrapStyle

enum (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 بدون سبک دورتادور.

ListContainer

محفظه برای موارد فهرست، که هر مورد فهرست می‌تواند حاوی چندین TextFormatElement باشد.

نمایش JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
فیلدها
listNestLevel

string (int64 format)

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

listType

enum (ListType)

نوع فهرست.

listItems[]

object (ListItem)

مجموعه‌ای از موارد فهرست.

ListType

Enum برای انواع مختلف فهرست.

شمارشی‌ها
LIST_TYPE_UNSPECIFIED نوع فهرست مشخص نشده است. استفاده نشود.
ORDERED فهرست مرتب‌شده.
UNORDERED فهرست مرتب‌نشده.
BLOCKQUOTE نشان‌دهنده فهرست نقل‌قول است.

ListItem

مورد فهرست.

نمایش JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
فیلدها
textFormatElements[]

object (TextFormatElement)

مجموعه‌ای از عناصر قالب نوشتار.

FlowLevelContext

بافت سطح جریان کار حاوی خروجی‌های مراحل قبلی.

نمایش JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
فیلدها
stepContexts[]

object (StepContext)

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

StepContext

فراداده‌های بافت مرحله و خروجی‌ها برای بافت سطح جریان.

نمایش JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
فیلدها
stepId

string

اختیاری. شناسه یکتای مرحله در نمودار گردش کار.

outputs

map (key: string, value: object (VariableData))

اختیاری. نقشه متغیرهای برونداد تولیدشده توسط این مرحله، که با نام متغیر کلیدگذاری شده است.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

ایجاد راه‌انداز گردش کار.

نمایش JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
فیلدها
triggerId

string

شناسه یکتای راه‌انداز ارائه‌شده درطول ایجاد.

triggerType

enum (TriggerType)

نوع راه‌انداز.

inputs

map (key: string, value: object (VariableData))

نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

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

TriggerType

نوع راه‌انداز.

شمارشی‌ها
TRIGGER_TYPE_UNDEFINED مقدار پیش‌فرض. استفاده نشود.
REPEATING هر بار که شرایط ورودی برآورده شود، راه‌انداز فعال می‌شود.

TriggerDeletion

حذف راه‌انداز گردش کار.

نمایش JSON
{
  "triggerId": string
}
فیلدها
triggerId

string

شناسه یکتای راه‌انداز ارائه‌شده درطول ایجاد.

ResourceRetrieval

بازیابی منبع.

نمایش JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
فیلدها
resourceReference

object (ResourceReference)

نوع و شناسه منبعی که باید بازیابی شود.

ElementConfiguration

فراخوانی هنگام پیکربندی عنصر گردش کار.

نمایش JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
فیلدها
inputs

map (key: string, value: object (VariableData))

نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است. این نقشه ممکن است خالی باشد. Used when configuring single workflow element (trigger or action) in workflow home.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

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

nodeId

string

شناسه گره پیکربندی اصلی که درحال ارائه است.

workflowId

string

شناسه گردش کار پیکربندی اولیه که درحال رندر شدن است.

availableVariables[]

object (VariableReference)

متغیرهای دردسترس براساس موقعیت گره مرتب شده‌اند.

DisplayDestination

نشان می‌دهد کارت پیکربندی عنصر برگشتی کجا نمایش داده خواهد شد.

شمارشی‌ها
DISPLAY_DESTINATION_UNSPECIFIED مقدار پیش‌فرض. استفاده نشود.
DISPLAY_DESTINATION_SIDE_PANEL کارت پیکربندی قرار است در «پانل کناری» نمایش داده شود.
DISPLAY_DESTINATION_FULL_SCREEN کارت پیکربندی باید در برنامه «تمام‌صفحه» نمایش داده شود.

VariableReference

مرجع متغیر به متغیری در گردش کار.

نمایش JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
فیلدها
parentElementId

string

شناسه اصلی عنصری که متغیر را تولید می‌کند. درصورت نیاز می‌توانیم این را به WorkflowElement یا فراداده دقیق‌تر proto گسترش دهیم.

nodeId

string

شناسه مرجع گره

path

string

امضای مسیر گزینشگر متغیر

dataType

object (DataType)

نوع داده متغیر

iconUrl

string

نشانی وب نماد اولیه که این متغیر را تولید می‌کند.

stepNumber

integer

شماره مرحله از دستور اولیه‌ای که این متغیر را تولید می‌کند.

descriptionText

string

شرح متغیر.

displayText

string

نوشتار نمایشی تراشه متغیر.

DataType

نوع متغیر.

نمایش JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
فیلدها
valueMetadata

object (ValueMetadata)

فراداده درباره مقادیر بالقوه متغیر.

نوع داده. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
basicType

enum (BasicType)

نوع داده پایه.

resourceType

object (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 (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
فیلدها
enumValues[]

string

اختیاری. مقادیر مجاز برای رشته را مشخص می‌کند. این مورد فقط درصورتی تنظیم می‌شود که DataType روی STRING باشد.

dynamicTypes[]

enum (BasicType)

اختیاری. انواع مجاز را که می‌توانند به‌طور پویا برای متغیر قالب‌بندی شوند مشخص می‌کند. این مورد فقط زمانی می‌تواند تنظیم شود که DataType (نوع داده) از نوع String (رشته) باشد و متغیر از نوع برونداد باشد.

semanticDescriptors[]

object (SemanticDescriptor)

اختیاری. به توصیف معنای معنایی متغیر کمک می‌کند.

dynamicSchema

object (DynamicSchema)

اختیاری. پیکربندی برای حل پویای طرحواره این متغیر.

defaultValue

string

اختیاری. رشته‌ای که مقدار پیش‌فرض را برای این متغیر مشخص می‌کند. برای مثال، برای مقادیر بولی، defaultValue ممکن است روی true یا false تنظیم شود.

SemanticDescriptor

فراداده درباره معنی معنایی متغیر.

نمایش JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
فیلدها
resourceAttribute

string

نشان می‌دهد که متغیر با مشخصه خاصی از منبع مطابقت دارد. این به‌ویژه برای متغیرهایی مفید است که نشان‌دهنده شناسه منبع (شناسه، نشانی وب، کلید، و غیره) هستند.

قالب توصیه‌شده این است: - "{brand}/{appName}/{resource}:{attribute}" {brand} اختیاری است و اگر با {appName} یکسان باشد باید حذف شود.

مثال‌ها: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" و غیره.

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

disallowedResourceAttributes[]

string

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

DynamicSchema

پیکربندی برای حل پویای طرحواره این متغیر در زمان اجرا.

نمایش JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
فیلدها
requiredInputIds[]

string

شناسه‌های متغیرهای ورودی هم‌رده که باید قبل‌از اینکه طرح‌واره این متغیر به‌طور پویا حل شود ارائه شوند.

strictEnum

boolean

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

ResourceFieldsDefinitionRetrieval

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

نمایش JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
فیلدها
elementId

string

شناسه عنصری را که طرحواره منبع پویای آن باید واکشی شود مشخص می‌کند.

inputs

map (key: string, value: object (VariableData))

این شامل ورودی‌های فیلد گره‌ای است که متغیر را ارائه می‌دهد. نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

پیشنهادهای تکمیل خودکار برای کارت ارائه‌شده فعلی.

نمایش JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
فیلدها
query

string

پرسمان برای تکمیل خودکار.

inputs

map (key: string, value: object (VariableData))

نقشه متغیرهای ورودی که با نام متغیر ورودی کلیدگذاری شده است.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

تابع فراخوانده‌شده مرتبط با ابزاره.

resourceId

string

شناسه منبعی که باید برای آن تکمیل خودکار انجام شود. این فیلد اختیاری است و ممکن است تنظیم نشده باشد.

operationId

string

شناسه عملیاتی که منبع را برای تکمیل خودکار ارائه کرده است. این فیلد اختیاری است و ممکن است تنظیم نشده باشد.

ExecutionMetadata

فراداده مربوط به اجرای گردش کار.

نمایش JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
فیلدها
versionId

integer

نسخه عنصر گردش کار که فراخوانی می‌شود.

timeZone

string

منطقه زمانی گردش کاری که ذخیره می‌شود. برای نمونه، «America/Los_Angeles».

stepNumber

integer

نشان‌دهنده شماره مرحله دستور اولیه‌ای است که فراخوانی می‌شود.

TriggerEventSource

منبع رویداد راه‌اندازی که این اجرا را راه‌اندازی کرده است.

شمارشی‌ها
TRIGGER_EVENT_SOURCE_UNSPECIFIED مقدار پیش‌فرض. استفاده نشود.
TRIGGER_EVENT_SOURCE_AUTOMATED اجرا به‌طور خودکار توسط رویدادها راه‌اندازی می‌شود.
TRIGGER_EVENT_SOURCE_TEST_RUN اجرا ازطریق اجرای آزمایشی راه‌اندازی می‌شود.