حذف رسالة

يوضّح هذا الدليل طريقة استخدام طريقة delete على مورد Message لواجهة برمجة تطبيقات Google Chat لحذف رسالة نصية أو رسالة بطاقة.

يمثّل مورد Message رسالة نص أو بطاقة في Google Chat. يمكنك create أو get أو update أو delete رسالة في Google Chat API من خلال استدعاء الطرق المطابِقة. لمزيد من المعلومات عن الرسائل النصية ورسائل البطاقات، راجِع نظرة عامة على رسائل Google Chat.

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

Python

  • Python 3.6 أو أحدث
  • إنّ أداة إدارة الحِزم pip

  • أحدث مكتبات عملاء Google للغة Python. لتثبيتها أو تحديثها، شغّل الأمر التالي في واجهة سطر الأوامر:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  • مشروع على Google Cloud تم فيه تفعيل Google Chat API وضبطه لمعرفة الخطوات، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.

  • تم ضبط التفويض لتطبيق Chat. ويتيح حذف رسالة كلتا طريقتَي المصادقة التاليتَين:

    • يمكن لمصادقة المستخدم، باستخدام نطاق التفويض chat.messages، حذف الرسائل التي أنشأها هذا المستخدم. إذا كنت مدير مساحة، قد تتمكن من حذف الرسائل الأخرى. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة التعرّف على دورك كمدير مساحة.
    • يمكن لمصادقة التطبيق، من خلال نطاق التفويض chat.bot، حذف الرسائل التي أنشأها هذا التطبيق باستخدام حساب الخدمة الخاص به.

حذف رسالة تتضمّن مصادقة المستخدم

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

  • حدِّد نطاق تفويض chat.messages.
  • استدعِ طريقة delete في المورد Message.
  • اضبط name على اسم المورد الخاص بالرسالة التي تريد حذفها.

يؤدي المثال التالي إلى حذف الرسالة التي تتضمن مصادقة المستخدم:

Python

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

  2. ضمِّن الرمز التالي في chat_message_delete_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"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then deletes 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().delete(

        # The message to delete.
        #
        # 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 created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. في التعليمة البرمجية، استبدل ما يلي:

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

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

    python3 chat_message_delete_user.py

في حال نجاحها، يكون نص الاستجابة فارغًا، مما يشير إلى أنه تم حذف الرسالة.

حذف رسالة تتضمن مصادقة التطبيق

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

  • حدِّد نطاق تفويض chat.bot.
  • استدعِ طريقة delete في المورد Message.
  • اضبط name على اسم المورد الخاص بالرسالة التي تريد حذفها.

يؤدي المثال التالي إلى حذف الرسالة التي تتضمن مصادقة التطبيق:

Python

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

  2. ضمِّن الرمز التالي في chat_delete_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)

# Delete a Chat message.
result = chat.spaces().messages().delete(

  # The message to delete.
  #
  # 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.
# When deleting a message, the response body is empty.
print(result)

  3. في التعليمة البرمجية، استبدل ما يلي:

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

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

    python3 chat_delete_message_app.py

في حال نجاحها، يكون نص الاستجابة فارغًا، مما يشير إلى أنه تم حذف الرسالة.