יצירת אפליקציה של Google Chat באמצעות Google Apps Script

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

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

התרשים הבא מציג את הארכיטקטורה ואת תבנית ההודעות:

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

1. משתמש שולח הודעה לאפליקציית Chat, בצ'אט אישי או במרחב משותף ב-Chat.
2. הלוגיקה של אפליקציית Chat שמוטמעת ב-Apps Script, שנמצא ב-Google Cloud, מקבלת את ההודעה ומעבדת אותה.
3. אפשר גם לשלב את הלוגיקה של אפליקציית Chat עם שירותי Google Workspace, כמו Calendar או Sheets, או עם שירותי Google אחרים, כמו מפות Google או YouTube.
4. הלוגיקה של אפליקציית Chat שולחת תשובה בחזרה לשירות של אפליקציית Chat ב-Chat.
5. התשובה מועברת למשתמש.

מטרות

• מגדירים את הסביבה.
• מגדירים את הסקריפט.
• מגדירים תוסף של Google Workspace לאפליקציית Chat.
• בודקים את אפליקציית Chat.

דרישות מוקדמות

• חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
• פרויקט ב-Google Cloud. במאמר יצירת פרויקט ב-Google Cloud מוסבר איך יוצרים פרויקט.

הגדרת הסביבה

פתיחת הפרויקט ב-Cloud במסוף Google Cloud

אם הוא עדיין לא פתוח, פותחים את פרויקט Cloud שבו רוצים להשתמש לדוגמה הזו:

1. נכנסים לדף Select a project במסוף Google Cloud.

   בחירת פרויקט ב-Cloud

2. בוחרים את הפרויקט ב-Google Cloud שבו רוצים להשתמש. לחלופין, לוחצים על Create project (יצירת פרויקט) ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שתצטרכו להפעיל את החיוב בפרויקט.

הפעלת Chat API

לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.

• במסוף Google Cloud, מפעילים את Google Chat API.

  להפעלת ה-API

הגדרת מסך ההסכמה של OAuth

כל האפליקציות שמשתמשות ב-OAuth 2.0 מחייבות הגדרה של מסך הסכמה. הגדרת מסך ההסכמה ל-OAuth של האפליקציה קובעת מה יוצג למשתמשים ולבודקים של האפליקציה, ומרשמת את האפליקציה כדי שתוכלו לפרסם אותה מאוחר יותר.

1. במסוף Google Cloud, נכנסים לתפריט menu > APIs & Services > OAuth consent screen.

   מעבר למסך ההסכמה של OAuth

2. בקטע User type בוחרים באפשרות Internal ולוחצים על Create.
3. ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.

4. בשלב הזה, אפשר לדלג על הוספת היקפי הרשאה וללחוץ על Save and Continue (שמירה והמשך). בעתיד, כשיוצרים אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, צריך לשנות את סוג המשתמש ל-חיצוני, ואז להוסיף את היקפי ההרשאה הנדרשים לאפליקציה.

5. בודקים את סיכום רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרשמת האפליקציה נראית תקינה, לוחצים על Back to Dashboard.

הגדרת הסקריפט

כדי להגדיר את הסקריפט, יוצרים עותק של פרויקט המדריך למתחילים ואז מגדירים את פרויקט Cloud ב-Apps Script.

יצירת עותק של פרויקט המדריך למתחילים

1. לוחצים על הלחצן הבא כדי לפתוח את הפרויקט של סקריפט Google Apps של התוסף ב-Google Chat.
   פתיחת הפרויקט
2. לוחצים על info_outline סקירה כללית.
3. בדף הסקירה הכללית, לוחצים על יצירת עותק.

4. נותנים שם להעתקה של פרויקט Apps Script:

   1. לוחצים על עותק של אפליקציית Chat.

   2. בשדה Project title, מקלידים Add-on Chat app.

   3. לוחצים על Rename.

