توضّح هذه الصفحة كيفية تجديد اشتراك Google Workspace باستخدام طريقة الدفع subscriptions.update()
. يمكنك استخدام هذه الطريقة لتعديل وقت انتهاء صلاحية الاشتراك،
بما في ذلك تجديد الاشتراك لأطول مدة ممكنة، أو
لتعديل قائمة أنواع الأحداث التي تريد تلقّيها بشأن المورد المستهدف.
برمجة التطبيقات
- اشتراك في Google Workspace لإنشاء اشتراك، يُرجى الاطّلاع على إنشاء اشتراك.
يتطلّب ذلك مصادقة المستخدم باستخدام نطاق واحد أو أكثر يتوافق مع جميع أنواع الأحداث للاشتراك.
- مشروع "برمجة تطبيقات Google":
- استخدِم مشروعك على Google Cloud بدلاً من المشروع التلقائي الذي يتم إنشاؤه تلقائيًا بواسطة Apps Script.
- بالنسبة إلى جميع النطاقات التي أضفتها لإعداد شاشة موافقة OAuth، عليك أيضًا إضافة النطاقات إلى ملف
appsscript.json
في مشروع "برمجة تطبيقات Google". على سبيل المثال، إذا حدّدت النطاقchat.messages
، أضِف ما يلي: - فعِّل
خدمة
Google Workspace Events
المتقدّمة.
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages" ]
Python
- الإصدار 3.6 أو الإصدارات الأحدث من Python
- أداة إدارة الحزم pip
- أحدث مكتبات برامج Google للغة Python لتثبيتها أو تعديلها، نفِّذ الأمر التالي
في واجهة سطر الأوامر:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- اشتراك في Google Workspace لإنشاء اشتراك، يُرجى الاطّلاع على إنشاء اشتراك.
يتطلّب ذلك مصادقة المستخدم باستخدام نطاق واحد أو أكثر يتوافق مع جميع أنواع الأحداث للاشتراك.
تجديد اشتراك Google Workspace
في هذا القسم، ستستخدم طريقة subscriptions.update()
في Google Workspace Events API لتجديد الاشتراك إلى أقصى مدة صلاحية. لتحديد الحدّ الأقصى لوقت انتهاء الصلاحية، عليك تعديل الحقل ttl
الخاص بمورد Subscription
إلى 0
.
يعتمد الحد الأقصى لوقت انتهاء الصلاحية على بيانات الموارد المضمّنة في حمولة الحدث. لمزيد من المعلومات عن أوقات انتهاء الصلاحية، اطّلِع على بيانات أحداث Google Workspace.
لتجديد اشتراك Google Workspace، اتّبِع الخطوات التالية:
برمجة التطبيقات
في مشروع "برمجة تطبيقات Google"، أنشئ ملف نص برمجي جديدًا باسم
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); }
غيِّر القيم في السلسلة على الشكل التالي:
لتعديل اشتراك Google Workspace، شغِّل الدالة
updateSubscription
في مشروع "برمجة تطبيقات Google".
Python
في دليل العمل، أنشئ ملفًا باسم
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('credentials.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
: رقم تعريف الاشتراك. للحصول على المعرّف، يمكنك استخدام أيّ مما يلي:
في دليل العمل، تأكَّد من تخزين بيانات اعتماد معرّف عميل OAuth وتسمية الملف
credentials.json
. يستخدم نموذج الرمز ملف JSON هذا للمصادقة مع Google Workspace والحصول على بيانات اعتماد المستخدم. للاطّلاع على التعليمات، راجِع مقالة إنشاء بيانات اعتماد معرّف عميل OAuth.لتعديل اشتراك Google Workspace، نفِّذ ما يلي في نافذة الأوامر:
python3 update_subscription.py
Subscription
.
للحصول على تفاصيل حول مورد Subscription
المعدَّل، استخدِم طريقة operations.get()
وحدِّد مورد Operation
الذي تم عرضه من طلب subscriptions.update()
. في ما عدا ذلك، إذا حدّدت مورد Operation
من إصدار سابق من الاشتراك، ستكون الاستجابة فارغة.