با Google Chat توسعه دهید

این صفحه مروری بر API چت گوگل و برنامه‌های چت گوگل ارائه می‌دهد.

مرور کلی API چت گوگل

API چت شامل سرویس‌های gRPC یا منابع و متدهای REST است که دسترسی به چت را فراهم می‌کنند، از جمله فاصله‌ها، اعضای فاصله، پیام‌ها، واکنش‌ها به پیام، پیوست‌های پیام، رویدادهای فاصله و حالت‌های خواندن کاربر.

مفاهیم

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

فضاها

فضاها مکان‌هایی هستند که افراد و برنامه‌ها می‌توانند در آنها گفتگو کرده و فایل‌ها را به اشتراک بگذارند. انواع مختلفی از فضاها وجود دارد. پیام‌های مستقیم (DM) مکالمات یک به یک بین دو کاربر یا یک کاربر و یک برنامه چت هستند. چت‌های گروهی مکالمات بین سه یا چند کاربر و برنامه‌های چت هستند. فضاهای نامگذاری شده مکان‌های پایداری هستند که افراد در آنها پیام ارسال می‌کنند، فایل‌ها را به اشتراک می‌گذارند و با یکدیگر همکاری می‌کنند.

مرجع منابع:

برای مثال، موارد زیر را ببینید:

اعضا

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

مرجع منابع:

برای مثال، موارد زیر را ببینید:

پیام‌ها

پیام‌ها شامل ارتباطات متنی و کارتی هستند که در فضاها ارسال می‌شوند. پیام‌ها می‌توانند فایل‌هایی را به خود پیوست کنند. افراد می‌توانند با افزودن ایموجی به پیام‌ها، به آنها واکنش نشان دهند.

مرجع منابع:

برای مثال، موارد زیر را ببینید:

واکنش‌ها

واکنش‌ها (Reactions) نشان‌دهنده‌ی ایموجی‌هایی هستند که افراد برای واکنش به یک پیام استفاده می‌کنند، مانند 👍، 🚲 و 🌞.

مرجع منابع:

برای مثال، موارد زیر را ببینید:

ایموجی‌های سفارشی

ایموجی‌های سفارشی نشان‌دهنده‌ی ایموجی‌های سفارشی ایجاد شده و به اشتراک گذاشته شده در سازمان در گوگل چت هستند. ایموجی‌های سفارشی می‌توانند در محتوای یک پیام گنجانده شوند یا برای واکنش به یک پیام استفاده شوند.

مرجع منابع:

برای مثال، موارد زیر را ببینید:

رسانه‌ها و پیوست‌ها

رسانه نشان‌دهنده فایلی است که در گوگل چت آپلود شده است، مانند تصاویر، ویدیوها و اسناد.

مرجع منابع رسانه‌ای (در RPC در دسترس نیست):

پیوست‌ها نمونه‌هایی از رسانه‌ها (فایل‌ها) هستند که به پیام‌ها پیوست شده‌اند.

مرجع منابع:

برای مثال، موارد زیر را ببینید:

رویدادهای فضایی

رویدادهای فضایی نشان‌دهنده تغییرات در یک فضا یا منابع زیرمجموعه آن، از جمله اعضا، پیام‌ها و واکنش‌های آن هستند.

مرجع منابع:

برای مثال، موارد زیر را ببینید:

کاربر حالت‌های خوانده شده را می‌خواند

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

مرجع منابع حالت خواندن فضا:

مرجع منابع وضعیت خوانده شده‌ی نخ:

برای مثال، موارد زیر را ببینید:

تنظیمات اعلان فضای کاربری

تنظیمات اعلان فضای کاربری، منابع تک‌گانه هستند که نشان‌دهنده تنظیمات اعلان کاربر مشخص‌شده در فضای چت گوگل می‌باشند.

مرجع منابع:

احراز هویت

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

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

کتابخانه‌های کلاینت

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

اگر با Google Apps Script کدنویسی می‌کنید، به جای نصب کتابخانه کلاینت، از سرویس Advanced Chat استفاده کنید.

ساخت برنامه‌های چت

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

  • بازیابی اطلاعات بر اساس پرس‌وجوهای متن آزاد یا ساختاریافته وارد شده توسط کاربر.
  • با استفاده از اطلاعات ارائه شده توسط کاربر، گزارش‌های حادثه یا سایر مصنوعات را تولید کنید.
  • همکاری تیمی را افزایش دهید، مانند ارائه «حافظه تیمی» یا برنامه‌ریزی منابع.

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

  • برنامه‌های تعاملی : به تعاملات کاربر، مانند @mentions یا دستورات اسلش، پاسخ می‌دهند و با کارت‌ها و دیالوگ‌ها، اطلاعات را ارائه می‌دهند یا کاربران را در یک گردش کار راهنمایی می‌کنند.
  • برنامه‌های خط فرمان یا وب‌هوک‌ها : پیام‌های پیشگیرانه، مانند هشدارها یا اعلان‌ها، را از سیستم دیگری به یک فضا ارسال می‌کنند. کاربران نمی‌توانند مستقیماً با این نوع برنامه‌ها تعامل داشته باشند.
  • برنامه‌های مبتنی بر رویداد : در یک فضای چت، مانند پیوستن یک عضو جدید، در فعالیت‌ها مشترک شده و به آنها واکنش نشان می‌دهند. در پاسخ به یک رویداد، برنامه می‌تواند پیامی ارسال کند یا اقدام دیگری انجام دهد.

برای جزئیات بیشتر در مورد طراحی برنامه چت خود، به «انتخاب معماری برنامه چت گوگل» مراجعه کنید.

می‌خواهید API چت گوگل را در عمل ببینید؟
کانال توسعه‌دهندگان فضای کاری گوگل ویدیوهایی درباره نکات، ترفندها و جدیدترین ویژگی‌ها ارائه می‌دهد.