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)
  }
}
שדות
type

enum (EventType)

סוג האינטראקציה של המשתמש עם אפליקציית Chat, למשל MESSAGE או ADDED_TO_SPACE.
eventTime

string (Timestamp format)

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

string

ערך סודי שאפליקציות צ'אט מדור קודם יכולות להשתמש בו כדי לאמת אם הבקשה היא מ-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 כולל מידע שנשלח על ידי משתמשים שהייתה להם אינטראקציה עם תיבות דו-שיח, כמו נתונים שהוזנו בכרטיס.

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)

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

enum (Platform)

הפלטפורמה 'טיפוסים בני מנייה (enum)' שמציינת את הפלטפורמה שממנה הגיע האירוע (WEB, IOS או ANDROID). הפעולה הזו לא נתמכת על ידי אפליקציות צ'אט.
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.