ایجاد اشتراک Google Workspace

Apps Script

• برای استفاده از فرمان‌های Google Cloud CLI در این راهنما:
  1. Google Cloud CLI را نصب کنید.
  2. برای راه‌اندازی gcloud CLI، کد زیر را اجرا کنید:

    gcloud init
    

• پروژه Apps Script:
  • به‌جای پروژه پیش‌فرضی که به‌طور خودکار توسط Apps Script ایجاد شده است، از پروژه Google Cloud خودتان استفاده کنید.
  • برای همه دامنه‌هایی که برای پیکربندی صفحه رضایت OAuth اضافه کردید، باید دامنه‌ها را به فایل appsscript.json در پروژه Apps Script خود نیز اضافه کنید. برای مثال، اگر دامنه chat.messages را مشخص کرده‌اید، موارد زیر را اضافه کنید:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages"
  ]
      

  • فعال کردن سرویس پیشرفته Google Workspace Events.

• پروژه Google Cloud با صورت‌حساب فعال‌شده. برای اشتراک‌های Chat، باید Chat API را نیز در پروژه Cloud خود فعال کنید و فیلدهای نام برنامه، نشانی وب چهره‌نما، و شرح را پیکربندی کنید. برای جزئیات، به ساختن برنامه Google Chat مراجعه کنید.
• به اصالت‌سنجی و محدوده مجوز مناسب برای هر نوع رویداد در اشتراک نیاز دارد:
  • معمولاً به اصالت‌سنجی کاربر با صفحه کسب رضایت OAuth پیکربندی‌شده برای برنامه نیاز دارد. وقتی صفحه کسب رضایت را پیکربندی می‌کنید، باید دامنه‌ای را برای پشتیبانی از هر نوع رویداد برای اشتراک مشخص کنید. برای پیکربندی صفحه رضایت و شناسایی دامنه‌های موردنیاز، انتخاب دامنه‌ها را ببینید.
  • برای مشترک شدن در رویداد Chat به‌عنوان برنامه Chat، به اصالت‌سنجی برنامه با تأیید یک‌باره سرپرست نیاز است.

Python

• پایتون ۳.۶ یا بالاتر
• ابزار مدیریت بسته pip
• جدیدترین کتابخانه‌های کارخواه Google برای Python. برای نصب یا به‌روزرسانی آن‌ها، فرمان زیر را در میانای خط فرمان اجرا کنید:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• برای استفاده از فرمان‌های Google Cloud CLI در این راهنما:
  1. Google Cloud CLI را نصب کنید.
  2. برای راه‌اندازی gcloud CLI، کد زیر را اجرا کنید:

    gcloud init
    

• پروژه Google Cloud با صورت‌حساب فعال‌شده. برای اشتراک‌های Chat، باید Chat API را نیز در پروژه Cloud خود فعال کنید و فیلدهای نام برنامه، نشانی وب چهرک، و شرح را پیکربندی کنید. برای جزئیات، به ساختن برنامه Google Chat مراجعه کنید.
• به اصالت‌سنجی و محدوده مجوز مناسب برای هر نوع رویداد در اشتراک نیاز دارد:
  • معمولاً به اصالت‌سنجی کاربر با صفحه کسب رضایت OAuth پیکربندی‌شده برای برنامه نیاز دارد. وقتی صفحه کسب رضایت را پیکربندی می‌کنید، باید دامنه‌ای را برای پشتیبانی از هر نوع رویداد برای اشتراک مشخص کنید. برای پیکربندی صفحه رضایت و شناسایی دامنه‌های موردنیاز، انتخاب دامنه‌ها را ببینید.
  • برای مشترک شدن در رویداد Chat به‌عنوان برنامه Chat، به اصالت‌سنجی برنامه با تأیید یک‌باره سرپرست نیاز است.

;کنسول Google Cloud

در کنسول Google Cloud، پروژه Google Cloud را برای برنامه‌تان باز کنید و Google Workspace Events API و Pub/Sub API را فعال کنید:

فعال کردن میاناهای برنامه‌سازی کاربردی

gcloud