מעתיקים את מספר הפרויקט ב-Cloud

1. במסוף Google Cloud, נכנסים לתפריט menu > IAM & Admin > Settings.

   כניסה לדף IAM & Admin

2. בשדה Project number, מעתיקים את הערך.

הגדרת הפרויקט ב-Cloud של פרויקט Apps Script

1. בפרויקט Apps Script של אפליקציית Chat, לוחצים על Project Settings (הגדרות הפרויקט) .
2. בקטע פרויקט Google Cloud Platform ‏ (GCP), לוחצים על שינוי פרויקט.
3. בשדה GCP project number, מדביקים את מספר הפרויקט ב-Google Cloud.
4. לוחצים על Set project.

עכשיו יש לכם קוד אפליקציה פעיל שתוכלו לנסות (כפי שמתואר בשלבים הבאים) ואז להתאים אישית בהתאם לדרישות שלכם.

כשפותחים את הפרויקט ב-Apps Script, חשוב לוודא שנכנסתם לחשבון Google הנכון. לפעמים החשבון הנוכחי עובר לחשבון ברירת המחדל בלי שתבחינו בכך.

יצירת פריסה לבדיקה

עליכם לקבל מזהה פריסה של פרויקט Apps Script הזה כדי שתוכלו להשתמש בו בשלב הבא.

כדי לקבל את מזהה הפריסה הראשית:

1. בפרויקט Apps Script של אפליקציית Chat, לוחצים על פריסה > בדיקת פריסות.
2. מעתיקים את מזהה הפריסה הראשית לשימוש בשלב מאוחר יותר ולוחצים על Done (סיום).

הגדרת התוסף

בעזרת הפריסה של Apps Script, פועלים לפי השלבים הבאים כדי ליצור תוסף ולפרוס את אפליקציית Google Chat:

1. במסוף, מחפשים את Google Chat API ולוחצים על Google Chat API.
2. לוחצים על ניהול.

3. לוחצים על Configuration (הגדרה) ומגדירים את אפליקציית Chat:

   1. בשדה App name, מזינים Add-on Chat app.
   2. בשדה כתובת ה-URL של הדמות, מזינים את הערך https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. בשדה Description מזינים Add-on Chat app.
   4. בקטע פונקציונליות, בוחרים באפשרויות קבלת הודעות בצ'אט אישי והצטרפות למרחבים משותפים ולשיחות קבוצתיות.
   5. בקטע 'הגדרות החיבור', בוחרים באפשרות פרויקט Apps Script.
   6. בשדה Deployment ID מדביקים את מזהה הפריסה של Head שהעתקתם מקודם.
   7. בקטע 'חשיפה', בוחרים באפשרות אנשים וקבוצות ספציפיים בדומיין ומזינים את כתובת האימייל.

4. לוחצים על שמירה.

אפליקציית Chat מוכנה להגיב להודעות.

בדיקת אפליקציית Chat

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

1. פותחים את Google Chat באמצעות חשבון Google Workspace שסיפקתם כשהוספת את עצמכם כבודקים מהימנים.

   כניסה ל-Google Chat

2. לוחצים על add צ'אט חדש.
3. בשדה Add 1 or more people, מקלידים את שם אפליקציית Chat.

4. בוחרים את אפליקציית Chat בתוצאות. ייפתח צ'אט אישי.

5. בצ'אט האישי החדש עם האפליקציה, מקלידים Hello ומקישים על enter.

   אפליקציית Chat תודיע לכם על ההוספה ותשלח את ההודעה שלכם.

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

פתרון בעיות

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

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

הסרת המשאבים

כדי להימנע מחיובים בחשבון Google Cloud בגלל השימוש במשאבים שנעשה במסגרת המדריך הזה, מומלץ למחוק את הפרויקט ב-Cloud.

1. במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט menu > IAM & Admin > Manage Resources.

   כניסה ל-Resource Manager

2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete delete.
3. כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.