این بخش توضیح میدهد که چگونه یک برنامه Google Chat میتواند Chat API را فراخوانی کند، که به برنامههای Chat اجازه میدهد کارهایی مانند ایجاد یک فضا، اضافه کردن افراد به آن و ارسال یک پیام را بدون درخواست یک رویداد تعامل برنامه Chat انجام دهند.
احراز هویت
فراخوانی Chat API به صورت ناهمزمان نیاز به احراز هویت دارد. هر روش Chat API به احراز هویت کاربر (برای انجام اقدامات یا دسترسی به دادهها از طرف یک کاربر) یا تأیید اعتبار برنامه (برای انجام اقدامات یا دسترسی به دادهها به عنوان برنامه چت) نیاز دارد. برخی از روش ها هم از احراز هویت کاربر و هم از تأیید اعتبار برنامه پشتیبانی می کنند.
برای کسب اطلاعات بیشتر درباره احراز هویت در چت، به نمای کلی احراز هویت مراجعه کنید.
منابع و روش های API
منابع و روشهای REST به فضاهای چت، اعضای فضا، پیامها، واکنشهای پیام و پیوستهای پیام دسترسی ناهمزمان میدهند.
- فضاها
فضاها مکانهایی هستند که افراد و برنامهها میتوانند با هم گفتگو کرده و فایلها را به اشتراک بگذارند. چند نوع فضا وجود دارد. پیامهای مستقیم (DM) مکالمات 1:1 بین دو کاربر یا یک کاربر و یک برنامه چت هستند. چت گروهی مکالمه بین سه یا چند کاربر و برنامه های چت است. فضاهای نامگذاری شده مکانهایی هستند که افراد در آن پیام میفرستند، فایلها را به اشتراک میگذارند و همکاری میکنند.
منبع
spaces
یک فضا را نشان می دهد.Spaces از روش های زیر پشتیبانی می کند:
- فضایی ایجاد کنید ، مکانی که افراد و برنامهها بتوانند در آن مکالمه کنند و فایلها را به اشتراک بگذارند.
- فضایی را برای ایجاد فضا تنظیم کنید و افراد و برنامههای چت را به آن فضا اضافه کنید.
- برای مشاهده جزئیات یک فضا فضایی دریافت کنید .
- فضاها را فهرست کنید تا یک لیست صفحه بندی شده و قابل فیلتر از فضاها را ببینید.
- برای تغییر ویژگیهای یک فضا، مانند نام نمایشی قابل مشاهده توسط کاربر، توضیحات و دستورالعملها، یک فاصله را بهروزرسانی کنید .
- زمانی که فضای خالی دیگر مورد نیاز نیست حذف کنید .
- یک پیام مستقیم (DM) برای بازگرداندن DM بین دو کاربر یا یک پیام پیام بین کاربر و برنامههای چت در حال تماس پیدا کنید .
- اعضا
اعضا کاربران و برنامههای چت هستند که به یک فضا پیوستهاند یا به آن دعوت شدهاند.
منبع
spaces.members
نماینده یک عضو است.اعضا از روش های زیر پشتیبانی می کنند:
- برای افزودن کاربر یا برنامه به فضا ، عضویت ایجاد کنید .
- برای مشاهده جزئیات عضویت ، عضویت دریافت کنید .
- عضویت ها را فهرست کنید تا فهرستی صفحه بندی شده و قابل فیلتر از عضویت ها را در یک فضا ببینید.
- عضویت را بهروزرسانی کنید تا ویژگیهای عضویت را تغییر دهید، مانند تغییر یک عضو فضایی به مدیر فضایی یا تغییر مدیر فضایی به عضو فضایی.
- برای حذف کاربر یا برنامه از یک فضا ، عضویت را حذف کنید .
- پیام ها
پیامها شامل پیامهای متنی و کارتی هستند که در فضاها ارسال میشوند. پیامها میتوانند فایلهایی به آنها پیوست داشته باشند. افراد می توانند با اضافه کردن ایموجی به پیام ها به آنها واکنش نشان دهند.
منبع
spaces.messages
یک پیام را نشان می دهد.پیام ها از روش های زیر پشتیبانی می کنند:
- یک پیام برای ارسال پیام متنی یا کارت ایجاد کنید. همچنین می توانید یک رشته پیام را شروع کنید یا به آن پاسخ دهید .
- برای دریافت جزئیات پیام، مانند زمان ارسال یا آنچه در آن نوشته شده است ، پیامی دریافت کنید .
- پیامها را فهرست کنید تا یک فهرست صفحهبندیشده و قابل فیلتر از پیامها را در یک فاصله ببینید.
- برای تغییر ویژگی های پیام، مانند آنچه می گوید ، یک پیام را به روز کنید . همچنین می توانید متن را به پیام کارت یا کارت به پیام متنی اضافه کنید.
- وقتی پیامی دیگر مورد نیاز نیست، آن را حذف کنید .
- واکنش ها
واکنشها نشاندهنده شکلکهایی هستند که افراد برای واکنش به یک پیام استفاده میکنند، مانند 👍، 🚲، و 🌞.
منبع
spaces.messages.reactions
یک واکنش را نشان می دهد.واکنش ها از روش های زیر پشتیبانی می کنند:
- برای افزودن یک ایموجی به پیام واکنشی ایجاد کنید .
- برای مشاهده یک لیست صفحه بندی شده و قابل فیلتر از واکنش ها به یک پیام، واکنش ها را فهرست کنید .
- حذف یک واکنش برای حذف یک ایموجی از پیام.
- رسانه ها و پیوست ها
رسانه فایلی را نشان میدهد که در چت Google آپلود شده است، مانند تصاویر، ویدیوها و اسناد.
منبع
media
نشان دهنده رسانه متصل به پیام است.پیوست ها نمونه هایی از رسانه (فایل) هستند که به پیام ها پیوست شده اند.
منبع
spaces.messages.attachments
یک پیوست را نشان می دهد. پیوست شامل رسانه و ابرداده مرتبط با پیام است.رسانه ها و پیوست ها از روش های زیر پشتیبانی می کنند:
- برای آپلود رسانه در Google Chat، رسانه را به عنوان یک پیوست آپلود کنید و سپس آن را به یک پیام پیوست کنید.
- برای دانلود رسانه از Google Chat به عنوان یک فایل باینری، رسانه را به عنوان یک پیوست دانلود کنید.
- برای بازیابی متادیتا درباره پیوست پیام ، پیوست دریافت کنید .
- رویدادهای فضایی
رویدادهای فضایی نشان دهنده تغییرات در یک فضا یا منابع فرزند آن، از جمله اعضا، پیام ها و واکنش های آن است.
منبع
spaces.spaceEvent
یک رویداد فضایی را نشان می دهد.رویدادهای فضایی از روشهای زیر پشتیبانی میکنند:
- یک رویداد فضایی برای بازگرداندن جزئیات رویدادی که در یک فضا رخ داده است، دریافت کنید .
- رویدادهای فضایی را فهرست کنید تا لیستی از رویدادهایی که در یک فضا رخ داده اند به دست آورید.
- وضعیت خواندن کاربر
وضعیتهای خواندن کاربر منابع تکی هستند که جزئیات مربوط به آخرین پیام خوانده شده کاربر مشخص شده در فضای چت Google یا رشته پیام را نشان میدهند.
منبع
users.spaces
وضعیت خواندن کاربر را در یک فاصله نشان می دهد.منبع
users.spaces.threads
وضعیت خواندن کاربر را در یک رشته پیام نشان می دهد.حالت های خواندن کاربر از روش های زیر پشتیبانی می کنند:
- برای بازگرداندن جزئیات وضعیت خواندن کاربر در یک فاصله، وضعیت خواندن فاصله را دریافت کنید .
- وضعیت خواندن فضا را بهروزرسانی کنید تا وضعیت خواندن کاربر در یک فاصله بهروزرسانی شود.
- وضعیت خواندن رشته را دریافت کنید تا جزئیات مربوط به وضعیت خواندن کاربر در یک رشته را بازگردانید.