1. در فهرست راهنمای کاری‌تان، به سیستم «حساب Google» خود وارد شوید:

   gcloud auth login

2. پروژه‌تان را روی پروژه Cloud برای برنامه‌تان تنظیم کنید:

   gcloud config set project PROJECT_ID

   PROJECT_ID را با شناسه پروژه برای پروژه Cloud برنامه‌تان جایگزین کنید.

3. Google Workspace Events API و Google Cloud Pub/Sub API را فعال کنید:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com

Google API Console

1. در «کنسول Google API»، به صفحه Pub/Sub بروید:

   رفتن به Google Cloud Pub/Sub

   مطمئن شوید پروژه Cloud برای برنامه‌تان انتخاب شده باشد.

2. روی add_box ایجاد موضوع کلیک کنید و کارهای زیر را انجام دهید:

   1. نامی برای موضوعتان وارد کنید، مثلاً workspace-events-topic.
   2. افزودن اشتراک پیش‌فرض را انتخاب‌شده رها کنید. Pub/Sub نام این اشتراک پیش‌فرض را مشابه نام موضوع شما، مثلاً workspace-events-topic-sub، می‌گذارد.
   3. اختیاری: ویژگی‌های بیشتری را برای موضوعتان به‌روزرسانی یا پیکربندی کنید.

3. روی ایجاد کردن کلیک کنید. نام کامل موضوع شما به‌صورت projects/PROJECT_ID/topics/TOPIC_ID قالب‌بندی شده است. از این نام کامل در مرحله بعدی استفاده کنید.

4. اعطای دسترسی برای انتشار پیام‌های Pub/Sub در موضوع شما:

   1. در صفحه موضوع، به پانل کناری بروید و برگه اجازه‌ها را باز کنید.
   2. روی افزودن مدیر کلیک کنید.
   3. در فیلد افزودن اصول، حساب سرویس را برای برنامه Google Workspace که رویدادها را به اشتراکتان ارسال می‌کند اضافه کنید:
      1. برای رویدادهای Chat، chat-api-push@system.gserviceaccount.com.
      2. برای رویدادهای Drive، drive-api-event-push@system.gserviceaccount.com.
      3. برای رویدادهای Meet، meet-api-event-push@system.gserviceaccount.com.
   4. در منو واگذاری نقش‌ها، Pub/Sub Publisher را انتخاب کنید.
   5. روی ذخیره کلیک کنید. ممکن است چند دقیقه طول بکشد تا اجازه‌های موضوعتان به‌روز شود.

gcloud

1. در پروژه Cloud، با اجرای فرمان زیر موضوعی ایجاد کنید:

   gcloud pubsub topics create TOPIC_ID

   TOPIC_ID را با شناسه یکتایی برای موضوعتان جایگزین کنید، مثلاً workspace-events-topic.

   برونداد نام کامل موضوع را به‌صورت projects/PROJECT_ID/topics/TOPIC_ID نمایش می‌دهد. نام را یادداشت کنید و مطمئن شوید مقدار PROJECT_ID شناسه پروژه Cloud برای برنامه‌تان باشد. از نام موضوع در مرحله بعدی استفاده کنید و بعداً اشتراک Google Workspace را ایجاد کنید.

2. اعطای دسترسی برای انتشار پیام‌ها در موضوع شما:

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'

   موارد زیر را جایگزین کنید:

   • ‫TOPIC_NAME: نام کامل موضوع که خروجی مرحله قبلی است. قالب‌بندی‌شده به‌صورت projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: برنامه Google Workspace که باید رویدادها را به اشتراکتان ارسال کند:

     • برای دریافت رویدادها از Chat، از یکی از حساب‌های خدماتی زیر استفاده کنید:
       • برای برنامه‌های Chat (که به‌عنوان برافزاهای Google Workspace ساخته شده‌اند و Chat را گسترش می‌دهند)، از ایمیل حساب سرویس در صفحه پیکربندی Chat API استفاده کنید. برای کسب اطلاعات بیشتر، ساختن برنامه Google Chat که از Pub/Sub استفاده می‌کند را ببینید.
       • برای برنامه‌های Chat که برافزا نیستند، از chat-api-push@system.gserviceaccount.com استفاده کنید. برای کسب اطلاعات بیشتر، ساختن برنامه Google Chat که از Pub/Sub استفاده می‌کند را ببینید.
     • برای دریافت رویدادها از Drive، از drive-api-event-push@system.gserviceaccount.com استفاده کنید.
     • برای دریافت رویدادها از Meet، از meet-api-event-push@system.gserviceaccount.com استفاده کنید.

   به‌روزرسانی اجازه‌های موضوعتان ممکن است چند دقیقه طول بکشد.

