نمای کلی Google Chat API

این بخش توضیح می‌دهد که چگونه یک برنامه Google Chat می‌تواند Chat API را فراخوانی کند، که به برنامه‌های Chat اجازه می‌دهد کارهایی مانند ایجاد یک فضا، اضافه کردن افراد به آن و ارسال پیام را انجام دهند.

احراز هویت

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

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

کتابخانه های مشتری

روش توصیه شده برای اکثر توسعه دهندگان برای فراخوانی Google Chat API با کتابخانه های Cloud Client ما برای زبان دلخواه شما مانند Python، جاوا یا Node.js است.

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

مفاهیم API چت گوگل

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

فضاها

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

اعضا

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

پیام ها

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

واکنش ها

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

ایموجی سفارشی (پیش نمایش برنامه نویس)

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

مرجع منبع:

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

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

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

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

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

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

وضعیت خواندن کاربر

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

مرجع منبع وضعیت خواندن فاصله:

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

برای مثال استفاده، نگاه کنید به:

تنظیمات اعلان فضای کاربر (پیش‌نمایش برنامه‌نویس)

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

مرجع منبع:

علاوه بر تماس با Chat API، برنامه‌های چت همچنین می‌توانند:

،

این بخش توضیح می‌دهد که چگونه یک برنامه Google Chat می‌تواند Chat API را فراخوانی کند، که به برنامه‌های Chat اجازه می‌دهد کارهایی مانند ایجاد یک فضا، اضافه کردن افراد به آن و ارسال پیام را انجام دهند.

احراز هویت

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

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

کتابخانه های مشتری

روش توصیه شده برای اکثر توسعه دهندگان برای فراخوانی Google Chat API با کتابخانه های Cloud Client ما برای زبان دلخواه شما مانند Python، جاوا یا Node.js است.

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

مفاهیم API چت گوگل

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

فضاها

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

اعضا

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

پیام ها

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

واکنش ها

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

ایموجی سفارشی (پیش نمایش برنامه نویس)

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

مرجع منبع:

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

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

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

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

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

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

مرجع منبع:

برای مثال استفاده، نگاه کنید به:

وضعیت خواندن کاربر

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

مرجع منبع وضعیت خواندن فاصله:

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

برای مثال استفاده، نگاه کنید به:

تنظیمات اعلان فضای کاربر (پیش‌نمایش برنامه‌نویس)

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

مرجع منبع:

علاوه بر تماس با Chat API، برنامه‌های چت همچنین می‌توانند: