يشرح هذا الدليل كيفية استخدام طريقة get
على مورد Message
الخاص بـ
Google Chat API لعرض تفاصيل حول رسالة نصية أو بطاقة.
تشير رسالة الأشكال البيانية
مرجع Message
يمثل
نص
أو
بطاقة
في Google Chat. يمكنك
create
أو get
أو update
أو delete
رسالة في Google Chat API من خلال طلب
الطرق المقابلة. لمعرفة المزيد من المعلومات عن الرسائل النصية ورسائل البطاقة، يمكنك الاطّلاع على
نظرة عامة على رسائل Google Chat
المتطلبات الأساسية
Python
- نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى Google Chat
- Python 3.6 أو أحدث
- أداة إدارة حزم pip
- أحدث مكتبات عملاء Google. لتثبيت التطبيقات أو تحديثها،
قم بتشغيل الأمر التالي في واجهة سطر الأوامر:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- إعداد البيئة:
- أنشِئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- تفعيل Google Chat API وضبطه باستخدام اسم ورمزه ووصفه لتطبيق Chat.
- يمكنك إنشاء بيانات اعتماد الوصول استنادًا إلى طريقة المصادقة في طلب Google Chat API:
- للمصادقة كمستخدم Chat،
إنشاء معرِّف عميل OAuth
بيانات الاعتماد وحفظ بيانات الاعتماد كملف JSON
client_secrets.json
إلى الدليل المحلي. - للمصادقة كتطبيق Chat، اتّبِع الخطوات التالية: إنشاء حساب خدمة بيانات الاعتماد.
- للمصادقة كمستخدم Chat،
إنشاء معرِّف عميل OAuth
بيانات الاعتماد وحفظ بيانات الاعتماد كملف JSON
- اختر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو تطبيق Chat
تلقّي رسالة تتضمّن مصادقة المستخدم
للحصول على تفاصيل حول رسالة مع مصادقة المستخدم، تمرير ما يلي في طلبك:
- حدِّد نطاق التفويض
chat.messages.readonly
أوchat.messages
. - عليك استدعاء
طريقة
get
في صفحة مرجع واحد (Message
) - اضبط
name
على اسم مورد الرسالة التي تريد الحصول عليها.
يحصل المثال التالي على رسالة تحتوي على مصادقة المستخدم:
Python
- في دليل العمل، أنشِئ ملفًا باسم "
chat_message_get_user.py
". أدرِج الرمز التالي في
chat_message_get_user.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 gets a message. ''' # 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().get( # The message to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints details about the message. print(result) if __name__ == '__main__': main()
في الرمز، استبدل ما يلي:
SPACE
: اسم مساحة يمكنك الحصول عليه من الـ طريقة واحدة (spaces.list
) في Chat API أو من عنوان URL للمساحة.MESSAGE
: اسم رسالة يمكنك الحصول عليه من نص الاستجابة الذي تم عرضه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API أو باستخدام اسم مخصّص المخصص للرسالة عند الإنشاء.
في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_message_get_user.py
تعرض واجهة برمجة التطبيقات Chat مثيلاً من
Message
الذي يوضح بالتفصيل الرسالة المحددة.
تلقّي رسالة تتضمّن مصادقة التطبيقات
للحصول على تفاصيل حول رسالة مع مصادقة التطبيقات تمرير ما يلي في طلبك:
- حدِّد نطاق تفويض
chat.bot
. - عليك استدعاء
طريقة
get
في صفحة مرجع واحد (Message
) - اضبط
name
على اسم مورد الرسالة التي تريد الحصول عليها.
يحصل المثال التالي على رسالة تحتوي على مصادقة التطبيقات:
Python
- في دليل العمل، أنشِئ ملفًا باسم "
chat_get_message_app.py
". أدرِج الرمز التالي في
chat_get_message_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Get a Chat message. result = chat.spaces().messages().get( # The message to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE' ).execute() # Print Chat API's response in your command line interface. print(result)
في الرمز، استبدل ما يلي:
SPACE
:name
للمساحة حيث التي يمكنك الحصول عليها من طريقةspaces.list
في Chat API أو من عنوان URL للمساحة.MESSAGE
: اسم الرسالة، الذي يمكنك الحصول عليه من نص الاستجابة الذي تم عرضه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API أو باستخدام اسم مخصّص المخصص للرسالة عند الإنشاء.
في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_get_message_app.py
تعرض واجهة برمجة التطبيقات Chat مثيلاً من
Message
الذي يوضح بالتفصيل الرسالة المحددة.