הגדרת אפליקציה של Google Chat

בדף הזה נסביר איך להגדיר ולפרוס אפליקציית Google Chat בתור תוסף ל-Google Workspace.

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

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

HTTP

• חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
• יוצרים פרויקט ב-Google Cloud.
• מגדירים את מסך ההסכמה של OAuth.
• מפעילים את ממשקי ה-API הבאים של Google Workspace:
  • Google Chat API
  • Google Workspace Add-ons API
    אי אפשר להשתמש ב-Google Workspace Add-ons API כדי ליצור ולנהל פריסות של אפליקציית Chat. פרטים נוספים זמינים במאמר מגבלות ובעיות מוכרות.
• נקודת קצה מסוג HTTP שמארחת את ארכיטקטורת השירות של אפליקציית Chat.

Apps Script

• חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
• יוצרים פרויקט ב-Google Cloud.
• מגדירים את מסך ההסכמה של OAuth.
• מפעילים את Google Chat API.
• יוצרים פרויקט נפרד של Apps Script ומפעילים את שירות הצ'אט המתקדם.
• מגדירים את Chat במניפסט, על ידי הוספת האובייקט addons.chat וכל ההיקפים הנדרשים (oauthScopes) או הקידומות של כתובות ה-URL מסוג HTTPS (urlFetchWhitelist).

בחירת שם לתצוגה, תמונת פרופיל ותיאור לאפליקציית Chat

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

• אפשר להזכיר את אפליקציית Chat באמצעות @ כדי לצרף אותה למרחב משותף או לשלוח לה הודעה.
• מחפשים את האפליקציה של Chat ומתחילים צ'אט אישי. בתפריט Apps (אפליקציות), הצ'אטים האישיים מוצגים עם השם והסמל של אפליקציית Chat.
• בסרגל הכתיבה, המשתמשים יכולים לעיין באפליקציות של Chat ולראות את השם, הדמות והתיאור שלהם.

לפני שמגדירים אפליקציית Chat, צריך להכין את הפרטים הבאים:

שדה	תיאור	פורמט
שם האפליקציה	השם המוצג של אפליקציית Chat.	עד 25 תווים אלפאנומריים
כתובת ה-URL של הדמות	התמונה שמוצגת כדמות שלכם באפליקציית Chat.	כתובת URL מסוג HTTPS שמפנה לתמונה ריבועית של גרפיקה (PNG או JPEG). הגודל המומלץ הוא 256 על 256 פיקסלים או יותר.
תיאור	תיאור קצר של מטרת אפליקציית Chat.	עד 40 תווים אלפאנומריים

בקטע הבא יצוין המידע הזה בהגדרות התצורה ב-Chat API.

הגדרת אפליקציית Chat במסוף Google Cloud

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

1. נכנסים לדף Chat API במסוף Google Cloud ולוחצים על הדף Configuration:

   כניסה לדף ההגדרות של Chat API

2. בקטע Application info (פרטי האפליקציה), ממלאים את השדות App name (שם האפליקציה), Avatar URL (כתובת ה-URL של הדמות) ו-Description (תיאור).

