پیکربندی کردن «میانای برنامه‌سازی کاربردی Google Chat»

هر برنامه Google Chat که ایجاد می‌کنید به پروژه Google Cloud خودش نیاز دارد که Chat API در آن فعال و پیکربندی شده باشد.

برای انجام فراخوانی‌های API فقط‌خواندنی با اصالت‌سنجی کاربر، مثل دریافت فضاها و فهرست کردن پیام‌ها، فقط باید API را فعال کنید و کارخواه OAuth ایجاد کنید.

برای انجام فراخوانی‌های میانای برنامه‌سازی کاربردی ایجاد، به‌روزرسانی، و حذف، یا برای استقرار و آزمایش کردن برنامه Chat تعاملی (ساخته‌شده به‌عنوان برافزای Google Workspace که Chat را گسترش می‌دهد)، باید Chat API را نیز پیکربندی کنید. تنظیمات پیکربندی Chat API جایی است که همه جزئیات مربوط به برنامه Chat را مشخص می‌کنید، ازجمله نام نمایشی، چهره‌نما، نقاط پایانی استقرار، و ویژگی‌های تعاملی.

پیش‌نیازها

• حساب «کسب‌وکار» یا «سازمان» Google Workspace با دسترسی به Google Chat.
• پروژه Google Cloud ایجاد کنید.
• صفحه کسب رضایت OAuth را پیکربندی کنید.
• Google Chat API را فعال کنید.

نام نمایشی، چهره‌نما، و شرحی برای برنامه Chat خود انتخاب کنید

وقتی Chat API را فعال می‌کنید، جزئیات مربوط به برنامه Chat خود را که در Chat به کاربران نمایش داده می‌شود، پیکربندی می‌کنید، ازجمله نام نمایشی، چهره‌نما، و شرح. این جزئیات فقط در Chat نشان داده می‌شود. برای انتشار برنامه Chat در Marketplace، باید جزئیاتی را که در فهرستگان Marketplace برنامه Chat شما نشان داده می‌شود نیز مشخص کنید.

قبل‌از پیکربندی برنامه Chat، اطلاعات زیر را آماده کنید:

نام، چهره‌نما، و شرح برنامه Chat در میانای کاربری Chat به کاربران نشان داده می‌شود. برای برخی‌از درخواست‌های نوشتن Chat API، Chat از این اطلاعات برای نسبت دادن کنش‌هایی که برنامه Chat در Chat انجام می‌دهد استفاده می‌کند.

برای مثال، اگر روش spaces.create() را فراخوانی کنید، Chat نام برنامه Chat را در شرح فردی که فضا را ایجاد کرده است اضافه می‌کند، همان‌طور که در تصویر زیر نشان داده شده است:

برای تعامل با برنامه‌های Chat، کاربران این اطلاعات را به روش‌های زیر نیز می‌بینند یا از آن‌ها استفاده می‌کنند:

• برای افزودن برنامه Chat به فضا یا ارسال پیام به آن، از @نامبری استفاده کنید.
• برنامه Chat را پیدا کنید و پیام مستقیمی با آن شروع کنید. در منو برنامه‌ها، پیام‌های مستقیم نام و چهره‌نمای برنامه Chat را نمایش می‌دهند.
• کاربران می‌توانند از نوار نوشتن، برنامه‌های Chat را مرور کنند و نام، چهرک، و شرح آن‌ها را ببینند.

پیکربندی برنامه Chat در کنسول Google Cloud

وقتی جزئیات برنامه Chat را داشتید، پروژه Cloud خود را باز کنید و Chat API را پیکربندی کنید:

1. در کنسول Google Cloud، به صفحه Chat API بروید و روی صفحه پیکربندی کلیک کنید:

   رفتن به صفحه «پیکربندی Chat API»

2. در بخش اطلاعات برنامه، فیلدهای نام برنامه، نشانی وب چهرک، و شرح را تکمیل کنید.

3. اختیاری: از منو نحو نشانه‌گذاری، نحو نشانه‌گذاری پیش‌فرض (Markdown یا Chat) را برای پیام‌های برنامه Chat خود انتخاب کنید. برای کسب اطلاعات بیشتر درباره قالب‌بندی نوشتار و نحوه تعیین نحو نشانه‌گذاری برای درخواست‌های API توسط Chat، به قالب‌بندی پیام‌ها مراجعه کنید.

