این راهنما نحوه استفاده از روش list
در منبع Message
Google Chat API برای دیدن فهرست صفحهبندیشده و قابل فیلتر پیامها در یک فضا توضیح میدهد.
در Chat API، یک پیام Chat توسط منبع Message
نمایش داده می شود. در حالی که کاربران چت فقط میتوانند پیامهایی ارسال کنند که حاوی متن هستند، برنامههای چت میتوانند از بسیاری از ویژگیهای پیامرسانی دیگر، از جمله نمایش رابطهای کاربری استاتیک یا تعاملی، جمعآوری اطلاعات از کاربران، و ارسال پیامها به صورت خصوصی استفاده کنند. برای اطلاعات بیشتر درباره ویژگیهای پیامرسانی موجود برای Chat API، به نمای کلی پیامهای گپ Google مراجعه کنید.
پیش نیازها
پایتون
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Google API Client Python را نصب کنید.
- شناسه مشتری OAuth را برای یک برنامه دسکتاپ ایجاد کنید . برای اجرای نمونه در این راهنما، اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
لیست پیام ها
برای فهرست کردن پیامها با احراز هویت کاربر ، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز
chat.messages.readonly
یاchat.messages
را مشخص کنید. - روش
list
موجود در منبعMessage
را فراخوانی کنید.
مثال زیر پیامهایی را در فضای گپ ارسال شده پس از ۱۶ مارس ۲۰۲۳ فهرست میکند:
پایتون
- در پوشه کاری خود، یک فایل با نام
chat_messages_list.py
ایجاد کنید. کد زیر را در
chat_messages_list.py
قرار دهید:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists messages in a space sent after March 16, 2023. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().messages().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints the list of messages. print(result) if __name__ == '__main__': main()
در کد،
SPACE
با یک نام فاصله جایگزین کنید، که می توانید آن را از روشspaces.list
در Chat API یا از URL یک فضا دریافت کنید.در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_messages_list.py
Chat API فهرستی از پیامهای ارسال شده در فضای مشخصشده را پس از ۱۶ مارس ۲۰۲۳ برمیگرداند. اگر هیچ پیامی از درخواست وجود نداشته باشد، پاسخ Chat API یک شی خالی را برمیگرداند. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی، {}
است.
موضوعات مرتبط
- یک پیام را قالب بندی کنید .
- یک پیام را حذف کنید .
- دریافت جزئیات در مورد یک پیام
- یک پیام را به روز کنید .
- پیام بدید .