מדריך למתחילים: אפליקציית צ'אט של Google Apps Script

אתם יכולים ליצור אפליקציה של Google 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 עם גישה ל-Chat.
• פרויקט ב-Google Cloud.

הגדרת הסביבה

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

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

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

   בחירת פרויקט ב-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, נכנסים לתפריט > APIs & Services > מסך ההסכמה של OAuth.

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

2. בקטע סוג המשתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.
3. ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.

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

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

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

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

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

1. נכנסים לדף Apps Script Getting Started (תחילת העבודה).
2. לוחצים על התבנית של אפליקציית Chat. יכול להיות שתצטרכו לגלול למטה כדי לראות את התבנית הזו.
3. לוחצים על Untitled project, מקלידים Quickstart app ולוחצים על Rename.

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

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

   לדף IAM & Admin Settings

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

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

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

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

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

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

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

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

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

פרסום האפליקציה של Chat

לפרסם את אפליקציית Chat ממסוף Google Cloud.

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

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

   1. בשדה שם האפליקציה, מזינים Quickstart app.
   2. בשדה Avatar URL, מזינים https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. בשדה תיאור, מזינים 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. כותבים את השם של אפליקציית 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 ואדמין > ניהול משאבים.

   כניסה למנהל המשאבים

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

השלבים הבאים

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