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

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

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

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

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

מטרות

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

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

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

הגדרת הסביבה

פתיחת פרויקט בענן במסוף Google Cloud

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

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

   בחירת פרויקט בענן

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

הפעלת Chat API

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

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

  להפעלת ה-API

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

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

1. ב-Google API Console, נכנסים לתפריט > Google Auth platform > Branding.

   מעבר לדף Branding

2. אם כבר הגדרתם את פלטפורמת האימות של Google, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-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 מהדף Getting Started ב-Apps Script.

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

1. בדף תחילת העבודה של Apps Script, עוברים אל חבילות הבסיס של תוספים ל-Google Workspace ולוחצים על התבנית אפליקציית Chat:

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

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

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

   2. בשדה Project title, כותבים Quickstart app.

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

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

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

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

כדי לקבל את מזהה הפריסה הראשית, מבצעים את הפעולות הבאות:

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

הגדרת אפליקציית Chat

כדי להגדיר את אפליקציית Google Chat:

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

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

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

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

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

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

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

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

   מעבר אל Google Chat

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

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

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

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

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

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

פתרון בעיות

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

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

הסרת המשאבים

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

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

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

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

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

   כניסה ל-Resource Manager

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

השלבים הבאים

• יצירת כרטיסים אינטראקטיביים – הודעות בכרטיסים תומכות בפריסה מוגדרת, ברכיבי ממשק משתמש אינטראקטיביים כמו לחצנים ובמדיה עשירה כמו תמונות. אפשר להשתמש בהודעות בכרטיסים כדי להציג מידע מפורט, לאסוף מידע מהמשתמשים ולהנחות אותם לגבי השלב הבא.
• תגובה לפקודות – פקודות עוזרות למשתמשים לגלות תכונות מרכזיות של אפליקציית Chat ולהשתמש בהן.
• הפעלת תיבות דו-שיח – תיבות דו-שיח הן ממשקים מבוססי-כרטיסים שמוצגים בחלון, והאפליקציה יכולה לפתוח אותם כדי ליצור אינטראקציה עם המשתמש. אפשר לצרף כמה כרטיסים אחד אחרי השני, וכך לעזור למשתמשים להשלים תהליכים מרובי-שלבים, כמו מילוי נתונים בטופס.
• שיעור Codelab: רוצים ליצור אפליקציית צ'אט מתקדמת יותר? אפשר לראות את המשוב באפליקציית הצ'אט מתוך ה-codelab פיתוח אפליקציות ל-Google Chat עם Gemini.

אפליקציות ל-Chat שהן לא תוספים: פיתוח אפליקציה ל-Google Chat באמצעות Google Apps Script

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

יצירת הסקריפט מהתבנית

1. עוברים אל הדף תחילת העבודה עם Apps Script.
2. לוחצים על התבנית Chat App (אפליקציית צ'אט) בחלק העליון של הדף.

3. לוחצים על Untitled project, מקלידים Quickstart app ולוחצים על Rename.

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

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

5. מעתיקים את מזהה הפריסה של Head לשימוש בשלב הבא ולוחצים על סיום.

הגדרת אפליקציית Chat שאינה תוסף

כדי להגדיר את אפליקציית Chat שלא מופיעה כתוסף ב-קונסולה לממשקי API:

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

3. לוחצים על הגדרה ומגדירים את אפליקציית Chat שאינה תוסף:

   1. מבטלים את הסימון של Build this Chat app as a Google Workspace add-on (פיתוח אפליקציית Chat כתוסף ל-Google Workspace). תיפתח תיבת דו-שיח שבה תתבקשו לאשר את הפעולה. בתיבת הדו-שיח, לוחצים על השבתה.
   2. בשדה App name, מזינים Quickstart app.
   3. בשדה כתובת ה-URL של האווטאר מזינים את הערך https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
   4. בשדה Description (תיאור) מזינים Quickstart app.
   5. בקטע פונקציונליות, בוחרים באפשרות הצטרפות למרחבים ולשיחות קבוצתיות.
   6. בקטע הגדרות חיבור, בוחרים באפשרות Apps Script.
   7. בשדה Deployment ID (מזהה הפריסה), מדביקים את מזהה הפריסה של Head שהעתקתם קודם.
   8. בקטע חשיפה, בוחרים באפשרות אנשים ספציפיים וקבוצות ספציפיות בדומיין ומזינים את כתובת האימייל.

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