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

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

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

    gcloud init
    

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

• پروژه 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 Cloud CLI در این راهنما:
  1. Google Cloud CLI را نصب کنید.
  2. برای مقداردهی اولیه gcloud CLI، کد زیر را اجرا کنید:

    gcloud init
    

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

کنسول Google Cloud

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

API ها را فعال کنید

gcloud

1. در فهرست کاری خود، وارد حساب Google خود شوید:

   gcloud auth login

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

   gcloud config set project PROJECT_ID

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

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

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

کنسول Google Cloud

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

   به Google Cloud Pub/Sub بروید

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

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

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

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

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

   1. در صفحه موضوع خود، به پانل کناری بروید و تب Permissions را باز کنید.
   2. روی Add Principal کلیک کنید.
   3. در قسمت افزودن اصول ، حساب سرویس را برای برنامه Google Workspace اضافه کنید که رویدادها را به اشتراک شما ارائه می‌کند:
      1. برای رویدادهای گپ، chat-api-push@system.gserviceaccount.com .
      2. برای رویدادهای Meet، meet-api-event-push@system.gserviceaccount.com .
   4. در منوی Assign roles ، 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-api-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 : نام موضوعی که در مرحله قبل ایجاد کردید.

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

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 که در آن مشترک هستید، به عنوان نام منبع کامل آن قالب بندی شده است. به عنوان مثال، برای اشتراک در فضای چت Google با شناسه فضا 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 را اضافه کنید و حداقل یک فیلد را برای منبع تغییر یافته مشخص کنید. فقط اشتراک در منابع چت از جمله داده های منابع پشتیبانی می کند.
     • False : داده های منبع را مستثنی می کند.

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

پایتون

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('client_secrets.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 که در آن مشترک هستید، به عنوان نام منبع کامل آن قالب بندی شده است. به عنوان مثال، برای اشتراک در فضای چت Google با شناسه فضا 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 را اضافه کنید و حداقل یک فیلد را برای منبع تغییر یافته مشخص کنید. فقط اشتراک در منابع چت از جمله داده های منابع پشتیبانی می کند.
     • False : داده های منبع را مستثنی می کند.

2. برای ایجاد اشتراک Google Workspace، موارد زیر را در ترمینال خود اجرا کنید:

   python3 create_subscription.py

کنسول Google Cloud

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

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

   به Pub/Sub بروید

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

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

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

5. روی تب Messages کلیک کنید.

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

gcloud

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

2. دستور زیر را اجرا کنید:

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

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

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

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