במדריך הזה נסביר איך לבנות אפליקציה ל-Google Chat שתעזור למשתמשי Google Chat לנהל את אנשי הקשר האישיים והעסקיים שלהם. כדי לאסוף מידע, אפליקציית Chat מבקשת מהמשתמשים למלא טופס ליצירת קשר בהודעות כרטיס ובתיבות דו-שיח.
כך נראית אפליקציית Chat בפעולה:
-
איור 1. אפליקציית Chat מגיבה לפקודת הלוכס /about
בהודעת טקסט ובלחצן שפותח טופס ליצירת קשר. -
איור 2. נפתחת תיבת דו-שיח באפליקציית Chat שבה המשתמשים יכולים להזין מידע על איש קשר. -
איור 3. אפליקציית Chat מחזירה תיבת דו-שיח לאישור, כדי שהמשתמשים יוכלו לבדוק את המידע ולאשר אותו לפני השליחה. -
איור 4. אחרי שהמשתמש שולח את הטופס, אפליקציית Chat שולחת הודעת טקסט פרטית כדי לאשר את השליחה. -
איור 5. האפליקציה Chat גם מציעה למשתמשים להוסיף איש קשר מכרטיס בהודעה.
דרישות מוקדמות
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
מטרות
- עיצוב ובנייה של ממשקי משתמש (UI)
כאובייקטים של
card
, והצגת ממשקי המשתמש בהודעות ובתיבות דו-שיח. - לקבל ולעבד מידע שמשתמשים שולחים באמצעות ווידג'טים של קלט בטופס.
- להגיב לפקודות באמצעות הודעות שמכילות טקסט, כרטיסים ווידג'טים של אביזרים.
ארכיטקטורה
אפליקציית Chat מבוססת על Google Apps Script ומשתמשת באירועי אינטראקציה כדי לעבד את המידע של משתמשי Chat ולהשיב להם.
בדוגמה הבאה אפשר לראות איך משתמשים בדרך כלל מקיימים אינטראקציה עם אפליקציית Chat:
משתמש פותח צ'אט ישיר עם אפליקציית Chat, או מוסיף את אפליקציית Chat למרחב קיים.
אפליקציית Chat מציגה למשתמש טופס ליצירת קשר כדי להוסיף איש קשר, כשהטופס בנוי כ
card
אובייקט. כדי להציג את הטופס ליצירת קשר, אפליקציית Chat מגיבה למשתמשים בדרכים הבאות:- מגיב לאזכורי @ולהודעות בצ'אט ישיר עם הודעה בכרטיס שמכילה את טופס יצירת הקשר.
- מגיב לפקודת הלוכסן
/addContact
על ידי פתיחת תיבת דו-שיח עם טופס יצירת הקשר. - מגיב לפקודת הלוכס
/about
בהודעת טקסט עם הכפתור הוספת איש קשר, שמשתמשים יכולים ללחוץ עליו כדי לפתוח תיבת דו-שיח עם טופס יצירת הקשר.
כשמוצג למשתמש טופס ליצירת קשר, הוא מזין את הפרטים ליצירת קשר בשדות ובווידג'טים הבאים:
- השם הפרטי ושם המשפחה: ווידג'ט
textInput
שמקבל מחרוזות. - תאריך לידה: ווידג'ט
dateTimePicker
שמקבל רק תאריכים. - סוג איש הקשר: ווידג'ט של לחצני בחירה שמאפשר למשתמשים לבחור ולהגיש ערך מחרוזת יחיד (
Personal
אוWork
).selectionInput
- הלחצן בדיקה ושליחה: מערך
buttonList
עם ווידג'טbutton
שהמשתמש לוחץ עליו כדי לשלוח את הערכים שהוא מזין.
- השם הפרטי ושם המשפחה: ווידג'ט
אפליקציית Google Chat מטפלת ב
CARD_CLICKED
אירוע אינטראקציה כדי לעבד את הערכים שהמשתמש מזין, ומציגה את הערכים בכרטיס אישור.המשתמש בודק את כרטיס האישור ולוחץ על הלחצן שליחה כדי לסיים את הזנת הפרטים ליצירת קשר.
אפליקציית Google Chat שולחת הודעת טקסט פרטית שמאשרת את השליחה.
הכנת הסביבה
בקטע הזה מוסבר איך ליצור ולהגדיר פרויקט ב-Google Cloud לאפליקציית Chat.
יצירת פרויקט של Google Cloud
מסוף Google Cloud
- במסוף Google Cloud, עוברים אל תפריט > IAM & Admin > Create a Project (יצירת פרויקט).
-
בשדה Project Name (שם הפרויקט), מזינים שם תיאורי לפרויקט.
אופציונלי: כדי לערוך את מזהה הפרויקט, לוחצים על עריכה. אי אפשר לשנות את מזהה הפרויקט אחרי שהוא נוצר, לכן חשוב לבחור מזהה שיענה על הצרכים שלכם למשך כל חיי הפרויקט.
- בשדה Location, לוחצים על Browse כדי להציג מיקומים אפשריים לפרויקט. אחר כך לוחצים על בחירה.
- לוחצים על יצירה. מערכת Google Cloud מעבירה אתכם לדף Dashboard והפרויקט נוצר תוך כמה דקות.
CLI של gcloud
באחת מסביבות הפיתוח הבאות, ניגשים אל Google Cloud CLI (gcloud
):
-
Cloud Shell: כדי להשתמש בטרמינל אונליין שבו כבר מוגדר ה-CLI של gcloud, צריך להפעיל את Cloud Shell.
הפעלת Cloud Shell -
מעטפת מקומית: כדי להשתמש בסביבת פיתוח מקומית צריך להתקין ולהפעיל את ה-CLI של gcloud.
כדי ליצור פרויקט ב-Cloud, משתמשים בפקודהgcloud projects create
: מחליפים את PROJECT_ID במזהה של הפרויקט שרוצים ליצור.gcloud projects create PROJECT_ID
הגדרת אימות והרשאה
כדי להשתמש באפליקציות ב-Google Chat, צריך להגדיר מסך הסכמה ל-OAuth כדי שהמשתמשים יוכלו לאשר את האפליקציה באפליקציות של Google Workspace, כולל Google Chat.
במדריך הזה, אתם פורסים אפליקציית Chat שנועדה רק לבדיקה ולשימוש פנימי, ולכן אפשר להשתמש במידע של placeholder במסך בקשת ההסכמה. לפני שמפרסמים את האפליקציה ל-Chat, צריך להחליף את כל נתוני ה-placeholder בנתונים אמיתיים.
במסוף Google Cloud, נכנסים לתפריט
> > Branding.אם כבר הגדרתם את , תוכלו להגדיר את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטע מיתוג, קהל וגישה לנתונים. אם מופיעה ההודעה עדיין לא הוגדר, לוחצים על תחילת העבודה:
- בקטע App Information (פרטי האפליקציה), בשדה App name (שם האפליקציה), מקלידים
Contact Manager
. - בקטע User support email (כתובת אימייל לתמיכה במשתמשים), בוחרים את כתובת האימייל או קבוצת Google המתאימה.
- לוחצים על הבא.
- בקטע קהל, בוחרים באפשרות פנימי. אם אי אפשר לבחור באפשרות פנימי, בוחרים באפשרות חיצוני.
- לוחצים על הבא.
- בקטע פרטים ליצירת קשר, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
- לוחצים על הבא.
- בקטע סיום, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה אני מסכים/ה למדיניות של Google בנושא נתוני משתמשים בשירותי API.
- לוחצים על המשך.
- לוחצים על יצירה.
- אם בחרתם באפשרות חיצוני לסוג המשתמש, מוסיפים משתמשי בדיקה:
- לוחצים על קהל.
- בקטע משתמשי בדיקה, לוחצים על הוספת משתמשים.
- מזינים את כתובת האימייל שלכם ושל משתמשים מורשים אחרים לבדיקה, ואז לוחצים על שמירה.
- בקטע App Information (פרטי האפליקציה), בשדה App name (שם האפליקציה), מקלידים
יצירה ופריסה של אפליקציה ל-Chat
בקטע הבא, מעתיקים ומעדכנים פרויקט שלם בסקריפט של Google Apps שמכיל את כל קוד האפליקציה הנדרש לאפליקציית Chat, כך שאין צורך להעתיק ולהדביק כל קובץ בנפרד.
אם רוצים, אפשר לראות את הפרויקט כולו ב-GitHub.
סקירה כללית של כל קובץ:
main.gs
מטפל בכל הלוגיקה של האפליקציה, כולל אירועי אינטראקציה שקשורים למקרים שבהם משתמשים שולחים הודעות לאפליקציית Chat, לוחצים על לחצנים בהודעה מאפליקציית Chat או פותחים וסוגרים תיבות דו-שיח.
הצגת הקוד
main.gs
contactForm.gs
מכיל את הווידג'טים שמקבלים נתוני טופס מהמשתמשים. ווידג'טים של קלט לטופס מוצגים בכרטיסים שמופיעים בהודעות ובתיבות דו-שיח.
הצגת הקוד
contactForm.gs
appsscript.json
מניפסט של Apps Script שמגדיר ומגדיר את פרויקט Apps Script עבור אפליקציית Chat.
הצגת הקוד
appsscript.json
איך מוצאים את מספר הפרויקט ואת מזהה הפרויקט ב-Cloud
במסוף Google Cloud, נכנסים לפרויקט ב-Cloud.
לוחצים על סמל ההגדרות והכלים > הגדרות הפרויקט.
שימו לב לערכים בשדות מספר הפרויקט ומזהה הפרויקט. משתמשים בהם בקטעים הבאים.
יצירת פרויקט Apps Script
כדי ליצור פרויקט Apps Script ולקשר אותו לפרויקט Cloud:
- לוחצים על הלחצן הבא כדי לפתוח את פרויקט Apps Script Manage contacts in Google Chat (ניהול אנשי קשר ב-Google Chat).
פתיחת הפרויקט - לוחצים על סקירה כללית.
- בדף הסקירה הכללית, לוחצים על
יצירת עותק.
נותנים שם לעותק של פרויקט Apps Script:
לוחצים על עותק של ניהול אנשי קשר ב-Google Chat.
בשדה שם הפרויקט, כותבים
Contact Manager - Google Chat app
.לוחצים על Rename.
הגדרת פרויקט Cloud לפרויקט Apps Script
- בפרויקט Apps Script, לוחצים על
הגדרות הפרויקט.
- בקטע פרויקט Google Cloud Platform (GCP), לוחצים על שינוי הפרויקט.
- בקטע מספר הפרויקט ב-GCP, מדביקים את מספר הפרויקט ב-Cloud.
- לוחצים על הגדרת פרויקט. הפרויקט ב-Cloud והפרויקט ב-Apps Script מקושרים עכשיו.
יצירת פריסה של Apps Script
אחרי שכל הקוד מוכן, פורסים את פרויקט Apps Script. משתמשים במזהה הפריסה כשמגדירים את אפליקציית Chat ב-Google Cloud.
ב-Apps Script, פותחים את הפרויקט של אפליקציית Chat.
לוחצים על פריסה > פריסה חדשה.
אם האפשרות תוסף לא נבחרה אוטומטית, לוחצים על סוגי הפריסה
לצד בחירת סוג ובוחרים באפשרות תוסף.
בשדה תיאור, מזינים תיאור לגרסה הזו, כמו
Test of Contact Manager
.לוחצים על פריסה. Apps Script מדווח על פריסה מוצלחת ומספק מזהה פריסה.
לוחצים על
העתקה כדי להעתיק את מזהה הפריסה ואז לוחצים על סיום.
הגדרת אפליקציית Chat במסוף Google Cloud
בקטע הזה נסביר איך להגדיר את Google Chat API במסוף Google Cloud עם מידע על אפליקציית Chat, כולל מזהה הפריסה שיצרתם זה עתה מפרויקט Apps Script.
במסוף Google Cloud, לוחצים על תפריט > מוצרים נוספים > Google Workspace > ספריית מוצרים > Google Chat API > ניהול > הגדרה.
בשדה App name, כותבים
Contact Manager
.בקטע כתובת ה-URL של הדמות, מקלידים
https://developers.google.com/chat/images/contact-icon.png
.בקטע תיאור, מקלידים
Manage your personal and business contacts
.מעבירים את המתג הפעלה של תכונות אינטראקטיביות למצב פעיל.
בקטע פונקציונליות, בוחרים באפשרות הצטרפות למרחבים ולשיחות קבוצתיות.
בקטע הגדרות חיבור, בוחרים באפשרות Apps Script.
בקטע Deployment ID (מזהה פריסה), מדביקים את מזהה הפריסה של Apps Script שהועתק בקטע הקודם כשיוצרים את פריסת Apps Script.
בקטע Commands (פקודות), מגדירים את הפקודות דרך שורת הפקודות
/about
ו-/addContact
:- לוחצים על הוספת פקודה דרך שורת הפקודות כדי להגדיר את הפקודה הראשונה דרך שורת הפקודות.
- בשדה Name, כותבים
About
. - בשדה Command ID (מזהה הפקודה), מקלידים
1
. - בקטע תיאור, מקלידים
Learn how to use this Chat app to manage your contacts
. - בקטע סוג הפקודה, בוחרים באפשרות
Slash command
. - בשדה Slash command name, כותבים
/about
. - בוחרים באפשרות הקישור פותח תיבת דו-שיח.
- לוחצים על סיום.
- כדי להגדיר עוד פקודה דרך שורת הפקודות, לוחצים על הוספת פקודה.
- בשדה Name, כותבים
Add a contact
. - בשדה Command ID (מזהה הפקודה), מקלידים
2
. - בקטע תיאור, מקלידים
Submit information about a contact
. - בקטע סוג הפקודה, בוחרים באפשרות
Slash command
. - בשדה Slash command name, כותבים
/addContact
. - בוחרים באפשרות הקישור פותח תיבת דו-שיח.
- לוחצים על סיום.
בקטע חשיפה, מסמנים את התיבה הפיכת אפליקציית Chat הזו לזמינה לאנשים ולקבוצות ספציפיים ב-YOUR DOMAIN ומזינים את כתובת האימייל.
בקטע יומנים, בוחרים באפשרות רישום שגיאות ביומן.
לוחצים על שמירה. תוצג הודעה שההגדרה נשמרה.
אפשר להתקין את האפליקציה של Chat ולבדוק אותה ב-Chat.
בדיקת אפליקציית Chat
כדי לבדוק את אפליקציית Chat, פותחים מרחב לצ'אט ישיר עם אפליקציית Chat ושולחים הודעה:
פותחים את Google Chat באמצעות חשבון Google Workspace שציינתם כשנוספתם כבודקים מהימנים.
- לוחצים על צ'אט חדש.
- בשדה הוספת אדם אחד או יותר, מקלידים את השם של אפליקציית Chat.
בוחרים את אפליקציית Chat מתוך התוצאות. ייפתח צ'אט ישיר.
בצ'אט ישיר חדש עם אפליקציית Chat, כותבים
/addContact
ומקישים על Enter.בתיבת הדו-שיח שנפתחת, מזינים את הפרטים ליצירת קשר:
- בתיבת הטקסט שם פרטי ושם משפחה, מזינים שם.
- בכלי לבחירת תאריך תאריך לידה, בוחרים תאריך.
- בקטע סוג הקשר, בוחרים בלחצן האפשרויות עבודה או אישי.
לוחצים על בדיקה ושליחה.
בתיבת הדו-שיח לאישור, בודקים את המידע ששלחתם ולוחצים על שליחה. אפליקציית Chat עונה בהודעת טקסט עם הכיתוב
✅ CONTACT NAME has been added to your contacts.
.אפשר גם לבדוק ולשלוח את טופס יצירת הקשר בדרכים הבאות:
- משתמשים בפקודת הסלאש
/about
. התשובה של אפליקציית הצ'אט היא הודעת טקסט עם לחצן של ווידג'ט אביזר שכתוב עליוAdd a contact
. אפשר ללחוץ על הלחצן כדי לפתוח תיבת דו-שיח עם טופס יצירת הקשר. - שולחים לאפליקציית Chat הודעה בצ'אט ישיר בלי להשתמש בפקודת לוכסן, כמו
Hello
. אפליקציית Chat תשיב עם טקסט וכרטיס שמכילים את הטופס ליצירת קשר.
- משתמשים בפקודת הסלאש
הסרת המשאבים
כדי להימנע מחיובים בחשבון Google Cloud בגלל השימוש במשאבים שנעשה במסגרת המדריך הזה, מומלץ למחוק את פרויקט Cloud.
- במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט > IAM & Admin > Manage Resources.
- ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete .
- כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.
נושאים קשורים
- תגובה לפקודות
- איסוף ועיבוד מידע ממשתמשי Google Chat
- פתיחת תיבות דו-שיח אינטראקטיביות
- דוגמאות נוספות לאפליקציות ל-Google Chat