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

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

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

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

Python

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

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

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

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

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

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

  1. في مشروعك على Apps Script، أنشئ ملف نص برمجي جديد باسم 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 في مشروعك على Apps Script.

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 من إصدار سابق للاشتراك، سيكون الردّ فارغًا.