- ייצוג ב-JSON
- CommonEventObject
- TimeZone
- מכשירים לקליטת נתונים
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AppCommandMetadata
אירוע אינטראקציה באפליקציית Google Chat שמייצג נתונים על אינטראקציה של משתמש עם אפליקציית Chat ומכיל אותם. כדי להגדיר את אפליקציית Chat כך שתקבל אירועי אינטראקציה, אפשר לעיין במאמר בנושא קבלת אינטראקציות של משתמשים ומענה להן.
בנוסף לקבלת אירועים מאינטראקציות של משתמשים, אפליקציות ל-Chat יכולות לקבל אירועים לגבי שינויים במרחבים, למשל כשחבר חדש מצטרף למרחב. מידע על אירועים במרחבים זמין במאמר עבודה עם אירועים מ-Google Chat.
הערה: האירוע הזה משמש רק לאירועים של אינטראקציות בצ'אט. אם אפליקציית Chat שלכם נוצרה כתוסף ל-Google Workspace, תוכלו לעיין באובייקטים של אירועים ב-Chat במסמכי התיעוד של התוספים.
ייצוג ב-JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
הסוג של אינטראקציה של המשתמש עם אפליקציית הצ'אט, כמו |
eventTime |
חותמת הזמן שמציינת מתי התרחש אירוע האינטראקציה. |
token |
ערך סודי שאפליקציות של גרסאות קודמות של Chat יכולות להשתמש בו כדי לוודא שבקשה מגיעה מ-Google. Google יוצרת את הטוקן באופן אקראי, והערך שלו נשאר סטטי. אפשר לקבל, לבטל או ליצור מחדש את הטוקן מדף ההגדרות של Chat API במסוף Google Cloud. אפליקציות מודרניות של Chat לא משתמשות בשדה הזה. הוא לא מופיע בתשובות מה-API ובדף ההגדרות של Chat API. |
threadKey |
המפתח שהוגדר באפליקציית Chat לשרשור שקשור לאירוע האינטראקציה. מידע נוסף זמין בכתובת |
message |
עבור אירועי אינטראקציה |
user |
המשתמש שקיים אינטראקציה עם אפליקציית Chat. |
thread |
השרשור שבו המשתמש קיים אינטראקציה עם אפליקציית Chat. יכול להיות שזה יהיה שרשור חדש שנוצר על ידי הודעה חדשה שנשלחה. השדה הזה יאוכלס אם אירוע האינטראקציה משויך להודעה או לשרשור ספציפיים. |
space |
המרחב שבו המשתמש קיים אינטראקציה עם אפליקציית Chat. |
action |
באירועי אינטראקציה של |
configCompleteRedirectUrl |
כתובת ה-URL הזו מאוכלסת עבור אירועי אינטראקציה מסוג |
isDialogEvent |
באירועי אינטראקציה מסוג |
dialogEventType |
סוג אירוע האינטראקציה של תיבת הדו-שיח שהתקבל. |
common |
מייצג מידע על הלקוח של המשתמש, כמו מיקום, אפליקציית מארח ופלטפורמה. באפליקציות ל-Chat, |
appCommandMetadata |
מטא-נתונים על פקודה של אפליקציה ב-Chat. |
CommonEventObject
אובייקט האירוע הנפוץ הוא החלק של אובייקט האירוע הכולל שמעביר תיאור כללי, לא תלוי מארח, לתוסף מהלקוח של המשתמש. המידע הזה כולל פרטים כמו הלוקאל של המשתמש, אפליקציית המארח והפלטפורמה.
בנוסף לדף הבית ולטריגרים לפי הקשר, התוספים יוצרים ומעבירים אובייקטים של אירועים אל פונקציות של קריאה חוזרת (callback) לפעולות כשהמשתמש מקיים אינטראקציה עם ווידג'טים. פונקציית הקריאה החוזרת של התוסף יכולה לשלוח שאילתה לאובייקט האירוע המשותף כדי לקבוע את התוכן של הווידג'טים הפתוחים בלקוח של המשתמש. לדוגמה, התוסף יכול לאתר את הטקסט שמשתמש הזין בווידג'ט TextInput באובייקט eventObject.commentEventObject.formInputs
.
באפליקציות ל-Chat, השם של הפונקציה שהמשתמש הפעיל במהלך האינטראקציה עם הווידג'ט.
ייצוג ב-JSON |
---|
{ "userLocale": string, "hostApp": enum ( |
שדות | |
---|---|
userLocale |
מושבת כברירת מחדל. מזהה השפה והמדינה/האזור של המשתמש בפורמט של קוד שפה לפי תקן ISO 639 – קוד מדינה/אזור לפי תקן ISO 3166. לדוגמה, כדי להפעיל את השדה הזה, צריך להגדיר את |
hostApp |
מציין את אפליקציית המארח שבה התוסף פעיל כשנוצר אובייקט האירוע. הערכים האפשריים כוללים:
|
platform |
הערך enum של הפלטפורמה שמציין את הפלטפורמה שממנה הגיע האירוע ( |
timeZone |
מושבת כברירת מחדל. מזהה אזור הזמן וההפרש בינו לבין הזמן האוניברסלי המתואם (UTC). כדי להפעיל את השדה הזה, צריך להגדיר את התמיכה קיימת רק בסוגי האירועים |
formInputs |
מפה שמכילה את הערכים הנוכחיים של הווידג'טים בכרטיס שמוצג. מפתחות המפה הם מזהי המחרוזת שמוקצים לכל ווידג'ט. המבנה של אובייקט ערך המפה תלוי בסוג הווידג'ט: הערה: הדוגמאות הבאות מפורמטות לסביבת ההרצה של V8 ב-Apps Script. אם אתם משתמשים בזמן הריצה של Rhino, אתם צריכים להוסיף
דוגמה: כדי לגשת לערך של קלט טקסט עם
דוגמה: כדי לגשת למערך הערכים של ווידג'ט עם כמה ערכים שהמזהה שלו הוא
דוגמה: כדי לגשת לאובייקט
דוגמה: כדי לגשת לאובייקט
דוגמה: כדי לגשת לאובייקט |
parameters |
כל הפרמטרים הנוספים שמעבירים לפעולה באמצעות תצוגה מקדימה למפתחים: כדי להציע פריטים על סמך מה שהמשתמשים מקלידים בתפריטים עם אפשרות לבחירה מרובה של תוספים שמרחיבים את Google Chat, צריך להשתמש בערך של המפתח |
invokedFunction |
השם של הפונקציה להפעלה. השדה הזה לא מאוכלס בתוספים ל-Google Workspace שמרחיבים את Google Chat. במקום זאת, כדי לקבל נתוני פונקציות כמו מזהים, תוספים שמרחיבים את 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. |
AppCommandMetadata
מטא-נתונים על פקודה באפליקציית Chat.
ייצוג ב-JSON |
---|
{
"appCommandId": integer,
"appCommandType": enum ( |
שדות | |
---|---|
appCommandId |
המזהה של הפקודה שצוינה בהגדרות של Chat API. |
appCommandType |
סוג הפקודה באפליקציית Chat. |