Event

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

علاوه بر دریافت رویدادها از تعاملات کاربر، برنامه‌های چت می‌توانند رویدادهایی را درباره تغییرات فضاها دریافت کنند، مانند زمانی که یک عضو جدید به یک فضا اضافه می‌شود. برای آشنایی با رویدادهای فضایی، به کار با رویدادها از Google Chat مراجعه کنید.

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

نمایندگی JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
فیلدها
type

enum ( EventType )

نوع تعامل کاربر با برنامه چت، مانند MESSAGE یا ADDED_TO_SPACE .

eventTime

string ( Timestamp format)

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

token

string

یک مقدار مخفی که برنامه‌های چت قدیمی می‌توانند از آن برای تأیید اینکه آیا درخواستی از طرف Google است استفاده کنند. گوگل به صورت تصادفی توکن را تولید می کند و ارزش آن ثابت می ماند. می‌توانید توکن را از صفحه پیکربندی Chat API در Google Cloud Console دریافت، لغو یا بازسازی کنید.

برنامه‌های چت مدرن از این فیلد استفاده نمی‌کنند. در پاسخ‌های API و صفحه پیکربندی Chat API وجود ندارد.

threadKey

string

کلید تعریف شده توسط برنامه چت برای رشته مرتبط با رویداد تعامل. برای اطلاعات بیشتر به spaces.messages.thread.threadKey مراجعه کنید.

message

object ( Message )

برای رویدادهای تعاملی ADDED_TO_SPACE ، CARD_CLICKED ، و MESSAGE ، پیامی که رویداد تعامل را راه‌اندازی کرد، در صورت وجود.

user

object ( User )

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

thread

object ( Thread )

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

space

object ( Space )

فضایی که کاربر در آن با برنامه چت تعامل داشت.

action

object ( FormAction )

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

configCompleteRedirectUrl

string

این URL برای رویدادهای تعاملی MESSAGE ، ADDED_TO_SPACE ، و APP_COMMAND پر شده است. پس از تکمیل جریان مجوز یا پیکربندی خارج از گپ Google، کاربران باید به این URL هدایت شوند تا به Google Chat سیگنال دهند که جریان مجوز یا پیکربندی موفقیت آمیز بوده است. برای اطلاعات بیشتر، به اتصال یک برنامه گپ با سایر خدمات و ابزارها مراجعه کنید.

isDialogEvent

boolean

برای رویدادهای تعامل CARD_CLICKED و MESSAGE ، چه کاربر در حال تعامل با یک گفتگو باشد یا در حال تعامل با آن باشد.

dialogEventType

enum ( DialogEventType )

نوع رویداد تعامل گفتگوی دریافت شده.

common

object ( CommonEventObject )

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

appCommandMetadata

object ( AppCommandMetadata )

فراداده درباره دستور برنامه Chat.

CommonEvent Object

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

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

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

نمایندگی 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 ). توسط برنامه های چت پشتیبانی نمی شود.

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 ))

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

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

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

  • ویجت های تک ارزشی (به عنوان مثال، یک جعبه متن): لیستی از رشته ها (فقط یک عنصر).

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

  • ویجت های چند ارزشی (به عنوان مثال، گروه های چک باکس): لیستی از رشته ها.

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

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

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

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

parameters

map (key: string, value: string)

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

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

invokedFunction

string

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

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

منطقه زمانی

شناسه منطقه زمانی و افست از زمان هماهنگ جهانی (UTC). فقط برای انواع رویداد CARD_CLICKED و SUBMIT_DIALOG پشتیبانی می شود.

نمایندگی JSON 
{
  "id": string,
  "offset": integer
}
فیلدها
id

string

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

offset

integer

منطقه زمانی کاربر، بر حسب میلی ثانیه، از زمان جهانی هماهنگ (UTC) خارج می شود.

ورودی ها

انواع داده هایی که کاربران می توانند روی کارت ها یا دیالوگ ها وارد کنند . نوع ورودی بستگی به نوع مقادیری دارد که ویجت می پذیرد.

نمایندگی JSON 
{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
فیلدها

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

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

stringInputs

object ( StringInputs )

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

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

dateTimeInput

object ( DateTimeInput )

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

dateInput

object ( DateInput )

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

timeInput

object ( TimeInput )

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

ورودی های رشته ای

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

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

ساعت در یک ساعت 24 ساعته.

minutes

integer

تعداد دقیقه های گذشته از ساعت. مقادیر معتبر 0 تا 59 هستند.

AppCommandMetadata

فراداده درباره دستور برنامه Chat .

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

integer

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

appCommandType

enum ( AppCommandType )

نوع دستور برنامه چت.