Event

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

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

نمایندگی JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "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 .

event Time

string ( Timestamp format)

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

token

string

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

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

thread Key

string

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

message

object ( Message )

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

user

object ( User )

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

space

object ( Space )

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

action

object ( FormAction )

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

config Complete Redirect Url

string

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

is Dialog Event

boolean

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

dialog Event Type

enum ( DialogEventType )

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

common

object ( CommonEventObject )

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

app Command Metadata

object ( AppCommandMetadata )

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

CommonEvent Object

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

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

string

locale.displayName کامل در قالب [کد زبان ISO 639] - [کد کشور/منطقه ISO 3166] مانند "en-US".

host App

enum ( HostApp )

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

platform

enum ( Platform )

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

time Zone

object ( TimeZone )

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

form Inputs

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

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

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

parameters

map (key: string, value: string)

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

invoked Function

string

نام تابع فراخوانی مرتبط با ویجت. فقط برای برنامه‌های گپ تنظیم شده است.

منطقه زمانی

شناسه منطقه زمانی و افست از زمان هماهنگ جهانی (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 می توانند تنها یکی از موارد زیر باشند:

string Inputs

object ( StringInputs )

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

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

date Time Input

object ( DateTimeInput )

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

date Input

object ( DateInput )

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

time Input

object ( TimeInput )

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

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

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

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

string

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

DateTimeInput

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

نمایندگی JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
فیلدها
ms Since Epoch

string ( int64 format)

زمان از زمان دوران، در میلی ثانیه.

has Date

boolean

آیا ورودی datetime شامل تاریخ تقویم است یا خیر.

has Time

boolean

آیا ورودی datetime دارای مهر زمانی است یا خیر.

DateInput

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

نمایندگی JSON 
{
  "msSinceEpoch": string
}
فیلدها
ms Since Epoch

string ( int64 format)

زمان از زمان دوران، در میلی ثانیه.

TimeInput

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

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

integer

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

minutes

integer

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

AppCommandMetadata

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

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

integer

شناسه فرمان برای تعامل برنامه داده شده.

app Command Type

enum ( AppCommandType )

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