3. בקטע תכונות אינטראקטיביות, מעבירים את המתג הפעלת תכונות אינטראקטיביות למצב מופעל ומבצעים את הפעולות הבאות:

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

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

      • להצטרף למרחבים משותפים ולשיחות קבוצתיות: המשתמשים יכולים להוסיף את אפליקציית Chat למרחבים משותפים עם כמה אנשים ולנהל אינטראקציה איתה.

   2. בקטע Connection settings (הגדרות החיבור), בוחרים את הארכיטקטורה שבה רוצים להשתמש כדי לקבל אובייקטים של אירועים מ-Chat:

      • כדי להשתמש בשירות HTTP, בוחרים באפשרות כתובת URL של נקודת קצה מסוג HTTP ומזינים כתובת URL.
      • כדי להשתמש בפרויקט של סקריפט של Google Apps, בוחרים באפשרות Apps Script ומספקים מזהה פריסה של הפרויקט.
      אזהרה: אם מזהה הפריסה של Apps Script כבר מאוכלס, הפרויקט ב-Cloud מחובר לתוסף קיים של Google Workspace. אם תעדכנו את מזהה הפריסה ב-Chat API, מזהה הפריסה יתעדכן בתוסף שלכם ויכול להשפיע על כרטיס המוצר שלכם ב-Google Workspace Marketplace. במאמר הגדרת האפליקציה ב-Google Workspace Marketplace SDK במסמכי העזרה של Google Workspace Marketplace מוסבר איך לבדוק את ההגדרות של התוסף.

   3. אופציונלי: כדי לקבל אובייקטים של אירועים למספר נקודות קצה או פונקציות, עוברים אל הגדרות מתקדמות > טריגרים ומספקים או מעדכנים את פונקציות הקריאה החוזרת לטריגרים הבאים של צ'אט:

      הערה: ב-Apps Script, אם לא מעדכנים את הטריגרים, צריך להשתמש בפונקציות ה-callback התואמות שמאוכלסות בקטע הזה (כמו onMessage,‏ onAddedToSpace ו-onRemovedFromSpace).
      • ADDED_TO_SPACE: משתמש מוסיף את אפליקציית Chat לשיחה קבוצתית או למרחב משותף, או מתקין את אפליקציית Chat לצ'אטים אישיים.
      • הודעה: משתמש שולח הודעה לאפליקציית Chat. לדוגמה, שולח הודעה אישית לאפליקציית Chat או מזכיר את אפליקציית Chat באמצעות @במרחב משותף עם כמה אנשים.
      • REMOVED_FROM_SPACE: משתמש מסיר או מ uninstall את אפליקציית Chat ממרחב משותף.

   4. אופציונלי: מוסיפים תכונות אינטראקטיביות אחרות, כמו פקודות קו נטוי או תצוגות מקדימות של קישורים.

   5. בקטע Visibility, מציינים את כתובת האימייל כדי שתוכלו להתקין ולבדוק את אפליקציית Chat לפני שתפרסמו אותה ב-Google Workspace Marketplace. אפשר לציין עד חמישה אנשים או קבוצת Google אחת או יותר מהארגון שלכם ב-Google Workspace.

4. אופציונלי: בקטע Logs, מסמנים את התיבה Log errors to Logging כדי להשתמש ב-Google Cloud Logging. מידע נוסף זמין בקטע יומני שגיאות של שאילתות לאפליקציות Chat במסמכי העזרה של Chat API.

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

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

שיקולים לגבי תוספים קיימים ל-Google Workspace

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

• גם משתמשים פרטיים וגם אדמינים ב-Google Workspace צריכים להיות מסוגלים להתקין את התוסף שלכם מ-Marketplace. מגדירים את הגדרות ההתקנה האלה ב-Google Workspace Marketplace SDK.
• אפליקציות Chat לא משתמשות בשם ובלוגו שהגדרתם לאפליקציות אחרות של Google Workspace באובייקט addons.common בmanifest.
• בתוספים שפורסמו ב-Google Workspace Marketplace, אי אפשר לשמור טיוטה של שינויים בהגדרות התצורה של Google Chat API. אחרי שמעדכנים את הגדרות התצורה של Chat API ושומרים אותן, אפליקציית Chat המעודכנת זמינה לכל המשתמשים הקיימים. כדי לעדכן את המוצר ב-Marketplace, תוכלו ליצור טיוטה לפני שליחת השינויים.

• אם יצרתם את התוסף באמצעות Apps Script:

  • צריך להשתמש באותו מזהה פריסה של Apps Script שבו משתמשים בשאר הגדרות התוסף.
  • אי אפשר להשתמש בעורך של Apps Script כדי להתקין פריסות לבדיקה ב-Chat. במקום זאת, צריך להתקין אותם ישירות מממשק המשתמש של Chat.

• אם פיתחתם את התוסף באמצעות שירות HTTP, עליכם להשמיט את פרטי ההגדרה של אפליקציית Chat במניפסט ובפריסות שאתם יוצרים באמצעות Google Workspace Add-ons API. הפריסות של HTTP שציינתם ב-SDK של Google Workspace Marketplace משמשות רק לאפליקציות אחרות של Google Workspace.

נושאים קשורים

• במאמר הגדרת Google Chat API במסמכי התיעוד של Google Chat API מוסבר איך לנהל את הגישה ל-Chat API.
• בדיקת תכונות אינטראקטיביות באפליקציות של Google Chat
• פרסום אפליקציות ב-Google Chat