4. در بخش ویژگی‌های تعاملی، پیکربندی کنید که آیا برنامه Chat شما به تعاملات کاربر پاسخ می‌دهد یا نه:

   برای ساختن برنامه Chat تعاملی، فعال کردن ویژگی‌های تعاملی را روشن کنید و موارد زیر را تکمیل کنید:

   1. در بخش عملکرد:
      • اختیاری: پشتیبانی از صفحه اصلی برنامه را انتخاب کنید تا کارت صفحه اصلی در برگه صفحه اصلی پیام‌های مستقیم یک‌به‌یک با برنامه Chat نمایش داده شود.
      • پیوستن به فضاها و مکالمه‌های گروهی را انتخاب کنید تا برنامه Chat شما برای نصب و استفاده دردسترس قرار گیرد. به‌طور پیش‌فرض، کاربران می‌توانند برنامه Chat را در فضای اختصاصی بین کاربر و برنامه Chat نصب کنند و با آن پیام ردوبدل کنند. کاربران همچنین می‌توانند برنامه Chat را به فضاهای چندنفره اضافه کنند و با آن تعامل داشته باشند.

   2. در بخش تنظیمات اتصال، معماری‌ای را که می‌خواهید برای دریافت اشیاء رویداد از Chat استفاده کنید انتخاب کنید:

      • برای استفاده از سرویس HTTP، نشانی وب نقطه پایان HTTP را انتخاب کنید و نشانی وب را ارائه دهید.
      • برای استفاده از پروژه Google Apps Script، Apps Script را انتخاب کنید و شناسه استقرار برای پروژه ارائه دهید.
      • برای استفاده از عامل Dialogflow،‏ Dialogflow را انتخاب کنید، Dialogflow CX یا Dialogflow ES را انتخاب کنید، و نام منبع عامل را ارائه دهید.
      • برای استفاده از Pub/Sub، Cloud Pub/Sub را انتخاب کنید و نام موضوع را وارد کنید.

   3. اختیاری: برای هدایت اشیای رویداد به نقاط پایانی یا توابع خاص، به تنظیمات اتصال > راه‌اندازها بروید و نقاط پایانی یا توابع فراخوانی متقابل را برای راه‌اندازهای Chat زیر ارائه یا به‌روز کنید:

      • صفحه اصلی برنامه (اگر پشتیبانی از صفحه اصلی برنامه فعال باشد): کاربر برگه صفحه اصلی را در پیام مستقیم دونفره با برنامه Chat باز می‌کند.
      • افزوده‌شده به فضا: کاربر برنامه Chat را به مکالمه گروهی یا فضا اضافه می‌کند، یا برنامه Chat را برای پیام‌های دونفره نصب می‌کند.
      • پیام: کاربر پیامی به برنامه Chat ارسال می‌کند. برای مثال، کاربر پیام مستقیمی به برنامه Chat ارسال می‌کند یا در فضایی با چند نفر، برنامه Chat را @نامبری می‌کند.
      • Removed from space: کاربر برنامه Chat را از فضا حذف نصب یا برمی‌دارد.
      • فرمان برنامه: کاربر فرمان سریع، فرمان خط مورب، یا کنش پیام را از برنامه Chat فراخوانی می‌کند.

   4. اختیاری: ویژگی‌های تعاملی دیگری مثل پیام‌واره‌های آغازگر، فرمان‌ها (فرمان‌های سریع، فرمان‌های خط مورب، و کنش‌های پیام)، یا پیش‌نمایش پیوند اضافه کنید.

   5. در بخش رؤیت‌پذیری، نشانی ایمیلتان را مشخص کنید تا بتوانید برنامه Chat را نصب و آزمایش کنید قبل‌از اینکه آن را در Google Workspace Marketplace منتشر کنید. می‌توانید حداکثر پنج فرد یا یک یا چند «گروه Google» از سازمان Google Workspace خود را مشخص کنید.

5. اختیاری: در بخش گزارش‌ها، چارگوش گزارش کردن خطاها در Logging را انتخاب کنید تا از Google Cloud Logging استفاده کنید. برای اطلاعات بیشتر، به گزارش‌های خطای پُرسمان برای برنامه‌های Chat مراجعه کنید.

