קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מוסבר איך להגדיר ולפרוס אפליקציית Google Chat כתוסף ל-Google Workspace.
כדי לפרוס ולבדוק תוסף ל-Google Workspace שמרחיב את Chat, צריך להפעיל ולהגדיר אפליקציית Chat באמצעות Google Chat API. בהגדרות של Chat API מציינים את כל הפרטים על אפליקציית 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:
במסוף Google Cloud, עוברים לדף Chat API ולוחצים על Configuration:
בקטע Application info (פרטי האפליקציה), ממלאים את השדות App name (שם האפליקציה), Avatar URL (כתובת ה-URL של האווטאר) ו-Description (תיאור).
בקטע תכונות אינטראקטיביות, לוחצים על הפעלת תכונות אינטראקטיביות ומעבירים את המתג למצב מופעל. לאחר מכן מבצעים את הפעולות הבאות:
בקטע פונקציונליות, בוחרים באפשרות הצטרפות למרחבים ולשיחות קבוצתיות כדי לאפשר התקנה ושימוש באפליקציית Chat.
כברירת מחדל, המשתמשים יכולים להתקין את אפליקציית Chat ולשלוח לה הודעות במרחב ייעודי בינם לבין אפליקציית Chat. המשתמשים יכולים גם להוסיף את אפליקציית Chat למרחבים עם כמה אנשים ולקיים איתה אינטראקציה.
כדי להשתמש בשירות HTTP, בוחרים באפשרות כתובת URL של נקודת קצה (endpoint) בפרוטוקול HTTP ומזינים כתובת URL.
כדי להשתמש בפרויקט של סקריפט של Google Apps, בוחרים באפשרות Apps Script ומזינים מזהה פריסה לפרויקט.
אופציונלי: כדי לקבל אובייקטים של אירועים ליותר מנקודת קצה אחת או לפונקציה אחת, עוברים אל הגדרות החיבור>טריגרים ומזינים או מעדכנים את פונקציות הקריאה החוזרת (callback) עבור טריגרים של Chat הבאים:
נוספה למרחב: משתמש מוסיף את אפליקציית Chat לשיחה קבוצתית או למרחב, או מתקין את אפליקציית Chat לצורך שליחת הודעות בצ'אטים אישיים.
הודעה: משתמש שולח הודעה לאפליקציית Chat. לדוגמה, שולח צ'אט ישיר לאפליקציית Chat או מתייג ב-@ את אפליקציית Chat במרחב עם כמה אנשים.
הוסר מהמרחב: משתמש מסיר את ההתקנה של אפליקציית Chat או מסיר אותה ממרחב.
פקודה לאפליקציה: משתמש מריץ פקודה מהירה או פקודה עם לוכסן באפליקציית Chat.
בקטע חשיפה, מציינים את כתובת האימייל כדי שתוכלו להתקין ולבדוק את האפליקציה ל-Chat לפני הפרסום ב-Google Workspace Marketplace. אפשר לציין עד חמישה אנשים, או קבוצה אחת או יותר ב-Google Workspace של הארגון.
אופציונלי: בקטע Logs, מסמנים את תיבת הסימון Log errors to Logging כדי להשתמש ב-Google Cloud Logging. מידע נוסף זמין במאמר Query error logs for Chat apps (שאילתות ביומני שגיאות של אפליקציות ל-Chat) במאמרי העזרה של Chat API.
לוחצים על שמירה.
אחרי ששומרים את ההגדרה, כל מי שצוין בהגדרת החשיפה של 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:
צריך להשתמש באותו מזהה פריסה של Apps Script שבו משתמשים בשאר הגדרות התוסף.
אם יצרתם את התוסף באמצעות שירות HTTP, אל תכללו במניפסט ובפריסות שיצרתם באמצעות Google Workspace add-ons API פרטים על הגדרת אפליקציית Chat. פריסות HTTP שאתם מציינים ב-Google Workspace Marketplace SDK משמשות רק לאפליקציות אחרות של Google Workspace.
נושאים קשורים
כדי לנהל את הגישה ל-Chat API, אפשר לעיין במאמר הגדרת Google Chat API בתיעוד של Google Chat API.
[null,null,["עדכון אחרון: 2025-08-04 (שעון UTC)."],[[["\u003cp\u003eThis guide explains how to set up a Google Chat app as a Google Workspace add-on using either Apps Script or an HTTP service.\u003c/p\u003e\n"],["\u003cp\u003eYou'll need a Google Workspace account, a Google Cloud project, and necessary API configurations to get started.\u003c/p\u003e\n"],["\u003cp\u003eThe setup involves choosing a display name, avatar, and description for your app, and configuring its interactive features in the Google Cloud console.\u003c/p\u003e\n"],["\u003cp\u003eFor existing Google Workspace add-ons, specific considerations apply when integrating Chat app functionalities.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is part of the Google Workspace Developer Preview Program, granting early access before public release.\u003c/p\u003e\n"]]],["To configure a Chat app, use the Google Cloud console to access the Chat API page. Input the app's name, avatar URL, and description. Enable interactive features, choosing to receive 1:1 messages or join group conversations. Select either an HTTP endpoint URL or an Apps Script deployment ID for connection settings. Optionally, set triggers, add quick/slash commands, and specify visibility. Save configurations; users listed in \"Visibility\" can then test the Chat app.\n"],null,["# Configure a Google Chat app\n\nThis page explains how to configure and deploy a Google Chat app\nas a Google Workspace add-on.\n\nTo deploy and test a Google Workspace add-on that extends Chat,\nyou must enable and configure a Chat app using the\nGoogle Chat API. The Chat API configuration settings are where you\nspecify all the details about the Chat app, including\nthe name, avatar, deployment, and interactive features that you want to use.\n| **Note:** This page explains how to configure a Chat app using Apps Script or an HTTP service. [Dialogflow](/workspace/chat/build-dialogflow-chat-app-natural-language) and [Pub/Sub](/workspace/chat/quickstart/pub-sub) are unavailable. For details, see [Limitations and known issues](/workspace/add-ons/chat#limitations-known-issues).\n\nPrerequisites\n-------------\n\n- A Business or Enterprise [Google Workspace](https://support.google.com/a/answer/6043576) account with access to [Google Chat](https://workspace.google.com/products/chat/).\n- A Google Cloud project. To create one, see\n [Create a Google Cloud project](/workspace/guides/create-project).\n\n- [Configure the OAuth consent screen](/workspace/guides/configure-oauth-consent).\n- [Enable the Google Chat API](/workspace/guides/enable-apis).\n\nChoose a display name, avatar, and description for your Chat app\n----------------------------------------------------------------\n\nThe Chat app's name, avatar, and description are\ndisplayed to users in the Chat UI. To interact with\nChat apps, users see or use this information in the following\nways:\n\n- @mention the Chat app to add it to a space or send it a message.\n- Find and start a direct message with the Chat app. In the **Apps** menu, direct messages display the Chat app's name and avatar.\n- From the compose bar, users can browse Chat apps and see their name, avatar, and description.\n\nBefore you configure a Chat app, you must prepare the\nfollowing information:\n\n| Field | Description | Format |\n|-------------|-----------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| App name | The display name for the Chat app. | Up to 25 alphanumeric characters |\n| Avatar URL | The image that displays as your Chat app's avatar. | An HTTPS URL pointing to a square graphics image (PNG or JPEG). Recommended size is 256 by 256 pixels or more. |\n| Description | A brief description of the purpose of the Chat app. | Up to 40 alphanumeric characters |\n\nIn the following section, you specify this information in the configurations\nsettings in the Chat API.\n\nConfigure your Chat app in the Google Cloud console\n---------------------------------------------------\n\nIn the Google Cloud console, you configure the details about your\nChat app that appear to users in Chat,\nincluding a display name, avatar, and description. These details only appear\nin Chat. To publish your Chat app to the\nMarketplace, you must also specify the details that\nappear in your Chat app's\n[Marketplace listing](/workspace/marketplace/create-listing).\n\nWhen you have your Chat app details, open your\nCloud project and configure the Chat API:\n\n1. In the Google Cloud console, go to the Chat API page and click the\n **Configuration** page:\n\n [Go to the Chat API Configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)\n2. Under **Application info** , fill out the **App name** , **Avatar URL** ,\n and **Description** fields.\n\n3. Under **Interactive features** , click the **Enable interactive features**\n to the on position and complete the following:\n\n 1. Under **Functionality** , select **Join spaces and group conversations**\n to make your Chat app available to install and use.\n\n By default, Users can install and message with the\n Chat app in a dedicated space between\n the user and Chat app. Users can also add and interact\n with the Chat app in spaces with multiple\n people.\n 2. Under **Connection settings** , select the architecture that you want to\n use to receive\n [event objects from Chat](/workspace/add-ons/chat/build#event-objects):\n\n - To use an HTTP service, select **HTTP endpoint URL** and provide a URL.\n - To use a Google Apps Script project, select **Apps Script** and provide a [deployment ID](/apps-script/concepts/deployments) for the project.\n\n | **Warning:** If an Apps Script deployment ID is already populated, the Cloud project is connected to an existing Google Workspace add-on. If you update the deployment ID in the Chat API, the deployment ID is updated for your add-on and could affect your listing in the Google Workspace Marketplace. To review your add-on configuration, see [Configure your app in the Google Workspace Marketplace SDK](/workspace/marketplace/enable-configure-sdk) in the Google Workspace Marketplace documentation.\n 3. Optional: To receive event objects to more than one endpoint or\n function, go to **Connection settings**\n \\\u003e **Triggers** and provide or\n update the callback functions for the following\n [Chat triggers](/workspace/add-ons/chat/build#triggers):\n\n | **Note:** For Apps Script, if you don't update the triggers, you must use the corresponding callback functions that are populated in this section (such as `onMessage`, `onAddedToSpace`, and `onRemovedFromSpace`).\n - **Added to space**: A user adds the Chat app to a group conversation or space, or installs the Chat app for 1:1 messages.\n - **Message**: A user sends a message to the Chat app. For example, sends a direct message to the Chat app or @mentions the Chat app in a space with multiple people.\n - **Removed from space**: A user uninstalls or removes the Chat app from a space.\n - **App command**: A user uses a quick command or slash command from the Chat app.\n 4. Optional: Add other interactive features such as\n [quick commands](/workspace/add-ons/chat/quick-commands),\n [slash commands](/workspace/add-ons/chat/slash-commands),\n or [link previews](/workspace/add-ons/chat/preview-links).\n\n 5. Under **Visibility** , specify your email so that you can\n [install and test the Chat app](/workspace/chat/test-interactive-features)\n before you publish to the Google Workspace Marketplace. You can specify\n up to five individuals, or one or more Google Groups from your\n Google Workspace organization.\n\n4. Optional: Under **Logs** , select the **Log errors to Logging** checkbox to\n use Google Cloud Logging. For more information, see\n [Query error logs for Chat apps](/workspace/chat/query-logs)\n in the Chat API documentation.\n\n5. Click **Save**.\n\nAfter you save the configuration, anyone that you specified in the\nChat API's **Visibility** setting can install, test, or use the\nChat app. To start testing and debugging your\nChat app, see\n[Test interactive features for Google Chat apps](/workspace/chat/test-interactive-features)\nin the Chat API documentation.\n\nConsiderations for existing Google Workspace add-ons\n----------------------------------------------------\n\nChat apps require a different configuration compared to\nGoogle Workspace add-ons that extend other Google Workspace applications.\nIf your add-on extends other\nGoogle Workspace applications, consider the following requirements\nfor configuring the Chat app:\n\n- Both individuals and Google Workspace administrators must be able to install your add-on from the Marketplace. You configure these installation settings in the Google Workspace Marketplace SDK.\n- Chat apps don't use the name and logo that you configure for other Google Workspace applications in the `addons.common` object of the [manifest](/workspace/add-ons/concepts/workspace-manifests).\n- For add-ons that are published to the Google Workspace Marketplace, you can't save a draft of any changes to the [Google Chat API configuration settings](/workspace/add-ons/chat/configure). After you update and save the Chat API configuration settings, the updated Chat app is available to all existing users. To update your Marketplace listing, you can [create a draft](/workspace/marketplace/manage-app-listing#draft-app-listing) before submitting any changes.\n- If you built your add-on using\n Apps Script:\n\n - You must use the same Apps Script deployment ID that you use for the rest of your add-on configuration.\n - You can't use the Apps Script editor to install [test deployments](/workspace/add-ons/how-tos/testing-workspace-addons#install_an_unpublished) in Chat. Instead, you must [install them directly from the\n Chat UI](/workspace/chat/test-interactive-features).\n- If you built your add-on using an HTTP service,\n omit any Chat app configuration details in the\n manifest and deployments that you create using the Google Workspace add-ons API. The\n HTTP deployments that you specify in the Google Workspace Marketplace SDK are\n only used for other Google Workspace applications.\n\nRelated topics\n--------------\n\n- To manage access to the Chat API, see [Configure the Google Chat API](/workspace/chat/configure-chat-api#grant-access) in the Google Chat API documentation.\n- [Test interactive features for Google Chat apps](/workspace/chat/test-interactive-features)"]]
