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

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

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

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

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

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

מטרות

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

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

הגדרת הסביבה

פתיחת הפרויקט ב-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.

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

  1. במסוף Google Cloud, נכנסים לתפריט > ממשקי API ו Services (שירותים) > מסך ההסכמה של OAuth.

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

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

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

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

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

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

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

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

  1. במסוף Google Cloud, נכנסים לתפריט > IAM & אדמין > הגדרות.

    כניסה לדף IAM & הגדרות אדמין

  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 (פריסה) > בדיקת פריסות.
  2. מעתיקים את מזהה הפריסה הראשית לשימוש בשלב מאוחר יותר, ולוחצים על סיום.

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

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

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

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

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

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

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

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

    כניסה ל-Google Chat

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

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

    אפליקציית Chat מודה לך על ההד בהודעה שלך.

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

פתרון בעיות

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

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

הסרת המשאבים

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

  1. במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט > IAM & Admin (אדמין) > לניהול משאבים

    מעבר למנהל המשאבים

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

השלבים הבאים

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