Event

אירוע אינטראקציה באפליקציית Google Chat שמייצג ומכיל נתונים על האינטראקציה של משתמש עם אפליקציית Chat. במאמר קבלה של אינטראקציות של משתמשים ותגובה אליהן מוסבר איך להגדיר את אפליקציית 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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
שדות
type

enum (EventType)

הסוג של האינטראקציה של המשתמש עם אפליקציית Chat, למשל MESSAGE או ADDED_TO_SPACE.
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)

באירועי אינטראקציה מסוג ADDED_TO_SPACE,‏ CARD_CLICKED ו-MESSAGE, ההודעה שהפעילה את אירוע האינטראקציה, אם רלוונטי.
user

object (User)

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

object (Space)

המרחב שבו המשתמש קיים אינטראקציה עם אפליקציית Chat.
action

object (FormAction)

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

string

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

boolean

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

enum (DialogEventType)

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

object (CommonEventObject)

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

object (AppCommandMetadata)

מאוכלס בפקודות של אפליקציות, כולל פקודות דרך שורת הפקודות ופקודות מהירות.

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)

המאפיין המסווג (enum) hostApp שמציין את האפליקציה שממנה התוסף הופעל. תמיד CHAT לאפליקציות של Chat.
platform

enum (Platform)

Enumeration של הפלטפורמה שמציין את הפלטפורמה שממנה הגיע האירוע (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.

AppCommandMetadata

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

ייצוג ב-JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
שדות
appCommandId

integer

מזהה הפקודה של האינטראקציה עם האפליקציה.
appCommandType

enum (AppCommandType)

הסוג של פקודת האפליקציה.