الحصول على تفاصيل حول اشتراك Google Workspace

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

عند استدعاء هذه الطريقة باستخدام مصادقة المستخدم، تعرض الطريقة تفاصيل عن اشتراك أذن به المستخدم. عند استخدام مصادقة التطبيق، يمكن أن تعرض الطريقة تفاصيل عن أي اشتراك في التطبيق.

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

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

  • مشروع "برمجة تطبيقات 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 لإنشاء اشتراك، يُرجى الاطّلاع على إنشاء اشتراك.

  • تتطلّب المصادقة:

    • لمصادقة المستخدم، يجب أن يتوفّر نطاق يتيح استخدام نوع واحد على الأقل من أنواع الأحداث للاشتراك. لتحديد نطاق، اطّلِع على النطاقات حسب نوع الحدث.
    • بالنسبة إلى مصادقة التطبيقات، يتطلب النطاق chat.bot (تطبيقات Google Chat فقط).

الحصول على اشتراك أذن به مستخدم

يحصل نموذج الرمز البرمجي التالي على تفاصيل حول موارد Subscription باستخدام مصادقة المستخدم. عند المصادقة كمستخدم، تعرض الطريقة اشتراكًا فوّض المستخدم للتطبيق إنشاؤه.

للحصول على اشتراك مفوَّض من أحد المستخدمين:

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

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

    غيِّر القيم في السلسلة على الشكل التالي:

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

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

Python

  1. في دليل العمل، أنشئ ملفًا باسم 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('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'
subscription = service.subscriptions().get(name=NAME).execute()
print(subscription)

    غيِّر القيم في السلسلة على الشكل التالي:

    • 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 get_subscription.py