ساختن برنامه Google Chat با Google Apps Script

این صفحه توضیح می‌دهد که چگونه بااستفاده از Google Apps Script برنامه Google Chat بسازید. برنامه Chat به شما امکان می‌دهد مستقیماً پیام دهید و با پژواک کردن پیام‌هایتان پاسخ می‌دهد.

نمودار زیر معماری و الگوی پیام‌رسانی را نشان می‌دهد:

معماری برنامه Chat که با Apps Script پیاده‌سازی شده است.

در نمودار قبلی، کاربری که با برنامه Chat‏ Apps Script تعامل می‌کند جریان اطلاعات زیر را دارد:

  1. کاربری پیامی را به برنامه Chat ارسال می‌کند، چه در پیام مستقیم و چه در فضای Chat.
  2. منطق برنامه Chat که در Apps Script پیاده‌سازی شده است و در Google Cloud قرار دارد، پیام را دریافت و پردازش می‌کند.
  3. به‌صورت اختیاری، منطق برنامه Chat می‌تواند با سرویس‌های Google Workspace، مثل «تقویم» یا «کاربرگ‌نگار»، یا سرویس‌های دیگر Google، مثل Google Maps یا YouTube، ادغام شود.
  4. منطق برنامه Chat پاسخی را به سرویس برنامه Chat در Chat برمی‌گرداند.
  5. پاسخ به کاربر ارائه می‌شود.

اهداف

  • محیط خود را راه‌اندازی کنید.
  • متن راه‌اندازی کنید.
  • برنامه Chat را پیکربندی کنید.
  • برنامه Chat را آزمایش کنید.

پیش‌نیازها

راه‌اندازی محیط

پروژه Cloud خود را در کنسول Google Cloud باز کنید

اگر ازقبل باز نیست، «پروژه ابری» موردنظرتان را برای استفاده در این نمونه باز کنید:

  1. در کنسول Google Cloud، به صفحه انتخاب پروژه بروید.

    انتخاب پروژه Cloud

  2. پروژه Google Cloud موردنظرتان را برای استفاده انتخاب کنید. یا روی ایجاد پروژه کلیک کنید و دستورالعمل‌های روی صفحه را دنبال کنید. اگر پروژه Google Cloud ایجاد کنید، ممکن است لازم باشد صورت‌حساب را برای پروژه روشن کنید.

روشن کردن Chat API

قبل‌از استفاده از «میاناهای برنامه‌سازی کاربردی Google»، باید آن‌ها را در پروژه Google Cloud روشن کنید. می‌توانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.

پیکربندی صفحه کسب رضایت OAuth

همه برنامه‌هایی که از OAuth 2.0 استفاده می‌کنند به پیکربندی صفحه کسب رضایت نیاز دارند. پیکربندی صفحه موافقت OAuth برنامه‌تان مشخص می‌کند چه چیزی به کاربران و بازبینان برنامه نمایش داده شود و برنامه‌تان را ثبت می‌کند تا بتوانید آن را بعداً منتشر کنید.

  1. در «کنسول Google API»، به «منو» > پلاتفرم «احراز هویت Google» > نمانام‌سازی بروید.

    رفتن به نمانام‌سازی

  2. اگر قبلاً پلاتفرم «احراز هویت Google» را پیکربندی کرده‌اید، می‌توانید تنظیمات «صفحه موافقت OAuth» زیر را در نمانام‌سازی، مخاطب، و دسترسی به داده‌ها پیکربندی کنید. اگر پیامی با این مضمون دیدید: پلاتفرم «احراز هویت Google» هنوز پیکربندی نشده است، روی شروع به کار کلیک کنید:
    1. در بخش اطلاعات برنامه، در نام برنامه، نامی برای برنامه وارد کنید.
    2. در ایمیل پشتیبانی کاربر، نشانی ایمیل پشتیبانی را انتخاب کنید که کاربران بتوانند درصورت داشتن سؤال درباره رضایتشان با شما تماس بگیرند.
    3. روی بعدی کلیک کنید.
    4. در بخش مخاطبان، داخلی را انتخاب کنید.
    5. روی بعدی کلیک کنید.
    6. در بخش اطلاعات تماس، نشانی ایمیلی وارد کنید که ازطریق آن بتوانید از هرگونه تغییر در پروژه خود مطلع شوید.
    7. روی بعدی کلیک کنید.
    8. در بخش تکمیل، خط‌مشی داده‌های کاربر سرویس‌های Google API را مرور کنید و درصورت موافقت، با «خط‌مشی داده‌های کاربر سرویس‌های Google API» موافقم را انتخاب کنید.
    9. روی ادامه کلیک کنید.
    10. روی ایجاد کردن کلیک کنید.
  3. درحال‌حاضر می‌توانید از افزودن محدوده‌ها رد شوید. در آینده، وقتی برنامه‌ای برای استفاده در خارج از سازمان Google Workspace خودتان ایجاد می‌کنید، باید نوع کاربر را به خارجی تغییر دهید. سپس محدوده‌های مجوز موردنیاز برنامه‌تان را اضافه کنید. برای کسب اطلاعات بیشتر، راهنمای کامل پیکربندی موافقت OAuth را ببینید.

