با Google Apps Script یک برنامه Google Chat بسازید

یک برنامه گوگل چت بسازید که بتوانید مستقیماً به آن پیام دهید و با انعکاس پیام‌های شما پاسخ دهد.

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

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

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

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

اهداف

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

پیش‌نیازها

محیط خود را تنظیم کنید

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

اگر هنوز باز نشده است، پروژه ابری که قصد دارید برای این نمونه استفاده کنید را باز کنید:

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

    یک پروژه ابری انتخاب کنید

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

فعال کردن API چت

قبل از استفاده از APIهای گوگل، باید آنها را در یک پروژه گوگل کلود فعال کنید. می‌توانید یک یا چند API را در یک پروژه گوگل کلود فعال کنید.

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

  1. در کنسول گوگل کلود، به Menu > برویدGoogle Auth platform > برندسازی .

    به بخش برندسازی بروید

  2. اگر قبلاً تنظیمات را انجام داده‌اید Google Auth platformمی‌توانید تنظیمات صفحه رضایت OAuth زیر را در Branding ، Audience و Data Access پیکربندی کنید. اگر پیامی با این مضمون مشاهده کردید Google Auth platform هنوز پیکربندی نشده است ، روی شروع کار کلیک کنید:
    1. در قسمت اطلاعات برنامه ، در قسمت نام برنامه ، نامی برای برنامه وارد کنید.
    2. در ایمیل پشتیبانی کاربر ، یک آدرس ایمیل پشتیبانی انتخاب کنید که کاربران در صورت داشتن هرگونه سوال در مورد رضایت خود بتوانند با شما تماس بگیرند.
    3. روی بعدی کلیک کنید.
    4. در قسمت مخاطبان ، داخلی (Internal) را انتخاب کنید.
    5. روی بعدی کلیک کنید.
    6. در قسمت اطلاعات تماس ، یک آدرس ایمیل وارد کنید که از طریق آن بتوانید از هرگونه تغییر در پروژه خود مطلع شوید.
    7. روی بعدی کلیک کنید.
    8. در قسمت Finish ، سیاست داده‌های کاربر سرویس‌های API گوگل را مرور کنید و در صورت موافقت، گزینه «من با سیاست‌های داده‌های کاربر سرویس‌های API گوگل موافقم» را انتخاب کنید.
    9. روی ادامه کلیک کنید.
    10. روی ایجاد کلیک کنید.
  3. فعلاً می‌توانید از اضافه کردن محدوده‌ها صرف نظر کنید. در آینده، وقتی برنامه‌ای برای استفاده در خارج از سازمان Google Workspace خود ایجاد می‌کنید، باید نوع کاربر (User type) را به خارجی (External) تغییر دهید. سپس محدوده‌های مجوز مورد نیاز برنامه خود را اضافه کنید. برای کسب اطلاعات بیشتر، به راهنمای کامل پیکربندی رضایت OAuth مراجعه کنید.

اسکریپت را تنظیم کنید

برای تنظیم اسکریپت، از یک الگو استفاده می‌کنید و سپس پروژه Cloud خود را در Apps Script تنظیم می‌کنید.

اسکریپت را از روی الگو ایجاد کنید

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

شماره پروژه ابری را کپی کنید

  1. در کنسول گوگل کلود، به Menu > IAM & Admin > Settings بروید.

    به تنظیمات IAM و مدیریت بروید

  2. در فیلد شماره پروژه ، مقدار را کپی کنید.

پروژه Cloud مربوط به پروژه Apps Script را تنظیم کنید.

  1. در پروژه‌ی اسکریپت برنامه‌های چت، روی تنظیمات پروژه کلیک کنید. آیکون مربوط به تنظیمات پروژه .
  2. در زیر پروژه پلتفرم ابری گوگل (GCP) ، روی تغییر پروژه کلیک کنید.
  3. در قسمت شماره پروژه GCP ، شماره پروژه Google Cloud را وارد کنید.
  4. روی تنظیم پروژه کلیک کنید.

اکنون کد برنامه‌ی کاربردی دارید که می‌توانید آن را امتحان کنید (همانطور که در مراحل بعدی توضیح داده شده است) و سپس آن را مطابق با نیازهای خود سفارشی کنید.

هنگام باز کردن الگوی Apps Script، مطمئن شوید که با حساب گوگل صحیح وارد شده‌اید. گاهی اوقات حساب فعلی می‌تواند بدون اینکه متوجه شوید، به حساب پیش‌فرض شما تغییر کند.

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

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

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

  1. در پروژه‌ی اسکریپت برنامه‌های چت، روی Deploy > Test deployments کلیک کنید.
  2. شناسه استقرار Head را برای استفاده در مرحله بعد کپی کنید و روی Done کلیک کنید.

انتشار برنامه چت

برنامه چت را از کنسول منتشر کنید.

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

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

برنامه چت آماده پاسخگویی به پیام‌ها است.

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

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

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

    به گوگل چت بروید

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

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

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

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

عیب‌یابی

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

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

تمیز کردن

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

  1. در کنسول گوگل کلود، به صفحه مدیریت منابع بروید. روی منو > مدیریت و دسترسی به منابع (IAM & Admin) > مدیریت منابع (Manage Resources) کلیک کنید.

    به مدیریت منابع بروید

  2. در لیست پروژه‌ها، پروژه‌ای را که می‌خواهید حذف کنید انتخاب کنید و سپس روی «حذف کلیک کنید.
  3. در کادر محاوره‌ای، شناسه پروژه را تایپ کنید و سپس برای حذف پروژه، روی خاموش کردن (Shut down) کلیک کنید.

مراحل بعدی

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