جزئیات اشتراک Google Workspace را دریافت کنید

این صفحه نحوه دریافت جزئیات اشتراک Google Workspace را با استفاده از متد subscriptions.get() توضیح می‌دهد.

هنگامی که این روش را با احراز هویت کاربر فراخوانی می کنید، این روش جزئیات مربوط به یک اشتراک مجاز توسط کاربر را برمی گرداند. وقتی از احراز هویت برنامه استفاده می‌کنید، این روش می‌تواند جزئیات مربوط به هر اشتراک برنامه را بازگرداند.

پیش نیازها

اسکریپت برنامه ها

  • یک پروژه Apps Script:
    • از پروژه Google Cloud خود به جای پروژه پیش‌فرض ایجاد شده توسط Apps Script استفاده کنید.
    • برای هر دامنه‌ای که برای پیکربندی صفحه رضایت OAuth اضافه کرده‌اید، باید دامنه‌ها را نیز به فایل appsscript.json در پروژه Apps Script خود اضافه کنید. مثلا:
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • سرویس پیشرفته Google Workspace Events را فعال کنید .

پایتون

  • پایتون 3.6 یا بالاتر
  • ابزار مدیریت بسته پیپ
  • جدیدترین کتابخانه های مشتری گوگل برای پایتون. برای نصب یا به روز رسانی آنها، دستور زیر را در رابط خط فرمان خود اجرا کنید: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

  • اشتراک Google Workspace. برای ایجاد یک اشتراک، به ایجاد اشتراک مراجعه کنید.

  • نیاز به احراز هویت :

    • برای احراز هویت کاربر، به محدوده‌ای نیاز دارد که حداقل یکی از انواع رویداد را برای اشتراک پشتیبانی کند. برای شناسایی یک محدوده، محدوده ها بر اساس نوع رویداد را ببینید.
    • برای احراز هویت برنامه، به محدوده chat.bot نیاز دارد (فقط برنامه‌های گپ Google).

یک اشتراک مجاز توسط یک کاربر دریافت کنید

نمونه کد زیر جزئیات مربوط به یک منبع 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 را در پروژه Apps Script خود اجرا کنید.

پایتون

  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 که حداقل یک نوع رویداد را از اشتراک پشتیبانی می کند . برای مثال، اگر اشتراک شما رویدادها را یک فضای گپ به‌روزرسانی شده دریافت می‌کند، 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