الحصول على تفاصيل حول رسالة

يشرح هذا الدليل كيفية استخدام طريقة get على مورد Message الخاص بـ Google Chat API لعرض تفاصيل حول رسالة نصية أو بطاقة.

في Chat API، يتم تمثيل رسالة Chat من خلال مرجع Message يمكن لمستخدمي Chat إرسال الرسائل التي تحتوي على نصوص فقط، يمكن لتطبيقات Chat استخدام العديد من ميزات المراسلة الأخرى، بما في ذلك تعرض واجهات مستخدم ثابتة أو تفاعلية، تجمع المعلومات من والمستخدمين، وتسليم الرسائل بشكل خاص. لمعرفة المزيد من المعلومات عن المراسلة الميزات المتوفرة في Chat API، يمكنك الاطّلاع على نظرة عامة على رسائل Google Chat

المتطلبات الأساسية

Python

تلقّي رسالة تتضمّن مصادقة المستخدم

للحصول على تفاصيل حول رسالة مع مصادقة المستخدم، قم بتمرير ما يلي في طلبك:

  • حدِّد نطاق التفويض chat.messages.readonly أو chat.messages.
  • عليك استدعاء طريقة get في صفحة مرجع واحد (Message)
  • اضبط name على اسم مورد الرسالة التي تريد الحصول عليها.

يحصل المثال التالي على رسالة تحتوي على مصادقة المستخدم:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم "chat_message_get_user.py".

  2. أدرِج الرمز التالي في 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()

  3. في الرمز، استبدل ما يلي:

    • SPACE: اسم مساحة يمكنك الحصول عليه من الـ طريقة واحدة (spaces.list) في Chat API أو من عنوان URL للمساحة.
    • MESSAGE: اسم رسالة يمكنك الحصول عليه من نص الاستجابة الذي تم عرضه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API أو باستخدام اسم مخصّص المخصص للرسالة عند الإنشاء.

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_message_get_user.py

تعرض واجهة برمجة التطبيقات Chat مثيلاً من Message الذي يوضح بالتفصيل الرسالة المحددة.

تلقّي رسالة تتضمّن مصادقة التطبيقات

للحصول على تفاصيل حول رسالة مع مصادقة التطبيقات قم بتمرير ما يلي في طلبك:

  • حدِّد نطاق تفويض chat.bot.
  • عليك استدعاء طريقة get في صفحة مرجع واحد (Message)
  • اضبط name على اسم مورد الرسالة التي تريد الحصول عليها.

يحصل المثال التالي على رسالة تحتوي على مصادقة التطبيقات:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم "chat_get_message_app.py".

  2. أدرِج الرمز التالي في 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)

  3. في الرمز، استبدل ما يلي:

    • SPACE: name للمساحة حيث التي يمكنك الحصول عليها من طريقة spaces.list في Chat API أو من عنوان URL للمساحة.

    • MESSAGE: اسم الرسالة، الذي يمكنك الحصول عليه من نص الاستجابة الذي تم عرضه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API أو باستخدام اسم مخصّص المخصص للرسالة عند الإنشاء.

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_get_message_app.py

تعرض واجهة برمجة التطبيقات Chat مثيلاً من Message الذي يوضح بالتفصيل الرسالة المحددة.