این راهنما نحوه استفاده از متد list()
را در منبع Message
Google Chat API برای دیدن فهرست صفحهبندیشده و قابل فیلتر پیامها در یک فضا توضیح میدهد.
در Chat API، یک پیام Chat توسط منبع Message
نمایش داده می شود. در حالی که کاربران چت فقط میتوانند پیامهایی ارسال کنند که حاوی متن هستند، برنامههای چت میتوانند از بسیاری از ویژگیهای پیامرسانی دیگر، از جمله نمایش رابطهای کاربری استاتیک یا تعاملی، جمعآوری اطلاعات از کاربران، و ارسال پیامها به صورت خصوصی استفاده کنند. برای اطلاعات بیشتر درباره ویژگیهای پیامرسانی موجود برای Chat API، به نمای کلی پیامهای گپ Google مراجعه کنید.
پیش نیازها
Node.js
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- Node.js Cloud Client Library را نصب کنید.
- شناسه مشتری OAuth را برای یک برنامه دسکتاپ ایجاد کنید . برای اجرای نمونه در این راهنما، اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
- فضای چت گوگل. برای ایجاد یکی با استفاده از Google Chat API، به ایجاد فضا مراجعه کنید. برای ایجاد یکی در چت، از مستندات مرکز راهنمایی دیدن کنید.
پایتون
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Client Python Cloud را نصب کنید.
- شناسه مشتری OAuth را برای یک برنامه دسکتاپ ایجاد کنید . برای اجرای نمونه در این راهنما، اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
- فضای چت گوگل. برای ایجاد یکی با استفاده از Google Chat API، به ایجاد فضا مراجعه کنید. برای ایجاد یکی در چت، از مستندات مرکز راهنمایی دیدن کنید.
جاوا
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Java Cloud Client را نصب کنید.
- شناسه مشتری OAuth را برای یک برنامه دسکتاپ ایجاد کنید . برای اجرای نمونه در این راهنما، اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
- فضای چت گوگل. برای ایجاد یکی با استفاده از Google Chat API، به ایجاد فضا مراجعه کنید. برای ایجاد یکی در چت، از مستندات مرکز راهنمایی دیدن کنید.
اسکریپت برنامه ها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- یک پروژه Apps Script مستقل ایجاد کنید و سرویس گفتگوی پیشرفته را روشن کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
- فضای چت گوگل. برای ایجاد یکی با استفاده از Google Chat API، به ایجاد فضا مراجعه کنید. برای ایجاد یکی در چت، از مستندات مرکز راهنمایی دیدن کنید.
لیست پیام ها
برای فهرست کردن پیامها با احراز هویت کاربر ، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز
chat.messages.readonly
یاchat.messages
را مشخص کنید. - متد
ListMessages()
را فراخوانی کنید.
مثال زیر پیامهای موجود در فضای چت را فهرست میکند:
Node.js
پایتون
جاوا
اسکریپت برنامه ها
برای اجرای این نمونه، SPACE_NAME
با شناسه فیلد name
فضا جایگزین کنید. شما می توانید شناسه را با فراخوانی متد ListSpaces()
یا از URL فضا بدست آورید.
Chat API لیستی از پیام های ارسال شده در فضای مشخص شده را برمی گرداند. اگر هیچ پیامی از درخواست وجود نداشته باشد، پاسخ Chat API یک شی خالی را برمیگرداند. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی، {}
است.
موضوعات مرتبط
- یک پیام را قالب بندی کنید .
- یک پیام را حذف کنید .
- دریافت جزئیات در مورد یک پیام
- یک پیام را به روز کنید .
- پیام بدید .