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

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

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

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

בתרשים שלמעלה, משתמש שמבצע אינטראקציה עם אפליקציית 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.

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

הגדרת הסביבה

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

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

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

    בחירת פרויקט ב-Cloud

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

איך מפעילים את Chat API

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

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

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

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

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

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

  5. אם בחרתם בסוג המשתמש חיצוני, מוסיפים משתמשי בדיקה:
    1. בקטע משתמשים לבדיקה, לוחצים על הוספת משתמשים.
    2. מזינים את כתובת האימייל שלכם ומשתמשים מורשים אחרים לבדיקה, ואז לוחצים על Save and Continue (שמירה והמשך).
  6. בודקים את סיכום הרישום של האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם נראה שהרישום של האפליקציה תקין, לוחצים על חזרה למרכז השליטה.

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

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

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

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

העתקת מספר הפרויקט בענן

  1. נכנסים לפרויקט Cloud במסוף Google Cloud.
  2. לוחצים על Settings and Utilities > Project settings (הגדרות פרויקט).
  3. מעתיקים את מספר הפרויקט.

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

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

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

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

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

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

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

  1. בפרויקט Apps Script של אפליקציית Chat, לוחצים על פריסה > בדיקת פריסות.
  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. בקטע Connection settings (הגדרות החיבור), בוחרים באפשרות Apps Script (פרויקט Apps Script) ומדביקים את מזהה הפריסה בשדה.
    6. בקטע 'חשיפה', בוחרים באפשרות אנשים וקבוצות ספציפיים בדומיין ומזינים את כתובת האימייל.

  4. לוחצים על שמירה ומרעננים את הדף.

  5. בדף ההגדרות, בקטע App status (סטטוס האפליקציה), מגדירים את הסטטוס ל-Live - available to users.

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

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

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

  1. פותחים את Chat.
  2. כדי לשלוח צ'אט אישי חדש עם האפליקציה, לוחצים על התחלת צ'אט > חיפוש אפליקציות.
  3. בדף 'חיפוש אפליקציות', מחפשים את Quickstart App.
  4. ליד אפליקציה למתחילים, לוחצים על צ'אט.
  5. בצ'אט האישי החדש עם האפליקציה, מקלידים Hello ומקישים על enter.

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

השלבים הבאים

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