אירוע אינטראקציה עם אפליקציית Google Chat.
מידע נוסף על אירועי אינטראקציה זמין במאמר קבלת אינטראקציות עם אפליקציית Google Chat ותגובה אליהן. מידע נוסף על סוגי אירועים, לדוגמה מטענים ייעודיים (payloads) של אירועים, זמין במאמר סוגים של אירועי אינטראקציה באפליקציות ב-Google Chat.
אפליקציות ל-Chat יכולות לקבל גם אירועים מאינטראקציות של משתמשים, כולל אירועים של שינויים במרחבים משותפים, למשל הוספה של חבר חדש למרחב משותף. מידע נוסף על אירועים במרחבים משותפים זמין במאמר עבודה עם אירועים מ-Google Chat.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
הסוג של אירוע האינטראקציה. מידע נוסף מופיע במאמר סוגים של אירועי אינטראקציה באפליקציות ב-Google Chat. |
eventTime |
חותמת הזמן שמציינת מתי התרחש אירוע האינטראקציה. |
token |
ערך סודי שבעזרתו אפליקציות Chat מדור קודם יכולות להשתמש כדי לאמת אם בקשה מסוימת מגיעה מ-Google. Google יוצרת את האסימון באופן אקראי, והערך שלו נשאר סטטי. אתם יכולים לקבל את האסימון, לבטל אותו או ליצור אותו מחדש דרך דף ההגדרות של Chat API במסוף Google Cloud. באפליקציות מודרניות ל-Chat לא משתמשים בשדה הזה. הוא חסר בתשובות ה-API ובדף ההגדרה של Chat API. |
threadKey |
המפתח שהוגדר על ידי האפליקציה של Chat לשרשור שקשור לאירוע האינטראקציה. מידע נוסף זמין בכתובת |
message |
ההודעה שהפעילה את אירוע האינטראקציה, אם רלוונטי. |
user |
המשתמש שהפעיל את אירוע האינטראקציה. |
space |
המרחב המשותף שבו התרחש אירוע האינטראקציה. |
action |
באירועי אינטראקציה עם |
configCompleteRedirectUrl |
כתובת ה-URL שאליה אפליקציית Chat תפנה את המשתמשים אחרי שהשלימו תהליך הרשאה או הגדרה מחוץ ל-Google Chat. מידע נוסף זמין במאמר איך לקשר אפליקציה של Chat לכלים ולשירותים אחרים. |
isDialogEvent |
לגבי אירועי אינטראקציה מסוג |
dialogEventType |
הסוג של אירוע אינטראקציה מסוג תיבת דו-שיח שהתקבל. |
common |
מייצג מידע על הלקוח של המשתמש, כמו הלוקאל, האפליקציה המארחת והפלטפורמה. באפליקציות ל-Chat, המידע |
CommonEventObject
מייצג מידע על הלקוח של המשתמש, כמו הלוקאל, האפליקציה המארחת והפלטפורמה. באפליקציות ל-Chat, הערך CommonEventObject
כולל נתונים שנשלחו על ידי משתמשים שמקיימים אינטראקציה עם כרטיסים, כמו נתונים שהוזנו בתיבות דו-שיח.
ייצוג JSON |
---|
{ "userLocale": string, "hostApp": enum ( |
שדות | |
---|---|
userLocale |
|
hostApp |
The hostApp enum שמציין את האפליקציה שממנה מופעל התוסף. תמיד |
platform |
מספר הפלטפורמה 'enum', שמציין את הפלטפורמה שבה הגיע האירוע ( |
timeZone |
מזהה אזור הזמן והיסט שלו מזמן אוניברסלי מתואם (UTC). האפשרות נתמכת רק עבור סוגי האירועים |
formInputs |
מפה שמכילה את הערכים שמשתמש מזין בווידג'ט מכרטיס או מתיבת דו-שיח. מפתחות המפה הם מזהי המחרוזות שמוקצים לכל ווידג'ט, והערכים מייצגים ערכי קלט לווידג'ט. מידע נוסף מופיע במאמר מידע על התהליך שמשתמשים מזינים. |
parameters |
פרמטרים מותאמים אישית שמועברים לפונקציה שמופעלת. המפתחות והערכים חייבים להיות מחרוזות. |
invokedFunction |
שם הפונקציה שמופעלת שמשויכת לווידג'ט. ההגדרה מוגדרת רק לאפליקציות ל-Chat. |
TimeZone
מזהה אזור הזמן והיסט שלו מזמן אוניברסלי מתואם (UTC). האפשרות נתמכת רק עבור סוגי האירועים CARD_CLICKED
ו-SUBMIT_DIALOG
.
ייצוג JSON |
---|
{ "id": string, "offset": integer } |
שדות | |
---|---|
id |
קוד מסד הנתונים של אזור הזמן IANA TZ, למשל, "America/Toronto". |
offset |
הסטייה של אזור הזמן של המשתמש, באלפיות השנייה, לעומת זמן אוניברסלי מתואם (UTC). |
קלט
סוגי הנתונים שמשתמשים יכולים להזין בכרטיסים או בתיבות דו-שיח. סוג הקלט תלוי בסוג הערכים שהווידג'ט מקבל.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
|
|
stringInputs |
רשימת מחרוזות שמייצגות את הערכים שהמשתמש מזין בווידג'ט. אם בווידג'ט אפשר להזין רק ערך אחד, כמו ווידג'ט |
dateTimeInput |
ערכי קלט של תאריך ושעה בווידג'ט |
dateInput |
ערכי קלט של תאריך מהווידג'ט |
timeInput |
ערכי קלט של זמן מהווידג'ט |
StringInputs
פרמטר קלט לווידג'טים רגילים. לווידג'טים בעלי ערך יחיד, זוהי רשימה של ערכים בודדים. לווידג'טים בעלי ערכים מרובים, כמו תיבות סימון, כל הערכים מוצגים.
ייצוג JSON |
---|
{ "value": [ string ] } |
שדות | |
---|---|
value[] |
רשימת מחרוזות שהמשתמש הזין. |
DateTimeInput
ערכי קלט של תאריך ושעה.
ייצוג JSON |
---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
שדות | |
---|---|
msSinceEpoch |
הזמן מאז תחילת התקופה, באלפיות השנייה. |
hasDate |
אם הקלט |
hasTime |
האם הקלט |
DateInput
ערכי קלט של תאריך.
ייצוג JSON |
---|
{ "msSinceEpoch": string } |
שדות | |
---|---|
msSinceEpoch |
הזמן מאז תחילת התקופה, באלפיות השנייה. |
TimeInput
ערכי קלט זמן.
ייצוג JSON |
---|
{ "hours": integer, "minutes": integer } |
שדות | |
---|---|
hours |
השעה בשעון של 24 שעות. |
minutes |
מספר הדקות אחרי השעה. הערכים החוקיים הם 0 עד 59. |