با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
این صفحه نحوه پیکربندی و استقرار یک برنامه Google Chat را به عنوان یک افزونه Google Workspace توضیح می‌دهد.
برای استقرار و آزمایش یک افزونه Google Workspace که Chat را گسترش می‌دهد، باید یک برنامه Chat را با استفاده از Google Chat API فعال و پیکربندی کنید. تنظیمات پیکربندی Chat API جایی است که شما تمام جزئیات برنامه Chat را مشخص می‌کنید، از جمله نام، آواتار، استقرار و ویژگی‌های تعاملی که می‌خواهید استفاده کنید.
یک نام نمایشی، آواتار و توضیحات برای برنامه چت خود انتخاب کنید
نام، آواتار و توضیحات برنامه چت در رابط کاربری چت به کاربران نمایش داده می شود. برای تعامل با برنامه‌های چت، کاربران این اطلاعات را به روش‌های زیر می‌بینند یا از آن استفاده می‌کنند:
برای افزودن آن به یک فضا یا ارسال پیام، برنامه چت را @ نام ببرید.
یک پیام مستقیم را با برنامه چت پیدا کنید و شروع کنید. در منوی برنامه‌ها ، پیام‌های مستقیم نام و آواتار برنامه چت را نمایش می‌دهند.
از نوار نوشتن، کاربران می‌توانند برنامه‌های چت را مرور کنند و نام، آواتار و توضیحات آنها را ببینند.
قبل از پیکربندی یک برنامه چت، باید اطلاعات زیر را آماده کنید:
میدان
توضیحات
قالب
نام برنامه
نام نمایشی برنامه چت.
حداکثر 25 کاراکتر الفبایی عددی
آدرس آواتار
تصویری که به عنوان چهره‌نمای برنامه چت شما نمایش داده می‌شود.
یک URL HTTPS که به یک تصویر گرافیکی مربعی (PNG یا JPEG) اشاره می کند. اندازه پیشنهادی 256 در 256 پیکسل یا بیشتر است.
توضیحات
توضیح مختصری از هدف برنامه چت.
حداکثر 40 کاراکتر الفبایی عددی
در بخش زیر، این اطلاعات را در تنظیمات تنظیمات در Chat API مشخص می‌کنید.
برنامه چت خود را در کنسول Google Cloud پیکربندی کنید
در کنسول Google Cloud، جزئیات مربوط به برنامه چت خود را که در چت برای کاربران ظاهر می شود، از جمله نام نمایشی، آواتار و توضیحات پیکربندی می کنید. این جزئیات فقط در چت ظاهر می شوند. برای انتشار برنامه Chat خود در Marketplace، باید جزئیاتی را که در لیست بازار برنامه Chat شما ظاهر می شود را نیز مشخص کنید.
وقتی جزئیات برنامه Chat خود را دارید، پروژه Cloud خود را باز کنید و Chat API را پیکربندی کنید:
در کنسول Google Cloud، به صفحه Chat API بروید و روی صفحه پیکربندی کلیک کنید:
در قسمت اطلاعات برنامه ، فیلدهای نام برنامه ، URL آواتار و توضیحات را پر کنید.
در قسمت ویژگی های تعاملی ، روی فعال کردن ویژگی های تعاملی در موقعیت روشن کلیک کنید و موارد زیر را تکمیل کنید:
در بخش Functionality ، Join spaces and group talks را انتخاب کنید تا برنامه Chat خود را برای نصب و استفاده در دسترس قرار دهید.
به‌طور پیش‌فرض، کاربران می‌توانند برنامه چت را در فضای اختصاصی بین کاربر و برنامه چت نصب کرده و پیام ارسال کنند. کاربران همچنین می توانند برنامه Chat را در فضاهایی با چند نفر اضافه کنند و با آن تعامل داشته باشند.
در قسمت تنظیمات اتصال ، معماری را که می‌خواهید برای دریافت اشیاء رویداد از چت استفاده کنید، انتخاب کنید:
برای استفاده از سرویس HTTP، URL نقطه پایانی HTTP را انتخاب کنید و یک URL ارائه دهید.
برای استفاده از یک پروژه Google Apps Script، Apps Script را انتخاب کرده و یک شناسه استقرار برای پروژه ارائه دهید.
اختیاری: برای دریافت اشیاء رویداد در بیش از یک نقطه پایانی یا تابع، به تنظیمات اتصال>راه‌اندازها بروید و عملکردهای پاسخ به تماس را برای راه‌اندازهای چت زیر ارائه یا به‌روزرسانی کنید:
به فضا اضافه شد : کاربر برنامه Chat را به یک مکالمه یا فضای گروهی اضافه می کند یا برنامه Chat را برای پیام های 1:1 نصب می کند.
پیام : یک کاربر پیامی را به برنامه چت ارسال می کند. به عنوان مثال، یک پیام مستقیم به برنامه Chat ارسال می کند یا @ از برنامه Chat در فضایی با چند نفر نام می برد.
حذف شده از فضا : کاربر برنامه چت را از یک فضا حذف نصب یا حذف می کند.
دستور برنامه : کاربر از دستور سریع یا دستور اسلش از برنامه چت استفاده می کند.
اختیاری: برای استفاده از Google Cloud Logging، در قسمت Logs ، کادر بررسی Log errors to Logging را انتخاب کنید. برای اطلاعات بیشتر، به گزارش‌های خطای Query برای برنامه‌های Chat در مستندات Chat API مراجعه کنید.
روی ذخیره کلیک کنید.
پس از ذخیره پیکربندی، هرکسی که در تنظیمات 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 پیکربندی می‌کنید.
برنامه‌های گپ از نام و نشان‌واره‌ای که برای سایر برنامه‌های Google Workspace در شی addons.commonمانیفست پیکربندی می‌کنید استفاده نمی‌کنند.
برای افزونه‌هایی که در Google Workspace Marketplace منتشر می‌شوند، نمی‌توانید پیش‌نویس تغییراتی را در تنظیمات پیکربندی Google Chat API ذخیره کنید. پس از به‌روزرسانی و ذخیره تنظیمات پیکربندی Chat API، برنامه Chat به‌روزرسانی شده برای همه کاربران موجود در دسترس است. برای به‌روزرسانی فهرست بازار خود، می‌توانید پیش‌نویسی را قبل از ارسال هرگونه تغییر ایجاد کنید .
اگر افزونه خود را با استفاده از Apps Script ساخته اید:
باید از همان شناسه استقرار Apps Script استفاده کنید که برای بقیه پیکربندی افزونه خود استفاده می کنید.
اگر افزونه خود را با استفاده از سرویس HTTP ساخته‌اید، جزئیات پیکربندی برنامه Chat را در مانیفست و استقرارهایی که با استفاده از API برافزای Google Workspace ایجاد می‌کنید حذف کنید. پیاده‌سازی‌های HTTP که در Google Workspace Marketplace SDK مشخص می‌کنید فقط برای سایر برنامه‌های Google Workspace استفاده می‌شوند.
تاریخ آخرین به‌روزرسانی 2025-08-04 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-08-04 بهوقت ساعت هماهنگ جهانی."],[[["\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)"]]