6. روی ذخیره کلیک کنید.

پس‌از ذخیره کردن پیکربندی، هر فردی که در تنظیمات رؤیت‌پذیری Chat API مشخص کرده‌اید می‌تواند برنامه Chat را نصب، آزمایش، یا استفاده کند. برای شروع آزمایش و اشکال‌زدایی برنامه Chat، به آزمایش کردن ویژگی‌های تعاملی برای برنامه‌های Google Chat مراجعه کنید.

ملاحظات مربوط به برافزاهای Google Workspace موجود

برنامه‌های Chat درمقایسه با برافزاهای Google Workspace که دیگر برنامه‌های Google Workspace را گسترش می‌دهند، به پیکربندی متفاوتی نیاز دارند. اگر برافزای شما برنامه‌های دیگر Google Workspace را گسترش می‌دهد، الزامات زیر را برای پیکربندی برنامه Chat درنظر بگیرید:

• هم افراد و هم سرپرستان Google Workspace باید بتوانند برافزای شما را از Marketplace نصب کنند. این تنظیمات نصب را در کیت توسعه نرم‌افزار (SDK) ‏Google Workspace Marketplace پیکربندی می‌کنید.
• برنامه‌های Chat از نام و نشان‌واره‌ای که برای دیگر برنامه‌های Google Workspace در شیء addons.common از مانیفست پیکربندی می‌کنید استفاده نمی‌کنند.
• برای برافزاهایی که در Google Workspace Marketplace منتشر شده‌اند، نمی‌توانید پیش‌نویس تغییرات را در تنظیمات پیکربندی Google Chat API ذخیره کنید. پس‌از به‌روزرسانی و ذخیره کردن تنظیمات پیکربندی Chat API، برنامه Chat به‌روزشده بلافاصله برای همه کاربران موجود دردسترس قرار می‌گیرد. برای به‌روزرسانی فهرستگان Marketplace، می‌توانید قبل‌از ارسال هرگونه تغییر، پیش‌نویس ایجاد کنید.
• اگر برافزایتان را بااستفاده از Apps Script ساخته‌اید:
  • باید از همان شناسه استقرار Apps Script استفاده کنید که برای بقیه پیکربندی برافزایتان استفاده می‌کنید.
  • نمی‌توانید از ویرایشگر Apps Script برای نصب پیاده‌سازی‌های آزمایشی در Chat استفاده کنید. درعوض، باید آن‌ها را مستقیماً از میانای کاربر Chat نصب کنید.
• اگر برافزایتان را بااستفاده از سرویس HTTP ساخته‌اید، جزئیات پیکربندی برنامه Chat را در مانیفست و استقرارهایی که بااستفاده از میانای برنامه‌سازی کاربردی برافزاهای Google Workspace ایجاد می‌کنید حذف کنید. استقرارهای HTTP که در Google Workspace Marketplace SDK مشخص می‌کنید فقط برای سایر برنامه‌های Google Workspace استفاده می‌شود.

به افراد دیگر اجازه دهید Chat API را پیکربندی کنند

می‌توانید به کاربران خاصی دسترسی به صفحه پیکربندی برنامه Chat بدهید، با اعطای نقش «مدیریت هویت و دسترسی‌ها» (IAM) در Google Cloud مالک برنامه‌های Chat یا بیننده برنامه‌های Chat به آن‌ها. کاربران دارای این نقش‌ها نمی‌توانند بااستفاده از داشبورد میاناهای برنامه‌سازی کاربردی و سرویس‌ها به صفحه پیکربندی برنامه‌های Chat بروند، اما می‌توانند با رفتن به کنسول Google Cloud برای پروژه ابری میزبان برنامه Chat به‌صورت زیر به صفحه پیکربندی دسترسی پیدا کنند:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

که در آن PROJECT_ID شناسه پروژه Google Cloud است که برنامه Chat را میزبانی می‌کند.

موضوعات مرتبط

• انتخاب معماری برنامه Chat
• دریافت و پاسخ دادن به تعاملات کاربر
• آزمایش کردن ویژگی‌های تعاملی برای برنامه‌های Google Chat