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

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

    כניסה למסך ההסכמה ל-OAuth

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

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

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

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

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

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

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

  1. נכנסים לפרויקט ב-Cloud במסוף Google Cloud.
  2. לוחצים על 'הגדרות ושירותים' > הגדרות פרויקט.
  3. מעתיקים את מספר הפרויקט.

הגדרה של הפרויקט ב-Cloud עבור פרויקט Apps Script

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

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

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

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

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

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

  1. בפרויקט Apps Script של הפרויקט, לוחצים על פריסה > פריסות לבדיקה.
  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 project כדי להדביק את מזהה הפריסה בשדה.
    6. בקטע Permissions, בוחרים באפשרות ספציפיות לקבוצות ספציפיות בדומיין ומזינים את כתובת האימייל.
  4. לוחצים על שמירה ומרעננים את הדף.

  5. בדף ההגדרות, עוברים לסטטוס App status כדי להגדיר את סטטוס Live - available to users.

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

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

הרצת הסקריפט

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

האפליקציה מודים לך על שהוספת את ההודעה והדהוד אותה.

השלבים הבאים

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