حذف اشتراك Google Workspace

توضّح هذه الصفحة كيفية حذف اشتراك Google Workspace باستخدام طريقة subscriptions.delete().

عند حذف اشتراك، لن يتلقّى تطبيقك أي أحداث بعد ذلك. إذا انتهت صلاحية اشتراك، سيحذفه Google Workspace Events API تلقائيًا.

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

برمجة التطبيقات

  • مشروع "برمجة تطبيقات Google":
    • استخدِم مشروعك على Google Cloud بدلاً من المشروع التلقائي الذي يتم إنشاؤه تلقائيًا بواسطة Apps Script.
    • بالنسبة إلى جميع النطاقات التي أضفتها لإعداد شاشة موافقة OAuth، عليك أيضًا إضافة النطاقات إلى ملف appsscript.json في مشروع "برمجة تطبيقات Google". على سبيل المثال، إذا حدّدت النطاق chat.messages، أضِف ما يلي:
    • "oauthScopes": [
        "https://www.googleapis.com/auth/chat.messages"
      ]
          
    • فعِّل خدمة Google Workspace Events المتقدّمة.

Python

  • الإصدار 3.6 أو الإصدارات الأحدث من Python
  • أداة إدارة الحزم pip
  • أحدث مكتبات برامج Google للغة Python لتثبيتها أو تعديلها، نفِّذ الأمر التالي في واجهة سطر الأوامر:
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
      
  • اشتراك في Google Workspace لإنشاء اشتراك، يُرجى الاطّلاع على إنشاء اشتراك.

  • يتطلّب المصادقة:

    • لإثبات هوية المستخدم، يجب توفير نطاق يتوافق مع نوع واحد على الأقل من أنواع الأحداث الخاصة بالاشتراك. لتحديد نطاق، اطّلِع على النطاقات حسب نوع الحدث.
    • للمصادقة على التطبيق، يجب استخدام النطاق chat.bot (تطبيقات Google Chat فقط).

حذف اشتراك وافق عليه مستخدم

يحذف نموذج الرمز البرمجي التالي مورد Subscription باستخدام مصادقة المستخدم.

لحذف اشتراك، اتّبِع الخطوات التالية:

برمجة التطبيقات

  1. في مشروع "برمجة تطبيقات Google"، أنشئ ملف نص برمجي جديدًا باسم deleteSubscription وأضِف الرمز التالي:

    function deleteSubscription() {
      // The name of the subscription to delete.
      const name = 'subscriptions/SUBSCRIPTION_ID';
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.remove(name);
      console.log(response);
    }
    

    غيِّر القيم في السلسلة على الشكل التالي:

    • SUBSCRIPTION_ID: رقم تعريف الاشتراك. للحصول على المعرّف، يمكنك استخدام أيّ مما يلي:
      • قيمة الحقل uid
      • معرّف اسم المرجع الممثّل في الحقل name على سبيل المثال، إذا كان اسم المورد هو subscriptions/subscription-123، استخدِم subscription-123.
  2. لحذف الاشتراك، شغِّل الدالة deleteSubscription في مشروعك على Apps Script.

Python

  1. في دليل العمل، أنشئ ملفًا باسم delete_subscription.py وأضِف الرمز التالي:

    """Delete subscription."""
    
    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient.discovery import build
    
    # Specify required scopes.
    SCOPES = ['SCOPE']
    
    # Authenticate with Google Workspace and get user authentication.
    flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)
    CREDENTIALS = flow.run_local_server()
    
    # Call the Workspace Events API using the service endpoint.
    service = build(
        'workspaceevents',
        'v1',
        credentials=CREDENTIALS,
    )
    
    NAME = 'subscriptions/SUBSCRIPTION_ID'
    response = service.subscriptions().delete(name=NAME).execute()
    print(response)
    

    غيِّر القيم في السلسلة على الشكل التالي:

    • SCOPE: نطاق OAuth يتوافق مع نوع حدث واحد على الأقل من الاشتراك على سبيل المثال، إذا كان اشتراكك يتلقّى أحداثًا في مساحة Chat معدَّلة، https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: رقم تعريف الاشتراك. للحصول على المعرّف، يمكنك استخدام أيّ مما يلي:
      • قيمة الحقل uid
      • معرّف اسم المرجع الممثّل في الحقل name على سبيل المثال، إذا كان اسم المورد هو subscriptions/subscription-123، استخدِم subscription-123.
  2. في دليل العمل، تأكَّد من تخزين بيانات اعتماد معرّف عميل OAuth وتسمية الملف credentials.json. يستخدم نموذج الرمز ملف JSON هذا للمصادقة مع Google Workspace والحصول على بيانات اعتماد المستخدم. للاطّلاع على التعليمات، راجِع مقالة إنشاء بيانات اعتماد معرّف عميل OAuth.

  3. لحذف الاشتراك، نفِّذ ما يلي في الوحدة الطرفية:

    python3 delete_subscription.py
تعرض Google Workspace Events API عملية طويلة الأمد تحتوي على مثيل لمورد Subscription.