פיתוח ממשקים ב-Google Chat

בדף הזה מוסבר איך ליצור ממשקי משתמש (UI) לתוספים של Google Workspace שמרחיבים את Google Chat.

כדי ליצור ממשקי משתמש לאפליקציות ל-Chat, משתמשים ברכיבי התוסף הבאים:

  • טריגרים: הדרכים שבהן משתמשים ב-Google Chat יכולים להפעיל אפליקציה ל-Chat, כמו הוספה שלה למרחב או שליחת הודעה אליה.
  • אובייקטים של אירועים: הנתונים שאפליקציות ל-Chat מקבלות מטריגרים או מאינטראקציות בממשק המשתמש.
  • פעולות: הדרכים שבהן אפליקציות ל-Chat יכולות להגיב לאינטראקציות, כמו שליחת הודעות או החזרת ממשק משתמש מבוסס-כרטיסים.
אפליקציית Chat מקבלת אובייקט אירוע מטריגר של 'נוספה למרחב'
איור 1: כשמשתמש מוסיף אפליקציה ל-Chat למרחב, מופעל הטריגר Added to space ונשלח אובייקט אירוע. כדי להגיב באמצעות הודעה, אפליקציית Chat מטפלת באובייקט האירוע ומחזירה פעולה שיוצרת את ההודעה.

אפליקציות ל-Chat יכולות ליצור ולהציג כרטיסים בממשקים הבאים:

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

טריגרים

בקטע הזה מוסבר על הטריגרים שבהם תוספים ל-Google Workspace משתמשים ב-Chat.

טריגרים הם הדרכים הספציפיות שבהן משתמשים מפעילים אפליקציית Chat באמצעות ממשק המשתמש של Chat, למשל באמצעות תיוגים עם @או פקודות לאפליקציה.

בטבלה הבאה מוצגים טריגרים של Chat, תיאור שלהם והתגובה האופיינית של אפליקציות Chat:

טריגר תיאור תשובה אופיינית
נוסף למרחב

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

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

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

  • שליחת הודעה בצ'אט ישיר עם אפליקציית Chat.
  • תיוג באמצעות @ של אפליקציית Chat בכל סוג של מרחב.
  • שולחים הודעה שמכילה קישור שתואם לתבנית כתובת ה-URL של תצוגות מקדימות של קישורים.
  • מקליד טקסט בתפריט לבחירה מרובה של selectionInput ווידג'ט.
 האפליקציה של Chat מגיבה על סמך תוכן ההודעה. לדוגמה, אפליקציית Chat עונה לפקודת הלוכס /about בהודעה שמסבירה את המשימות שאפליקציית Chat יכולה לבצע.
הסרה מהמרחב

משתמש מסיר את אפליקציית Chat מהמרחב, או אדמין ב-Google Workspace מסיר את ההתקנה של אפליקציית Chat עבור משתמש בארגון.

המשתמשים לא יכולים להסיר אפליקציות ל-Chat שהותקנו על ידי האדמין שלהם. אם משתמש התקין בעבר את אפליקציית Chat, האפליקציה תישאר מותקנת גם אם אדמין ב-Google Workspace ינסה להסיר אותה.

 אפליקציית Chat מסירה את כל ההתראות הנכנסות שהוגדרו למרחב (למשל, מחיקת webhook) ומנקה את האחסון הפנימי. אפליקציות צ'אט לא יכולות להגיב להודעות לגבי הטריגר הזה, כי הן כבר לא חברות בחלל.
פקודה באפליקציה

משתמש מריץ פקודה של אפליקציית Chat.

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

בניגוד לתוספים אחרים ל-Google Workspace, צריך להגדיר את כל פונקציות הקריאה החוזרת (callback) עבור הטריגרים האלה באמצעות Google Chat API. הוראות מפורטות זמינות במאמר הגדרת אפליקציית Google Chat.

במדריכים הבאים מוסבר איך מגיבים לטריגר:

אובייקטים של אירועים

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

במדריכים הבאים אפשר לקרוא על טיפול באובייקטים של אירועים:

מידע על אובייקטים של אירועים בתוספים ב-Chat ובאפליקציות אחרות של Google Workspace זמין במאמר אובייקטים של אירועים.

פעולות בצ'אט

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

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

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

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

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

תגובה באמצעות Google Chat API

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

  • הגיבו לאינטראקציה אחרי 30 שניות.
  • לבצע משימות מחוץ למרחב שבו התרחשה האינטראקציה.
  • לבצע משימות ב-Chat שלא זמינות כפעולות של תוסף. לדוגמה, אפשר להציג רשימה של מרחבים שמשתמש או אפליקציית Chat חברים בהם, או להוסיף משתמשים למרחב.
  • ביצוע משימות בשם המשתמש ב-Chat (שדורש אימות משתמש).

מידע על אימות של Chat API והתקשרות אליו זמין במאמר סקירה כללית על Chat API.