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

בדף הזה מוסבר איך ליצור תוסף ל-Google Workspace שפועל ב-Google Chat באמצעות Google Apps Script.

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

אפליקציית Chat מאפשרת לכם לשלוח הודעות ישירות ולקבל תשובות באמצעות חזרה על ההודעות שלכם.

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

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

1. משתמש שולח הודעה לאפליקציית Chat, בצ'אט ישיר או במרחב ב-Chat.
2. הלוגיקה של אפליקציית Chat, שמוטמעת ב-Apps Script, שמאוחסן ב-Google Cloud, מקבלת ומעבדת את ההודעה.
3. אופציונלית, הלוגיקה של אפליקציית Chat יכולה להשתלב עם שירותי Google Workspace, כמו יומן או גיליונות אלקטרוניים, או עם שירותים אחרים של 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 API, אם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.

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

להפעלת ה-API

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

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

1. במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Branding.

   מעבר לדף Branding

2. אם כבר הגדרתם את Google Auth platform, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים Branding,‏ Audience וData Access. אם מופיעה ההודעה Google Auth platform not configured yet, לוחצים על Get Started:
1. בקטע App Information בשדה App name, מזינים שם לאפליקציה.
2. בקטע User support email, בוחרים כתובת אימייל לתמיכה שאליה משתמשים יפנו אם יש להם שאלות לגבי ההסכמה שלהם.
3. לוחצים על Next.
4. בקטע Audience, לוחצים על Internal.
5. לוחצים על Next.
6. בקטע Contact Information, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
7. לוחצים על Next.
8. בקטע Finish, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה I agree to the Google API Services: User Data Policy.
9. לוחצים על Continue.
10. לוחצים על Create.
3. כרגע אתם יכולים לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, תצטרכו לשנות את סוג המשתמש ל-External. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.

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

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

יצירת פרויקט Apps Script

1. בדף Getting Started (תחילת העבודה) של Apps Script, עוברים אל Add-on starters (תבניות התחלה של תוספים) ולוחצים על התבנית Chat app (אפליקציית Chat):

   פתיחת תבנית של אפליקציית Chat

2. בפרויקט החדש של Apps Script שנפתח, נותנים שם לפרויקט:

   1. לוחצים על פרויקט ללא שם.

   2. בשדה שם הפרויקט, כותבים Add-on Chat app.

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

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

1. במסוף Google Cloud, לוחצים על סמל התפריט > IAM & Admin ‏> Settings.

   כניסה לדף IAM & Admin Settings

2. מעתיקים את הערך בשדה מספר הפרויקט.

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

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

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

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

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

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

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

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

הגדרת התוסף

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

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

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

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

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

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

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

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

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

   מעבר אל Google Chat

2. לוחצים על צ'אט חדש.
3. בשדה הוספת אדם אחד או יותר, מקלידים את השם של אפליקציית Chat.

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

   הערה: אם אפליקציית Chat לא מופיעה ברשימת התוצאות, צריך לוודא שחשבון Google Workspace נכלל בהגדרות Visibility בדף Chat API Configuration במסוף Google Cloud.

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

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

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

פתרון בעיות

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

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

הסרת המשאבים

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

זהירות: כשמוחקים פרויקט:

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

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

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

   כניסה ל-Resource Manager

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