מדריך למתחילים: אפליקציית צ'אט של 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. נכנסים לדף 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. לבדוק את הסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרישום של האפליקציה נראה בסדר, לוחצים על Back to Dashboard (חזרה למרכז השליטה).

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

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

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

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

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

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

    כניסה לדף IAM & Admin Settings

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

הגדרת הפרויקט בענן של פרויקט 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.

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

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

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

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

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

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

פתרון בעיות

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

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

הסרת המשאבים

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

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

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

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

השלבים הבאים

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