این صفحه نحوه پیکربندی و استقرار برنامه Google Chat را به عنوان افزونه Google Workspace توضیح میدهد.
برای استقرار و آزمایش افزونه Google Workspace که Chat را گسترش میدهد، باید یک برنامه Chat را با استفاده از Google Chat API فعال و پیکربندی کنید. تنظیمات پیکربندی Chat API جایی است که شما تمام جزئیات برنامه Chat را مشخص میکنید، از جمله نام، آواتار، استقرار و ویژگیهای تعاملی که میخواهید استفاده کنید.
پیش نیازها
HTTP
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- APIهای Google Workspace زیر را فعال کنید :
- Google Chat API
- Google Workspace Add-ons API
- یک نقطه پایانی HTTP که معماری سرویس را برای برنامه چت شما میزبانی می کند.
اسکریپت برنامه ها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را فعال کنید .
- یک پروژه Apps Script مستقل ایجاد کنید و سرویس گفتگوی پیشرفته را روشن کنید.
- با افزودن شی
addons.chat
و هر حوزه مورد نیاز (oauthScopes
) یا پیشوندهای URL HTTPS (urlFetchWhitelist
) Chat را در مانیفست پیکربندی کنید .
یک نام نمایشی، آواتار و توضیحات برای برنامه چت خود انتخاب کنید
نام، آواتار و توضیحات برنامه چت در رابط کاربری چت به کاربران نمایش داده می شود. برای تعامل با برنامههای چت، کاربران این اطلاعات را به روشهای زیر میبینند یا از آن استفاده میکنند:
- برای افزودن آن به یک فضا یا ارسال پیام، برنامه چت را @ نام ببرید.
- یک پیام مستقیم را با برنامه چت پیدا کنید و شروع کنید. در منوی برنامهها ، پیامهای مستقیم نام و آواتار برنامه چت را نمایش میدهند.
- از نوار نوشتن، کاربران میتوانند برنامههای چت را مرور کنند و نام، آواتار و توضیحات آنها را ببینند.
قبل از پیکربندی یک برنامه چت، باید اطلاعات زیر را آماده کنید:
میدان | توضیحات | قالب |
---|---|---|
نام برنامه | نام نمایشی برنامه چت. | حداکثر 25 کاراکتر الفبایی عددی |
آدرس آواتار | تصویری که به عنوان چهرهنمای برنامه چت شما نمایش داده میشود. | یک URL HTTPS که به یک تصویر گرافیکی مربعی (PNG یا JPEG) اشاره می کند. اندازه پیشنهادی 256 در 256 پیکسل یا بیشتر است. |
توضیحات | توضیح مختصری از هدف برنامه چت. | حداکثر 40 کاراکتر الفبایی عددی |
در بخش زیر، این اطلاعات را در تنظیمات تنظیمات در Chat API مشخص میکنید.
برنامه چت خود را در کنسول Google Cloud پیکربندی کنید
وقتی جزئیات برنامه Chat خود را دارید، پروژه Cloud خود را باز کنید و Chat API را پیکربندی کنید:
در کنسول Google Cloud، به صفحه Chat API بروید و روی صفحه پیکربندی کلیک کنید:
در قسمت اطلاعات برنامه ، فیلدهای نام برنامه ، URL آواتار و توضیحات را پر کنید.
در قسمت ویژگی های تعاملی ، روی فعال کردن ویژگی های تعاملی در موقعیت روشن کلیک کنید و موارد زیر را تکمیل کنید:
در بخش Functionality ، یک یا چند کادر را انتخاب کنید تا برنامه Chat خود را برای نصب و استفاده در دسترس قرار دهید:
دریافت پیامهای 1:1 : کاربران میتوانند برنامه چت را در فضای اختصاصی بین کاربر و برنامه چت نصب کرده و پیام ارسال کنند.
به فضاها و مکالمات گروهی بپیوندید : کاربران می توانند برنامه Chat را در فضاهایی با چند نفر اضافه کنند و با آن تعامل داشته باشند.
در قسمت تنظیمات اتصال ، معماری را که میخواهید برای دریافت اشیاء رویداد از چت استفاده کنید، انتخاب کنید:
- برای استفاده از سرویس HTTP، URL نقطه پایانی HTTP را انتخاب کنید و یک URL ارائه دهید.
- برای استفاده از یک پروژه Google Apps Script، Apps Script را انتخاب کرده و یک شناسه استقرار برای پروژه ارائه دهید.
اختیاری: برای دریافت اشیاء رویداد در بیش از یک نقطه پایانی یا تابع، به تنظیمات پیشرفته > محرکها بروید و عملکردهای پاسخ به تماس را برای راهاندازهای چت زیر ارائه یا بهروزرسانی کنید:
- ADDED_TO_SPACE : کاربر برنامه Chat را به یک مکالمه یا فضای گروهی اضافه می کند یا برنامه Chat را برای پیام های 1:1 نصب می کند.
- پیام : یک کاربر پیامی را به برنامه چت ارسال می کند. به عنوان مثال، یک پیام مستقیم به برنامه Chat ارسال می کند یا @ از برنامه Chat در فضایی با چند نفر نام می برد.
- REMOVED_FROM_SPACE : کاربر برنامه Chat را از یک فضا حذف نصب یا حذف می کند.
اختیاری: سایر ویژگیهای تعاملی مانند دستورات اسلش یا پیشنمایش پیوند را اضافه کنید.
در قسمت Visibility ، ایمیل خود را مشخص کنید تا بتوانید برنامه Chat را قبل از انتشار در Google Workspace Marketplace نصب و آزمایش کنید . میتوانید حداکثر پنج فرد یا یک یا چند گروه Google را از سازمان Google Workspace خود مشخص کنید.
اختیاری: برای استفاده از 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 استفاده کنید که برای بقیه پیکربندی افزونه خود استفاده می کنید.
- نمیتوانید از ویرایشگر Apps Script برای نصب برنامههای آزمایشی در Chat استفاده کنید. در عوض، باید آنها را مستقیماً از رابط کاربری گپ نصب کنید .
اگر افزونه خود را با استفاده از سرویس HTTP ساختهاید، جزئیات پیکربندی برنامه Chat را در مانیفست و پیادهسازیهایی که با استفاده از Google Workspace Add-ons API ایجاد میکنید حذف کنید. پیادهسازیهای HTTP که در Google Workspace Marketplace SDK مشخص میکنید فقط برای سایر برنامههای Google Workspace استفاده میشوند.
موضوعات مرتبط
- برای مدیریت دسترسی به Chat API، به پیکربندی Google Chat API در اسناد Google Chat API مراجعه کنید.
- ویژگیهای تعاملی را برای برنامههای Google Chat آزمایش کنید
- برنامههای چت Google را منتشر کنید