3. ایجاد اشتراک Pub/Sub برای موضوع:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

   موارد زیر را جایگزین کنید:

   • SUBSCRIPTION_NAME: نامی برای اشتراکتان، مثل workspace-events-subscription.
   • ‫TOPIC_NAME: نام موضوعی که در مرحله قبل ایجاد کردید.

Apps Script

1. در پروژه Apps Script، فایل اسکریپت جدیدی به‌نام createSubscription ایجاد کنید و کد زیر را اضافه کنید:

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   موارد زیر را جایگزین کنید:

   • TARGET_RESOURCE: منبع Google Workspace که در آن مشترک می‌شوید، با قالب نام کامل منبع. برای مثال، برای مشترک شدن در فضای Chat با شناسه فضای AAAABBBB، از //chat.googleapis.com/spaces/AAAABBBB استفاده کنید.
   • EVENT_TYPES: یک یا چند نوع رویداد که می‌خواهید در منبع هدف مشترک شوید. به‌صورت آرایه‌ای از رشته‌ها مثل 'google.workspace.chat.message.v1.created' قالب‌بندی کنید.
   • ‫TOPIC_NAME: نام کامل موضوع Pub/Sub که در پروژه Cloud خود ایجاد کرده‌اید. قالب‌بندی‌شده به‌صورت projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: مقدار بولی که مشخص می‌کند آیا اشتراک شامل داده‌های منبع در بار مفید است یا نه:

     • True: شامل همه داده‌های منبع است. برای محدود کردن فیلدهای گنجانده‌شده، فیلد fieldMask را اضافه کنید و حداقل یک فیلد برای منبع تغییریافته مشخص کنید. فقط اشتراک‌های منابع Chat از گنجاندن داده‌های منبع پشتیبانی می‌کنند.
     • False: داده‌های منبع را شامل نمی‌شود.

2. برای ایجاد اشتراک Google Workspace، تابع createSubscription را در پروژه Apps Script خود اجرا کنید.

Python

