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

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

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

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

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

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

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

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

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

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

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

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

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

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

    מעבר לדף ההגדרות של Chat API

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

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

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

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

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

      • כדי להשתמש בשירות HTTP, בוחרים באפשרות כתובת URL של נקודת קצה (endpoint) בפרוטוקול HTTP ומזינים כתובת URL.
      • כדי להשתמש בפרויקט של סקריפט של Google Apps, בוחרים באפשרות Apps Script ומזינים מזהה פריסה של הפרויקט.

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

      • נוספה למרחב: משתמש מוסיף את אפליקציית Chat לשיחה קבוצתית או למרחב, או מתקין את אפליקציית Chat לצ'אטים אישיים.
      • הודעה: משתמש שולח הודעה לאפליקציית Chat. לדוגמה, שולח צ'אט ישיר לאפליקציית Chat או מתייג ב-@ את אפליקציית Chat במרחב עם כמה אנשים.
      • הוסר מהמרחב: משתמש הסיר את ההתקנה של אפליקציית Chat או הסיר אותה מהמרחב.
      • פקודה לאפליקציה: משתמש מריץ פקודה מהירה או פקודה עם לוכסן באפליקציית Chat.

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

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

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

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

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

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

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

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

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

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