حذف اشتراك Google Workspace

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

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

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

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

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

Python

  • Python 3.6 أو أعلى
  • أداة إدارة حزم pip
  • أحدث مكتبات برامج Google للغة بايثون. لتثبيتها أو تحديثها، شغِّل ما يلي الأمر في واجهة سطر الأوامر: 
      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 في مشروع برمجة التطبيقات.

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('client_secrets.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 في دليل العمل. بيانات اعتماد وأطلق على الملف اسم client_secrets.json. تستخدم عيّنة التعليمات البرمجية ملف JSON هذا للمصادقة باستخدام Google Workspace والحصول على بيانات اعتماد المستخدم. للاطّلاع على التعليمات يُرجى الاطّلاع على إنشاء معرِّف عميل OAuth. بيانات الاعتماد.

  3. لحذف الاشتراك، عليك تشغيل ما يلي في الوحدة الطرفية:

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