نمای کلی Google Chat API

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

احراز هویت

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

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

منابع و روش های API

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

فضاها

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

منبع spaces یک فضا را نشان می دهد.

Spaces از روش های زیر پشتیبانی می کند:

اعضا

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

منبع spaces.members نماینده یک عضو است.

اعضا از روش های زیر پشتیبانی می کنند:

پیام ها

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

منبع spaces.messages یک پیام را نشان می دهد.

پیام ها از روش های زیر پشتیبانی می کنند:

واکنش ها

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

منبع spaces.messages.reactions یک واکنش را نشان می دهد.

واکنش ها از روش های زیر پشتیبانی می کنند:

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

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

منبع media نشان دهنده رسانه متصل به پیام است.

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

منبع spaces.messages.attachments یک پیوست را نشان می دهد. پیوست شامل رسانه و ابرداده مرتبط با پیام است.

رسانه ها و پیوست ها از روش های زیر پشتیبانی می کنند:

وضعیت های خواندن کاربر (پیش نمایش برنامه نویس)

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

منبع users.spaces وضعیت خواندن کاربر را در یک فاصله نشان می دهد.

منبع users.spaces.threads وضعیت خواندن کاربر را در یک رشته پیام نشان می دهد.

حالت های خواندن کاربر از روش های زیر پشتیبانی می کنند:

سند کشف را پیدا کنید

سند کشف این API در URL زیر قرار دارد: