تشرح هذه الصفحة كيفية الحصول على تفاصيل حول اشتراك في Google Workspace
باستخدام
subscriptions.get()
طريقة.
عند استدعاء هذه الطريقة باستخدام مصادقة المستخدم، تعرض الطريقة تفاصيل حول اشتراك أذن به المستخدم. عند استخدام مصادقة التطبيق، يمكن أن تعرض الطريقة تفاصيل حول أي اشتراك في التطبيق.
المتطلبات الأساسية
برمجة التطبيقات
- اشتراك Google Workspace لإنشاء اشتراك، يُرجى الاطّلاع على مقالة إنشاء اشتراك.
- مشروع في "برمجة التطبيقات":
- استخدِم مشروعك على Google Cloud بدلاً من المشروع التلقائي الذي تنشئه "برمجة تطبيقات" تلقائيًا.
- بالنسبة إلى جميع النطاقات التي أضفتها لإعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth، عليك أيضًا إضافة النطاقات إلى ملف
appsscript.jsonفي مشروع "برمجة التطبيقات". على سبيل المثال، إذا حدّدت النطاقchat.messages، أضِف ما يلي: - فعِّل
الخدمة المتقدّمة
Google Workspace Events.
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages" ]
تتطلّب مصادقة ونطاق تفويض مناسبًا لكل نوع حدث في الاشتراك:
- بالنسبة إلى مصادقة المستخدم، تتطلّب نطاقًا يتيح نوعًا واحدًا على الأقل من أنواع الأحداث للاشتراك. لتحديد نطاق، يُرجى الاطّلاع على النطاقات حسب نوع الحدث.
- بالنسبة إلى مصادقة التطبيق، تتطلّب النطاق
chat.bot(تطبيقات Google Chat فقط).
Python
- الإصدار 3.6 أو الإصدارات الأحدث من Python
- أداة إدارة حزمة pip
- أحدث مكتبات برامج Google للغة Python لتثبيتها أو تعديلها، شغِّل الأمر التالي
في واجهة سطر الأوامر:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- اشتراك Google Workspace لإنشاء اشتراك، يُرجى الاطّلاع على مقالة إنشاء اشتراك.
تتطلّب مصادقة ونطاق تفويض مناسبًا لكل نوع حدث في الاشتراك:
- بالنسبة إلى مصادقة المستخدم، تتطلّب نطاقًا يتيح نوعًا واحدًا على الأقل من أنواع الأحداث للاشتراك. لتحديد نطاق، يُرجى الاطّلاع على النطاقات حسب نوع الحدث.
- بالنسبة إلى مصادقة التطبيق، تتطلّب النطاق
chat.bot(تطبيقات Google Chat فقط).
الحصول على اشتراك أذن به مستخدم
تحصل عينة التعليمات البرمجية التالية على تفاصيل حول مورد
Subscription
باستخدام مصادقة المستخدم. عند المصادقة كمستخدم، تعرض الطريقة اشتراكًا أذن المستخدم للتطبيق بإنشائه.
للحصول على اشتراك أذن به مستخدم، يُرجى اتّباع الخطوات التالية:
برمجة التطبيقات
في مشروع "برمجة التطبيقات"، أنشِئ ملف نص برمجي جديدًا باسم
getSubscriptionوأضِف الرمز البرمجي التالي:function getSubscription() { // The name of the subscription to get. const name = 'subscriptions/SUBSCRIPTION_ID'; // Call the Workspace Events API using the advanced service. const subscription = WorkspaceEvents.Subscriptions.get(name); console.log(subscription); }غيِّر القيم في السلسلة على الشكل التالي:
للحصول على الاشتراك، شغِّل الدالة
getSubscriptionفي مشروع "برمجة التطبيقات".
Python
في دليل العمل، أنشِئ ملفًا باسم
get_subscription.pyوأضِف الرمز البرمجي التالي:"""Get 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' subscription = service.subscriptions().get(name=NAME).execute() print(subscription)غيِّر القيم في السلسلة على الشكل التالي:
SCOPE: نطاق OAuth يدعم نوعًا واحدًا على الأقل من أنواع الأحداث من الاشتراك. على سبيل المثال، إذا كان اشتراكك يتلقّى أحداثًا عن مساحة Chat معدَّلة، استخدِمhttps://www.googleapis.com/auth/chat.spaces.readonly.SUBSCRIPTION_ID: معرّف الاشتراك للحصول على المعرّف، يمكنك استخدام أي مما يلي:
في دليل العمل، تأكَّد من تخزين بيانات اعتماد معرّف عميل OAuth وأطلِق على الملف الاسم
credentials.json. تستخدم عينة التعليمات البرمجية ملف JSON هذا للمصادقة على Google Workspace والحصول على بيانات اعتماد المستخدم. للاطّلاع على التعليمات، يُرجى مراجعة مقالة إنشاء بيانات اعتماد معرّف عميل OAuth.للحصول على الاشتراك، شغِّل ما يلي في الوحدة الطرفية:
python3 get_subscription.py