تعديل اشتراك Google Workspace أو تجديده

توضِّح هذه الصفحة كيفية تجديد اشتراك Google Workspace باستخدام الطريقة subscriptions.update(). يمكنك استخدام هذه الطريقة لتعديل وقت انتهاء صلاحية الاشتراك، بما في ذلك تجديد الاشتراك لأقصى وقت ممكن لانتهاء الصلاحية.

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

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

Python

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

تجديد اشتراك Google Workspace

في هذا القسم، يمكنك استخدام طريقة subscriptions.update() على Google Workspace Events API لتجديد الاشتراك وبلوغ الحد الأقصى لوقت انتهاء الصلاحية. لتحديد الحدّ الأقصى لوقت انتهاء الصلاحية، عليك تعديل الحقل ttl لمورد Subscription إلى 0.

يعتمد الحدّ الأقصى لوقت انتهاء الصلاحية على بيانات الموارد المتضمّنة في حمولة الحدث. لمزيد من المعلومات عن أوقات انتهاء الصلاحية، راجِع بيانات الأحداث لأحداث Google Workspace.

لتجديد اشتراك Google Workspace، اتّبِع الخطوات التالية:

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

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

    function updateSubscription() {
  // The name of the subscription to update.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.patch({
    ttl: '0s',
  }, name);
  console.log(response);
}

    استبدل ما يلي:

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

  2. لتعديل اشتراك Google Workspace، شغِّل الدالة updateSubscription في مشروع "برمجة تطبيقات Google".

Python

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

    """Update subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [SCOPES]

# 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,
)

BODY = {
    'ttl': {'seconds': 0},
}
NAME = 'subscriptions/SUBSCRIPTION_ID'
response = (
    service.subscriptions()
    .patch(name=NAME, updateMask='ttl', body=BODY)
    .execute()
)
print(response)

    استبدل ما يلي:

    • SCOPES: واحد أو أكثر من نطاقات OAuth التي تتوافق مع كل نوع حدث للاشتراك. يتم تنسيقها كصفيف من السلاسل. لإدراج نطاقات متعددة، افصل بينها بفواصل. مثلاً: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
    • SUBSCRIPTION_ID: معرّف الاشتراك للحصول على المعرّف، يمكنك استخدام أي مما يلي:
      • قيمة الحقل uid.
      • رقم تعريف اسم المورد الممثَّل في الحقل name. على سبيل المثال، إذا كان اسم المورد هو subscriptions/subscription-123، استخدِم subscription-123.

  2. في دليل العمل، تأكَّد من حفظ بيانات اعتماد معرِّف عميل OAuth وتسمية الملف client_secrets.json. يستخدم نموذج الرمز ملف JSON هذا للمصادقة باستخدام Google Workspace والحصول على بيانات اعتماد المستخدمين. لمعرفة التعليمات، يُرجى الاطّلاع على إنشاء بيانات اعتماد معرِّف عميل OAuth.

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

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

للاطّلاع على تفاصيل حول مورد Subscription المعدّل، استخدِم طريقة operations.get() وحدِّد مورد Operation الذي تم عرضه في طلب subscriptions.update(). وبخلاف ذلك، إذا حددت موردًا Operation من إصدار سابق من الاشتراك، ستكون الاستجابة فارغة.