Event

אירוע אינטראקציה עם אפליקציית Google Chat.

מידע נוסף על אירועי אינטראקציה זמין במאמר קבלת אינטראקציות עם אפליקציית Google Chat ותגובה אליהן. מידע נוסף על סוגי אירועים, לדוגמה מטענים ייעודיים (payloads) של אירועים, זמין במאמר סוגים של אירועי אינטראקציה באפליקציות ב-Google Chat.

אפליקציות ל-Chat יכולות לקבל גם אירועים מאינטראקציות של משתמשים, כולל אירועים של שינויים במרחבים משותפים, למשל הוספה של חבר חדש למרחב משותף. מידע נוסף על אירועים במרחבים משותפים זמין במאמר עבודה עם אירועים מ-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)
  }
}
שדות
type

enum (EventType)

הסוג של אירוע האינטראקציה. מידע נוסף מופיע במאמר סוגים של אירועי אינטראקציה באפליקציות ב-Google Chat.
eventTime

string (Timestamp format)

חותמת הזמן שמציינת מתי התרחש אירוע האינטראקציה.
token

string

ערך סודי שבעזרתו אפליקציות Chat מדור קודם יכולות להשתמש כדי לאמת אם בקשה מסוימת מגיעה מ-Google. Google יוצרת את האסימון באופן אקראי, והערך שלו נשאר סטטי. אתם יכולים לקבל את האסימון, לבטל אותו או ליצור אותו מחדש דרך דף ההגדרות של Chat API במסוף Google Cloud.

באפליקציות מודרניות ל-Chat לא משתמשים בשדה הזה. הוא חסר בתשובות ה-API ובדף ההגדרה של Chat API.
threadKey

string

המפתח שהוגדר על ידי האפליקציה של Chat לשרשור שקשור לאירוע האינטראקציה. מידע נוסף זמין בכתובת spaces.messages.thread.threadKey.
message

object (Message)

ההודעה שהפעילה את אירוע האינטראקציה, אם רלוונטי.
user

object (User)

המשתמש שהפעיל את אירוע האינטראקציה.
space

object (Space)

המרחב המשותף שבו התרחש אירוע האינטראקציה.
action

object (FormAction)

באירועי אינטראקציה עם CARD_CLICKED, נתוני הפעולות בטופס שמשויך אליהם כשמשתמש לוחץ על כרטיס או על תיבת דו-שיח. מידע נוסף זמין במאמר קריאת נתוני טפסים שהוזנו על ידי משתמשים בכרטיסים.
configCompleteRedirectUrl

string

כתובת ה-URL שאליה אפליקציית Chat תפנה את המשתמשים אחרי שהשלימו תהליך הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף זמין במאמר איך לקשר אפליקציה של Chat לכלים ולשירותים אחרים.
isDialogEvent

boolean

לאירועי אינטראקציה של CARD_CLICKED, האם למשתמש הייתה אינטראקציה עם תיבת דו-שיח.
dialogEventType

enum (DialogEventType)

הסוג של אירוע אינטראקציה מסוג תיבת דו-שיח שהתקבל.
common

object (CommonEventObject)

מייצג מידע על הלקוח של המשתמש, כמו הלוקאל, האפליקציה המארחת והפלטפורמה. באפליקציות ל-Chat, המידע CommonEventObject כולל מידע שנשלח על ידי משתמשים שמקיימים אינטראקציה עם תיבות דו-שיח, כמו נתונים שהוזנו בכרטיס.

CommonEventObject

מייצג מידע על הלקוח של המשתמש, כמו הלוקאל, האפליקציה המארחת והפלטפורמה. באפליקציות ל-Chat, הערך CommonEventObject כולל נתונים שנשלחו על ידי משתמשים שמקיימים אינטראקציה עם כרטיסים, כמו נתונים שהוזנו בתיבות דו-שיח.

ייצוג JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
שדות
userLocale

string

locale.displayName המלא בפורמט [קוד שפה ISO 639]-[קוד מדינה/אזור ISO 3166] כמו "en-US".
hostApp

enum (HostApp)

The hostApp enum שמציין את האפליקציה שממנה מופעל התוסף. תמיד CHAT באפליקציות ל-Chat.
platform

enum (Platform)

מספר הפלטפורמה 'enum', שמציין את הפלטפורמה שבה הגיע האירוע (WEB, IOS או ANDROID). האפשרות הזו לא נתמכת באפליקציות ל-Chat.
timeZone

object (TimeZone)

מזהה אזור הזמן והיסט שלו מזמן אוניברסלי מתואם (UTC). האפשרות נתמכת רק עבור סוגי האירועים CARD_CLICKED ו-SUBMIT_DIALOG.
formInputs

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

מפה שמכילה את הערכים שמשתמש מזין בווידג'ט מכרטיס או מתיבת דו-שיח. מפתחות המפה הם מזהי המחרוזות שמוקצים לכל ווידג'ט, והערכים מייצגים ערכי קלט לווידג'ט.

מידע נוסף מופיע במאמר מידע על התהליך שמשתמשים מזינים.
parameters

map (key: string, value: string)

פרמטרים מותאמים אישית שמועברים לפונקציה שמופעלת. המפתחות והערכים חייבים להיות מחרוזות.
invokedFunction

string

שם הפונקציה שמופעלת שמשויכת לווידג'ט. ההגדרה מוגדרת רק לאפליקציות ל-Chat.

TimeZone

מזהה אזור הזמן והיסט שלו מזמן אוניברסלי מתואם (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 שמקבל רק ערכי זמן.

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

השעה בשעון של 24 שעות.
minutes

integer

מספר הדקות אחרי השעה. הערכים החוקיים הם 0 עד 59.