این صفحه نحوه پیکربندی و استقرار برنامه Google Chat به عنوان افزونه Google Workspace را توضیح میدهد.
برای استقرار و آزمایش افزونهی Google Workspace که Chat را توسعه میدهد، باید یک برنامهی چت را با استفاده از Google Chat API فعال و پیکربندی کنید. تنظیمات پیکربندی Chat API جایی است که تمام جزئیات مربوط به برنامهی چت، از جمله نام، آواتار، استقرار و ویژگیهای تعاملی که میخواهید استفاده کنید را مشخص میکنید.
پیشنیازها
- یک حساب کاربری تجاری یا سازمانی Google Workspace با دسترسی به Google Chat .
یک پروژه گوگل کلود. برای ایجاد آن، به «ایجاد یک پروژه گوگل کلود» مراجعه کنید.
- صفحه رضایت OAuth را پیکربندی کنید .
- فعال کردن API چت گوگل
یک نام نمایشی، آواتار و توضیح برای برنامه چت خود انتخاب کنید
نام، آواتار و توضیحات برنامه چت در رابط کاربری چت به کاربران نمایش داده میشود. برای تعامل با برنامههای چت، کاربران این اطلاعات را به روشهای زیر مشاهده یا استفاده میکنند:
- برای اضافه کردن برنامه چت به یک فاصله یا ارسال پیام به آن، آن را با @mention منشن کنید.
- یک پیام مستقیم با برنامه چت پیدا کنید و شروع کنید. در منوی برنامهها ، پیامهای مستقیم نام و آواتار برنامه چت را نمایش میدهند.
- از نوار نوشتن، کاربران میتوانند برنامههای چت را مرور کرده و نام، آواتار و توضیحات خود را مشاهده کنند.
قبل از پیکربندی یک برنامه چت، باید اطلاعات زیر را تهیه کنید:
| میدان | توضیحات | قالب |
|---|---|---|
| نام برنامه | نام نمایشی برای برنامه چت. | حداکثر ۲۵ کاراکتر الفبایی-عددی |
| آدرس اینترنتی آواتار | تصویری که به عنوان آواتار برنامه چت شما نمایش داده میشود. | یک URL HTTPS که به یک تصویر گرافیکی مربعی (PNG یا JPEG) اشاره میکند. اندازه توصیه شده ۲۵۶ در ۲۵۶ پیکسل یا بیشتر است. |
| توضیحات | شرح مختصری از هدف برنامه چت. | حداکثر ۴۰ کاراکتر الفبایی-عددی |
در بخش بعدی، این اطلاعات را در تنظیمات پیکربندی در Chat API مشخص میکنید.
برنامه چت خود را در کنسول Google Cloud پیکربندی کنید
در کنسول گوگل کلود، جزئیات مربوط به برنامه چت خود را که برای کاربران در چت نمایش داده میشود، از جمله نام نمایشی، آواتار و توضیحات، پیکربندی میکنید. این جزئیات فقط در چت نمایش داده میشوند. برای انتشار برنامه چت خود در بازار، باید جزئیاتی را که در فهرست بازار برنامه چت شما نمایش داده میشود، نیز مشخص کنید.
وقتی جزئیات برنامه چت خود را دارید، پروژه Cloud خود را باز کنید و API چت را پیکربندی کنید:
در کنسول گوگل کلود، به صفحه Chat API بروید و روی صفحه Configuration کلیک کنید:
در قسمت اطلاعات برنامه ، فیلدهای نام برنامه ، آدرس اینترنتی آواتار و توضیحات را پر کنید.
در قسمت ویژگیهای تعاملی ، روی گزینه فعال کردن ویژگیهای تعاملی کلیک کنید و موارد زیر را تکمیل کنید:
در بخش «عملکرد» ، گزینه «پیوستن به فضاها و مکالمات گروهی» را انتخاب کنید تا برنامه چت شما برای نصب و استفاده در دسترس قرار گیرد.
به طور پیشفرض، کاربران میتوانند برنامه چت را نصب کرده و در یک فضای اختصاصی بین کاربر و برنامه چت، با آن پیام ارسال کنند. کاربران همچنین میتوانند برنامه چت را در فضاهایی با چندین نفر اضافه کرده و با آن تعامل داشته باشند.
در قسمت تنظیمات اتصال ، معماری مورد نظر خود را برای دریافت اشیاء رویداد از چت انتخاب کنید:
- برای استفاده از سرویس HTTP، آدرس اینترنتی نقطه پایانی HTTP را انتخاب کرده و یک آدرس اینترنتی (URL) ارائه دهید.
- برای استفاده از یک پروژه Google Apps Script، Apps Script را انتخاب کنید و یک شناسه استقرار برای پروژه ارائه دهید.
اختیاری: برای دریافت اشیاء رویداد در بیش از یک نقطه پایانی یا تابع، به تنظیمات اتصال > محرکها بروید و توابع فراخوانی را برای محرکهای چت زیر ارائه یا بهروزرسانی کنید:
- اضافه شده به فضا : کاربر برنامه چت را به یک مکالمه گروهی یا فضا اضافه میکند، یا برنامه چت را برای پیامهای یک به یک نصب میکند.
- پیام : کاربر پیامی را به برنامه چت ارسال میکند. برای مثال، یک پیام مستقیم به برنامه چت ارسال میکند یا در فضایی با حضور چندین نفر، برنامه چت را @mention میکند.
- حذف از فضا : کاربر برنامه چت را از یک فضا حذف یا پاک میکند.
- دستور برنامه : کاربر از یک دستور سریع یا دستور اسلش از برنامه چت استفاده میکند.
اختیاری: ویژگیهای تعاملی دیگری مانند دستورات سریع ، دستورات اسلش یا پیشنمایش لینکها را اضافه کنید.
در قسمت «قابلیت مشاهده» ، ایمیل خود را مشخص کنید تا بتوانید برنامه چت را قبل از انتشار در بازار Google Workspace نصب و آزمایش کنید . میتوانید حداکثر پنج نفر یا یک یا چند گروه Google را از سازمان Google Workspace خود مشخص کنید.
اختیاری: در قسمت گزارشها ، کادر انتخاب «گزارش خطاها برای گزارشگیری» را برای استفاده از Google Cloud Logging انتخاب کنید. برای اطلاعات بیشتر، به بخش «گزارشهای خطای پرسوجو برای برنامههای چت» در مستندات API چت مراجعه کنید.
روی ذخیره کلیک کنید.
پس از ذخیره پیکربندی، هر کسی که در تنظیمات قابلیت مشاهده API چت مشخص کردهاید میتواند برنامه چت را نصب، آزمایش یا استفاده کند. برای شروع آزمایش و اشکالزدایی برنامه چت خود، به بخش «آزمایش ویژگیهای تعاملی برای برنامههای چت گوگل» در مستندات API چت مراجعه کنید.
ملاحظات مربوط به افزونههای موجود در Google Workspace
برنامههای چت در مقایسه با افزونههای Google Workspace که سایر برنامههای Google Workspace را گسترش میدهند، به پیکربندی متفاوتی نیاز دارند. اگر افزونه شما سایر برنامههای Google Workspace را گسترش میدهد، الزامات زیر را برای پیکربندی برنامه چت در نظر بگیرید:
- هم افراد و هم مدیران Google Workspace باید بتوانند افزونه شما را از Marketplace نصب کنند. شما این تنظیمات نصب را در SDK بازار Google Workspace پیکربندی میکنید.
- برنامههای چت از نام و لوگویی که برای سایر برنامههای Google Workspace در شیء
addons.commonدر مانیفست پیکربندی میکنید، استفاده نمیکنند. - برای افزونههایی که در بازار Google Workspace منتشر میشوند، نمیتوانید پیشنویس تغییرات در تنظیمات پیکربندی API چت گوگل را ذخیره کنید. پس از بهروزرسانی و ذخیره تنظیمات پیکربندی API چت، برنامه چت بهروزرسانیشده برای همه کاربران موجود در دسترس است. برای بهروزرسانی فهرست بازار خود، میتوانید قبل از ارسال هرگونه تغییر، پیشنویس ایجاد کنید .
اگر افزونه خود را با استفاده از Apps Script ساختهاید:
- شما باید از همان شناسه استقرار اسکریپت برنامهها که برای بقیه پیکربندی افزونه خود استفاده میکنید، استفاده کنید.
- شما نمیتوانید از ویرایشگر Apps Script برای نصب نسخههای آزمایشی در Chat استفاده کنید. در عوض، باید آنها را مستقیماً از رابط کاربری Chat نصب کنید .
اگر افزونه خود را با استفاده از سرویس HTTP ساختهاید، هرگونه جزئیات پیکربندی برنامه چت را در مانیفست و استقرارهایی که با استفاده از API افزونههای Google Workspace ایجاد میکنید، حذف کنید. استقرارهای HTTP که در SDK بازار Google Workspace مشخص میکنید، فقط برای سایر برنامههای Google Workspace استفاده میشوند.
مباحث مرتبط
- برای مدیریت دسترسی به API چت، به بخش پیکربندی API چت گوگل در مستندات API چت گوگل مراجعه کنید.
- ویژگیهای تعاملی را برای برنامههای چت گوگل آزمایش کنید