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

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

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

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

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

מטרות

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

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

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

הגדרת הסביבה

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

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

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

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

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, נכנסים לתפריט menu > פלטפורמת האימות של Google > מיתוג.

   מעבר לדף Branding

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

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

1. בדף Getting Started של Apps Script, עוברים לקטע Google Workspace add-on starters ולוחצים על התבנית Chat app:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   מעבר אל Google Chat

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

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

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

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

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

פתרון בעיות

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

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

הסרת המשאבים

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

1. ב-Google API Console, נכנסים לדף Manage resources. לוחצים על Menu menu > IAM & Admin > Manage Resources.

   כניסה ל-Resource Manager

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

השלבים הבאים

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