במדריך הזה נסביר איך בונים אפליקציית Google Chat שעוזרת למשתמשי Google Chat לנהל את אנשי הקשר האישיים והעסקיים שלהם. כדי לאסוף מידע, באפליקציית Chat מופיעה בקשה למשתמשים למלא טופס ליצירת קשר בהודעות בכרטיסים ובתיבות דו-שיח.
צפייה באפליקציית Chat בפעולה:
-
איור 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
היא הודעת טקסט עם הלחצן Add a contact (הוספת איש קשר). המשתמשים יכולים ללחוץ על הלחצן כדי לפתוח תיבת דו-שיח עם טופס הקשר.
כשהמשתמש רואה את טופס יצירת הקשר, הוא מזין את פרטי הקשר בשדות ובווידג'טים הבאים:
- שם פרטי ושם משפחה: הווידג'ט
textInput
שמקבל מחרוזות. - Birthdate: הווידג'ט
dateTimePicker
שמקבל תאריכים בלבד. - סוג איש קשר: ווידג'ט של
selectionInput
עם לחצני בחירה שמאפשר למשתמשים לבחור ולשלוח ערך של מחרוזת יחידה (Personal
אוWork
). - הלחצן בדיקה ושליחה: מערך
buttonList
עם ווידג'טbutton
, שבו המשתמש לוחץ כדי לשלוח את הערכים שהזין.
- שם פרטי ושם משפחה: הווידג'ט
אפליקציית Google Chat מטפלת באירוע אינטראקציה מסוג
CARD_CLICKED
כדי לעבד את הערכים שהמשתמש מזין, ולהציג את הערכים בכרטיס אישור.המשתמש בודק את כרטיס האישור ולוחץ על הלחצן Submit כדי לסיים את הזנת הפרטים ליצירת קשר.
אפליקציית Google Chat שולחת הודעת טקסט פרטית לאישור שליחת הבקשה.
מכינים את הסביבה
בקטע הזה נסביר איך יוצרים ומגדירים פרויקט ב-Google Cloud לאפליקציית Chat.
יצירת פרויקט של Google Cloud
מסוף Google Cloud
- במסוף Google Cloud, עוברים לתפריט > IAM & Admin > Create a Project.
-
בשדה Project Name, מזינים שם תיאורי לפרויקט.
אופציונלי: כדי לערוך את Project ID, לוחצים על Edit. אי אפשר לשנות את מזהה הפרויקט אחרי יצירת הפרויקט, לכן חשוב לבחור מזהה שמתאים לצרכים שלכם לכל משך החיים של הפרויקט.
- בשדה Location, לוחצים על Browse כדי להציג מיקומים פוטנציאליים לפרויקט. לאחר מכן לוחצים על בחירה.
- לוחצים על יצירה. מסוף Google Cloud מנווט לדף Dashboard והפרויקט נוצר תוך כמה דקות.
CLI של gcloud
ניגשים ל-CLI של Google Cloud (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 לצורכי בדיקה ולשימוש פנימי בלבד, לכן מותר להשתמש במידע למעקב אחרי מקום פנוי במסך ההסכמה. לפני פרסום אפליקציית Chat, צריך להחליף את פרטי ה-placeholder במידע אמיתי.
במסוף Google Cloud, נכנסים אל תפריט > APIs & Services> OAuth consent screen.
בקטע סוג משתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.
בשדה App name, מקלידים
Contact Manager
.בקטע User support email, בוחרים את כתובת האימייל שלכם או קבוצת Google מתאימה.
בקטע פרטים ליצירת קשר עם המפתח, מזינים את כתובת האימייל שלכם.
לוחצים על שמירה והמשך.
בדף היקפים, לוחצים על שמירה והמשך. (אפליקציית Chat לא דורשת היקפי הרשאות OAuth).
מעיינים בסיכום ולוחצים על חזרה ללוח הבקרה.
יצירה ופריסה של אפליקציית Chat
בקטע הבא תעתיקו ותעדכנו פרויקט Apps Script שלם שמכיל את כל קוד האפליקציה הנדרש לאפליקציית 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.
לוחצים על סמל ההגדרות והכלים > הגדרות הפרויקט.
שימו לב לערכים בשדות Project number ו-Project ID. תוכלו להשתמש בהם בקטעים הבאים.
יצירת פרויקט Apps Script
כדי ליצור פרויקט Apps Script ולקשר אותו לפרויקט ב-Cloud:
- לוחצים על הלחצן הבא כדי לפתוח את פרויקט Apps Script ניהול אנשי קשר ב-Google Chat.
פתיחת הפרויקט - לוחצים על סקירה כללית.
- בדף הסקירה הכללית, לוחצים על יצירת עותק.
נותנים שם להעתקה של פרויקט Apps Script:
לוחצים על עותק של 'ניהול אנשי קשר ב-Google Chat'.
בשדה Project title, מקלידים
Contact Manager - Google Chat app
.לוחצים על Rename.
הגדרת הפרויקט ב-Cloud של פרויקט Apps Script
- בפרויקט של Apps Script, לוחצים על Project Settings.
- בקטע פרויקט Google Cloud Platform (GCP), לוחצים על שינוי פרויקט.
- בקטע מספר פרויקט GCP, מדביקים את מספר הפרויקט ב-Cloud.
- לוחצים על Set project (הגדרת פרויקט). הפרויקט ב-Cloud ופרויקט Apps Script מחוברים עכשיו.
יצירת פריסה של Apps Script
עכשיו, אחרי שכל הקוד מוכן, פורסים את הפרויקט ב-Apps Script. משתמשים במזהה הפריסה כשמגדירים את אפליקציית Chat ב-Google Cloud.
ב-Apps Script, פותחים את הפרויקט של אפליקציית Chat.
לוחצים על פריסה > פריסה חדשה.
אם האפשרות Add-on (תוסף) עדיין לא מסומנת, לוחצים על סמל סוגי הפריסה לצד Select type (בחירת סוג) ובוחרים באפשרות Add-on (תוסף).
בשדה Description, מזינים תיאור של הגרסה הזו, למשל
Test of Contact Manager
.לוחצים על פריסת. מערכת Apps Script תדווח על פריסת הסקריפט ותספק מזהה פריסת הסקריפט.
לוחצים על
Copy כדי להעתיק את מזהה הפריסה, ואז לוחצים על Done.
הגדרת אפליקציית 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
.מעבירים את המתג הפעלת תכונות אינטראקטיביות למצב פעיל.
בקטע Functionality, מסמנים את התיבות קבלת הודעות 1:1 והצטרפות למרחבים משותפים ולשיחות קבוצתיות.
בקטע הגדרות החיבור, בוחרים באפשרות Apps Script.
בשדה Deployment ID, מדביקים את מזהה הפריסה של Apps Script שהעתקתם בקטע הקודם כשיצרתם את הפריסה של Apps Script.
בקטע פקודות דרך שורת הפקודות, מגדירים את פקודות הלוכסן
/about
ו-/addContact
:- לוחצים על הוספת פקודה של שורת הפקודות כדי להגדיר את הפקודה הראשונה של הלוכסן.
- בשדה Name, מקלידים
/about
. - בשדה Command ID, מקלידים
1
. - בקטע תיאור, מקלידים
Learn how to use this Chat app to manage your contacts
. - בוחרים באפשרות פתיחת תיבת דו-שיח.
- לוחצים על סיום.
- לוחצים על הוספת פקודה דרך שורת הפקודות כדי להגדיר פקודה נוספת דרך שורת הפקודות.
- בשדה Name, מקלידים
/addContact
. - בשדה Command ID, מקלידים
2
. - בקטע תיאור, מקלידים
Submit information about a contact
. - בוחרים באפשרות פתיחה של תיבת דו-שיח.
- לוחצים על סיום.
בקטע חשיפה, מסמנים את התיבה האפליקציה הזו של Chat תהיה זמינה לאנשים ולקבוצות ספציפיים ב-YOUR DOMAIN ומזינים את כתובת האימייל שלכם.
בקטע יומנים, בוחרים באפשרות רישום שגיאות ביומן.
לוחצים על שמירה. תופיע ההודעה 'ההגדרה נשמרה'.
אפליקציית Chat מוכנה להתקנה ולבדיקה ב-Chat.
בדיקת אפליקציית Chat
כדי לבדוק את אפליקציית Chat, פותחים מרחב צ'אט אישי עם אפליקציית Chat ושולחים הודעה:
פותחים את Google Chat באמצעות חשבון Google Workspace שסיפקתם כשהוספת את עצמכם כבודקים מהימנים.
- לוחצים על צ'אט חדש.
- בשדה Add 1 or more people, מקלידים את שם אפליקציית Chat.
בוחרים את אפליקציית Chat בתוצאות. תיפתח צ'אט אישי.
בצ'אט האישי החדש עם אפליקציית Chat, מקלידים
/addContact
ומקישים על Enter.בתיבת הדו-שיח שנפתחת, מזינים את הפרטים ליצירת קשר:
- בשדה הטקסט First and last name, מזינים שם.
- בוחרים תאריך בחלונית לבחירת תאריך Birthdate.
- בקטע סוג הקשר, בוחרים בלחצן האפשרויות עבודה או אישי.
לוחצים על בדיקה ושליחה.
בתיבת הדו-שיח לאישור, בודקים את המידע ששלחת ולוחצים על שליחה. התשובה של אפליקציית Chat תופיע בהודעת טקסט עם הכיתוב
✅ CONTACT NAME has been added to your contacts.
.אפשר גם לבדוק ולשלוח את טופס יצירת הקשר בדרכים הבאות:
- משתמשים בפקודה
/about
. תשובות באפליקציית Chat עם הודעת טקסט ולחצן ווידג'ט של אביזר עם הכיתובAdd a contact
. אפשר ללחוץ על הלחצן כדי לפתוח תיבת דו-שיח עם טופס יצירת קשר. - שולחים לאפליקציית Chat הודעה בצ'אט אישי בלי להשתמש בפקודה עם קו נטוי, כמו
Hello
. אפליקציית Chat תגיב עם טקסט וכרטיס שמכיל את הטופס ליצירת קשר.
- משתמשים בפקודה
הסרת המשאבים
כדי להימנע מחיובים בחשבון Google Cloud בגלל השימוש במשאבים שנעשה במסגרת המדריך הזה, מומלץ למחוק את הפרויקט ב-Cloud.
- במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט > IAM & Admin > Manage Resources.
- ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete .
- כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.
נושאים קשורים
- תגובה לפקודות דרך שורת הפקודה
- איסוף ועיבוד מידע ממשתמשים ב-Google Chat
- פתיחת תיבות דו-שיח אינטראקטיביות
- דוגמאות נוספות לאפליקציות ל-Google Chat