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

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

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

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

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

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

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

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

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

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

للحصول على اشتراك مسموح به من قِبل المستخدم:

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

  1. في مشروع برمجة التطبيقات، أنشئ ملف نص برمجي جديدًا باسم 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 في مشروع برمجة التطبيقات.

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