راه‌اندازی دستورگان

برای راه‌اندازی کردن این متن، از الگوی برنامه Chat در صفحه شروع به کار Apps Script استفاده می‌کنید.

ایجاد پروژه Apps Script

  1. از صفحه شروع به کار Apps Script، به شروع‌کننده‌های برافزای Google Workspace بروید و روی الگوی برنامه Chat کلیک کنید:

    باز کردن الگوی برنامه Chat

  2. در پروژه جدید Apps Script که باز می‌شود، پروژه را نام‌گذاری کنید:

    1. روی پروژه بی‌عنوان کلیک کنید.

    2. در عنوان پروژه، Quickstart app را تایپ کنید.

    3. روی تغییر نام کلیک کنید.

در آینده، اگر بخواهید از برخی‌از Google APIs استفاده کنید یا برنامه‌تان را منتشر کنید، باید پروژه Cloud خود را با پروژه Apps Script مرتبط کنید. برای این راهنما، لازم نیست این کار را انجام دهید. برای کسب اطلاعات بیشتر، راهنمای پروژه‌های Google Cloud را ببینید.

ایجاد استقرار آزمایشی

برای این پروژه «دستورگان برنامه‌ها» به شناسه استقرار نیاز دارید تا بتوانید از آن در مرحله بعد استفاده کنید.

برای دریافت شناسه استقرار سر، کارهای زیر را انجام دهید:

  1. در پروژه برنامه Chat در Apps Script، روی پیاده‌سازی > آزمایش پیاده‌سازی‌ها کلیک کنید.
  2. شناسه استقرار سر را برای استفاده در مرحله بعدی کپی کنید و روی تمام کلیک کنید.

پیکربندی برنامه Chat

برای پیکربندی برنامه Google Chat، مراحل زیر را انجام دهید:

  1. در API Console، Google Chat API را جستجو کنید، و روی Google Chat API کلیک کنید.
  2. روی مدیریت کلیک کنید.
  3. روی پیکربندی کلیک کنید و برنامه Chat را راه‌اندازی کنید:

    1. در فیلد نام برنامه، Quickstart app را وارد کنید.
    2. در فیلد نشانی وب چهرک، https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png را وارد کنید.
    3. در فیلد شرح، Quickstart app را وارد کنید.
    4. در بخش عملکرد، گزینه پیوستن به فضاها و مکالمه‌های گروهی را انتخاب کنید.
    5. در بخش تنظیمات اتصال، پروژه Apps Script را انتخاب کنید.
    6. در فیلد شناسه استقرار، شناسه استقرار «سر» را که قبلاً کپی کرده‌اید جای‌گذاری کنید.
    7. در بخش رؤیت‌پذیری، افراد و گروه‌های خاص در دامنه را انتخاب کنید و ایمیلتان را وارد کنید.
  4. روی ذخیره کلیک کنید.

برنامه Chat آماده پاسخ دادن به پیام‌ها است.

آزمایش کردن برنامه Chat

برای آزمایش برنامه Chat، فضای پیام مستقیمی را با برنامه Chat باز کنید و پیامی ارسال کنید:

  1. بااستفاده از حساب Google Workspace که هنگام اضافه کردن خودتان به‌عنوان آزمایش‌کننده معتمد ارائه کردید، Google Chat را باز کنید.

    رفتن به Google Chat

  2. روی گپ جدید کلیک کنید.
  3. در فیلد افزودن ۱ یا چند نفر، نام برنامه Chat خود را تایپ کنید.
  4. برنامه Chat را از نتایج انتخاب کنید. پیام مستقیمی باز می‌شود.

  5. در پیام مستقیم جدید با برنامه، Hello را تایپ کنید و enter را فشار دهید.

    برنامه Chat از شما برای افزودن آن تشکر می‌کند و پیامتان را تکرار می‌کند.

برای افزودن آزمایش‌گران مطمئن و کسب اطلاعات بیشتر درباره آزمایش ویژگی‌های تعاملی، به آزمایش ویژگی‌های تعاملی برای برنامه‌های Google Chat مراجعه کنید.

عیب‌یابی

وقتی برنامه یا کارت Google Chat خطایی برمی‌گرداند، میانای Chat پیامی را نشان می‌دهد که می‌گوید «مشکلی پیش آمد». یا «نمی‌توانیم درخواستتان را پردازش کنیم.» گاهی‌اوقات «میانای کاربری Chat» هیچ پیام خطایی نمایش نمی‌دهد، اما برنامه Chat یا کارت نتیجه غیرمنتظره‌ای تولید می‌کند؛ برای مثال، ممکن است پیام کارت ظاهر نشود.

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