1. در دایرکتوری کاری‌تان، فایلی با نام create_subscription.py ایجاد کنید و کد زیر را به آن اضافه کنید:

   """Create 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()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   موارد زیر را جایگزین کنید:

   • SCOPES: یک یا چند گستره OAuth که از هر نوع رویداد برای اشتراک پشتیبانی می‌کند. به‌صورت آرایه‌ای از رشته‌ها قالب‌بندی شده است. برای فهرست کردن چند دامنه، آن‌ها را با کاما از هم جدا کنید. برای مثال، 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: منبع Google Workspace که در آن مشترک می‌شوید، با قالب نام کامل منبع. برای مثال، برای مشترک شدن در فضای Chat با شناسه فضای AAAABBBB، از //chat.googleapis.com/spaces/AAAABBBB استفاده کنید.
   • EVENT_TYPES: یک یا چند نوع رویداد که می‌خواهید در منبع هدف مشترک شوید. به‌صورت آرایه‌ای از رشته‌ها مثل 'google.workspace.chat.message.v1.created' قالب‌بندی کنید.
   • ‫TOPIC_NAME: نام کامل موضوع Pub/Sub که در پروژه Cloud خود ایجاد کرده‌اید. قالب‌بندی‌شده به‌صورت projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: مقدار بولی که مشخص می‌کند آیا اشتراک شامل داده‌های منبع در بار مفید است یا نه:

     • True: شامل همه داده‌های منبع است. برای محدود کردن فیلدهای گنجانده‌شده، فیلد fieldMask را اضافه کنید و حداقل یک فیلد برای منبع تغییریافته مشخص کنید. فقط اشتراک‌های منابع Chat از گنجاندن داده‌های منبع پشتیبانی می‌کنند.
     • False: داده‌های منبع را شامل نمی‌شود.

2. برای ایجاد اشتراک Google Workspace، دستور زیر را در پایانه خود اجرا کنید:

   python3 create_subscription.py

Google API Console

1. یک یا چند نوع رویداد را در منبع هدف اشتراک Google Workspace خود راه‌اندازی کنید. برای مثال، اگر در پیام‌های جدید در فضای Chat مشترک شده‌اید، پیامی را در فضا پست کنید.

2. در «کنسول Google API»، به صفحه Pub/Sub بروید:

   رفتن به Pub/Sub

   مطمئن شوید پروژه Cloud برای برنامه‌تان انتخاب شده باشد.

3. در منو Pub/Sub، روی اشتراک‌ها کلیک کنید.

4. در جدول، اشتراک Pub/Sub را برای موضوعتان پیدا کنید و روی نام اشتراک کلیک کنید.

5. روی برگه پیام‌ها کلیک کنید.

6. روی کشیدن کلیک کنید. ممکن است چند دقیقه طول بکشد تا رویدادی پیام Pub/Sub تولید کند.

gcloud

1. یک یا چند نوع رویداد را در منبع هدف اشتراک Google Workspace خود راه‌اندازی کنید. برای مثال، اگر در پیام‌های جدید در فضای Chat مشترک شده‌اید، پیامی در فضا پست کنید.

2. فرمان زیر را اجرا کنید:

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack

   موارد زیر را جایگزین کنید:

   • PUBSUB_SUBSCRIPTION_NAME: نام کامل اشتراک Pub/Sub شما، با قالب projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID.
   • ‫MESSAGE_COUNT: حداکثر تعداد پیام‌های Pub/Sub که می‌خواهید بکشید.

   ممکن است چند دقیقه طول بکشد تا رویدادی پیام Pub/Sub تولید کند.

Python

  """Create subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = ['https://www.googleapis.com/auth/chat.app.messages.readonly']

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # The Google Workspace resource to monitor for events.
  TARGET_RESOURCE = '//chat.googleapis.com/spaces/SPACE_ID'

  # The types of events to receive.
  EVENT_TYPES = [
                  'google.workspace.chat.message.v1.created',
                  'google.workspace.chat.message.v1.updated',
                  'google.workspace.chat.message.v1.deleted',
                ]

  # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
  TOPIC = 'TOPIC_NAME'

  # Call the Workspace Events API using the service endpoint.
  service = build(
      'workspaceevents',
      'v1',
      credentials=CREDENTIALS,
  )

  BODY = {
      'target_resource': TARGET_RESOURCE,
      'event_types': EVENT_TYPES,
      'notification_endpoint': {'pubsub_topic': TOPIC},
      'payload_options': {'include_resource': RESOURCE_DATA},
  }
  response = service.subscriptions().create(body=BODY).execute()
  print(response)

Python

"""Create a customer subscription."""

from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
# Replace with the scopes needed for the event types you want to receive.
SCOPES = ['https://www.googleapis.com/auth/chat.app.all.messages.readonly']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Monitor all events for the Google Workspace organization.
TARGET_RESOURCE = '//admin.googleapis.com/customers/CUSTOMER_ID'

# The types of events to receive.
EVENT_TYPES = [
    'google.workspace.chat.message.v1.created',
    'google.workspace.chat.message.v1.updated',
    'google.workspace.chat.message.v1.deleted',
]

# The endpoint to deliver events to.
TOPIC = 'TOPIC_NAME'

# Call the Workspace Events API.
# Note: Use the v1beta endpoint for Developer Preview features.
service = build(
    'workspaceevents',
    'v1beta',
    credentials=CREDENTIALS,
)

BODY = {
    'target_resource': TARGET_RESOURCE,
    'event_types': EVENT_TYPES,
    'notification_endpoint': {'pubsub_topic': TOPIC},
    'payload_options': {'include_resource': RESOURCE_DATA},
}

response = service.subscriptions().create(body=BODY).execute()
print(response)