مرتب‌سازی

برای اینکه هزینه منابع استفاده‌شده در این آموزش به حساب Google Cloud شما اضافه نشود، توصیه می‌کنیم پروژه Cloud را حذف کنید.

  1. در «کنسول Google API»، به صفحه مدیریت منابع بروید. روی منو > IAM و سرپرست > مدیریت منابع کلیک کنید.

    به «مدیر منابع» بروید

  2. در فهرست پروژه، پروژه‌ای را که می‌خواهید حذف کنید انتخاب کنید و سپس روی حذف کلیک کنید.
  3. در چارگوش گفتگو، شناسه پروژه را تایپ کنید و سپس روی خاموش کردن کلیک کنید تا پروژه حذف شود.

مراحل بعدی

  • ایجاد کارت‌های تعاملی–پیام‌های کارت از چیدمان تعریف‌شده، عناصر تعاملی واسط کاربر مانند دکمه‌ها، و رسانه‌های غنی مانند تصاویر پشتیبانی می‌کنند. از پیام‌های کارت برای ارائه اطلاعات دقیق، جمع‌آوری اطلاعات از کاربران، و راهنمایی کاربران برای برداشتن گام بعدی استفاده کنید.
  • پاسخ به فرمان‌ها–فرمان‌ها به کاربران کمک می‌کنند ویژگی‌های کلیدی برنامه Chat شما را کشف و از آن‌ها استفاده کنند.
  • راه‌اندازی چارگوش‌های گفتگو–چارگوش‌های گفتگو رابط‌های مبتنی بر کارت و پنجره‌ای هستند که برنامه‌تان می‌تواند برای تعامل با کاربر باز کند. چندین کارت را می‌توان به‌صورت متوالی به هم متصل کرد، که به کاربران کمک می‌کند فرایندهای چندمرحله‌ای، مانند تکمیل داده‌های فرم، را انجام دهند.
  • Codelab: آماده‌اید برنامه «گپ» پیشرفته‌تری بسازید؟ بازخورد برنامه Chat را از آزمایش کد ساختن برنامه برای Google Chat با Gemini ببینید.

برنامه‌های گپ که برافزا نیستند: ساختن برنامه Google Chat با Google Apps Script

برای ساختن برنامه Chat که برافزای Google Workspace نباشد با Apps Script، این مراحل را دنبال کنید تا نوشتار را از الگو ایجاد کنید و برنامه Chat را که برافزا نیست پیکربندی کنید.

ساختن دستورگان از الگو

  1. به صفحه شروع به کار با Apps Script بروید.
  2. در بالای صفحه، روی الگوی برنامه Chat کلیک کنید.
  3. روی پروژه بدون عنوان کلیک کنید، Quickstart app را تایپ کنید، و روی تغییر نام کلیک کنید.

    در آینده، اگر بخواهید از برخی‌از Google APIs استفاده کنید یا برنامه‌تان را منتشر کنید، باید پروژه Cloud خود را با پروژه Apps Script مرتبط کنید. برای این راهنما، لازم نیست این کار را انجام دهید. برای کسب اطلاعات بیشتر، راهنمای پروژه‌های Google Cloud را ببینید.

  4. در پروژه برنامه Chat در Apps Script، روی پیاده‌سازی > پیاده‌سازی‌های آزمایشی کلیک کنید.

  5. شناسه استقرار سر را برای استفاده در مرحله بعدی کپی کنید و روی انجام شد کلیک کنید.

پیکربندی برنامه Chat که برافزا نیست

برنامه Chat را که برافزایی از «کنسول API» نیست پیکربندی کنید:

  1. در API Console، Google Chat API را جستجو کنید و روی Google Chat API کلیک کنید.
  2. روی مدیریت کلیک کنید.
  3. روی پیکربندی کلیک کنید و برنامه Chat را که برافزا نیست راه‌اندازی کنید:

    1. ساخت این برنامه Chat به‌عنوان برافزای Google Workspace را لغو انتخاب کنید. کادر گفتگویی باز می‌شود که از شما می‌خواهد تأیید کنید. در چارگوش گفتگو، روی غیرفعال کردن کلیک کنید.
    2. در فیلد نام برنامه، Quickstart app را وارد کنید.
    3. در فیلد نشانی وب چهرک، https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png را وارد کنید.
    4. در فیلد شرح، Quickstart app را وارد کنید.
    5. در بخش عملکرد، گزینه پیوستن به فضاها و مکالمه‌های گروهی را انتخاب کنید.
    6. در بخش تنظیمات اتصال، Apps Script را انتخاب کنید.
    7. در فیلد شناسه استقرار، شناسه استقرار «سر» را که قبلاً کپی کرده‌اید جای‌گذاری کنید.
    8. در بخش رؤیت‌پذیری، افراد و گروه‌های خاص در دامنه را انتخاب کنید و ایمیلتان را وارد کنید.
  4. روی ذخیره کلیک کنید.