یک اشتراک 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 ایجاد کند.

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

• برای استفاده از دستورات 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. در پروژه اسکریپت برنامه های خود ، یک پرونده اسکریپت جدید به نام 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 که در آن مشترک هستید ، به عنوان نام کامل منابع آن فرمت شده است. به عنوان مثال ، برای عضویت در فضای چت 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 در پروژه اسکریپت برنامه های خود اجرا کنید.

پایتون

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

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

   به Pub/Sub بروید

   اطمینان حاصل کنید که پروژه ابری برای برنامه شما انتخاب شده است.

3. در منوی میخانه/زیر ، روی اشتراک ها کلیک کنید.

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

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

6. روی Pull کلیک کنید. این می تواند تا چند دقیقه طول بکشد تا یک رویداد برای تولید یک میخانه/زیر پیام باشد.

gcloud

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

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

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

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

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

   این می تواند تا چند دقیقه طول بکشد تا یک رویداد برای تولید یک میخانه/زیر پیام باشد.

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

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

    gcloud init
    

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

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

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

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

پایتون

• پایتون 3.6 یا بیشتر
• ابزار مدیریت بسته PIP
• آخرین کتابخانه های مشتری Google برای پایتون. برای نصب یا به روزرسانی آنها ، دستور زیر را در رابط خط فرمان خود اجرا کنید:

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

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

    gcloud init
    

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

کنسول Google Cloud

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

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

gcloud

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

   gcloud auth login

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

   gcloud config set project PROJECT_ID

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

3. فعال کردن رویدادهای Google Workspace 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 بروید

   اطمینان حاصل کنید که پروژه ابری برای برنامه شما انتخاب شده است.

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

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

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

4. دسترسی به انتشار پیام های میخانه/زیر به موضوع خود را اعطا کنید:

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

gcloud

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

   gcloud pubsub topics create TOPIC_ID

   برای موضوع خود با یک شناسه منحصر به فرد ، مانند workspace-events-topic با یک شناسه TOPIC_ID جایگزین کنید.

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

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 که باید رویدادهایی را به اشتراک شما ارائه دهد:

     • برای دریافت رویدادها از گپ ، از chat-api-push@system.gserviceaccount.com استفاده کنید.
     • برای دریافت رویدادها از ملاقات ، از meet-api-event-push@system.gserviceaccount.com استفاده کنید.

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

3. برای موضوع یک اشتراک میخانه/فرعی ایجاد کنید:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

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

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

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

1. در پروژه اسکریپت برنامه های خود ، یک پرونده اسکریپت جدید به نام 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 که در آن مشترک هستید ، به عنوان نام کامل منابع آن فرمت شده است. به عنوان مثال ، برای عضویت در فضای چت 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 در پروژه اسکریپت برنامه های خود اجرا کنید.

پایتون

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

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

   به Pub/Sub بروید

   اطمینان حاصل کنید که پروژه ابری برای برنامه شما انتخاب شده است.

3. در منوی میخانه/زیر ، روی اشتراک ها کلیک کنید.

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

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

6. روی Pull کلیک کنید. این می تواند تا چند دقیقه طول بکشد تا یک رویداد برای تولید یک میخانه/زیر پیام باشد.

gcloud

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

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

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

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

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

   این می تواند تا چند دقیقه طول بکشد تا یک رویداد برای تولید یک میخانه/زیر پیام باشد.

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

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

    gcloud init
    

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

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

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

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

پایتون

• پایتون 3.6 یا بیشتر
• ابزار مدیریت بسته PIP
• آخرین کتابخانه های مشتری Google برای پایتون. برای نصب یا به روزرسانی آنها ، دستور زیر را در رابط خط فرمان خود اجرا کنید:

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

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

    gcloud init
    

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

کنسول Google Cloud

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

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

gcloud

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

   gcloud auth login

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

   gcloud config set project PROJECT_ID

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

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

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

کنسول Google Cloud

1. In the Google Cloud console, go to the Pub/Sub page:

   Go to Google Cloud Pub/Sub

   Make sure that the Cloud project for your app is selected.

2. Click add_box Create topic and do the following:

   1. Enter a name for your topic, such as workspace-events-topic .
   2. Leave Add a default subscription selected. Pub/Sub names this default subscription similar to your topic's name, such as workspace-events-topic-sub .
   3. Optional: Update or configure additional properties for your topic.

3. روی ایجاد کلیک کنید. Your full topic name is formatted as projects/ PROJECT_ID /topics/ TOPIC_ID . You use this full name in a later step.

4. Grant access to publish Pub/Sub messages to your topic:

   1. On your topic's page, go to the side panel and open the Permissions tab.
   2. Click Add Principal .
   3. In the Add principals field, add the service account for the Google Workspace application that delivers events to your subscription:
      1. For Chat events, chat-api-push@system.gserviceaccount.com .
      2. For Meet events, meet-api-event-push@system.gserviceaccount.com .
   4. In the Assign roles menu, select Pub/Sub Publisher .
   5. روی ذخیره کلیک کنید. It can take a few minutes to update the permissions for your topic.

gcloud

1. In your Cloud project, create a topic by running the following command:

   gcloud pubsub topics create TOPIC_ID

   Replace TOPIC_ID with a unique ID for your topic, such as workspace-events-topic .

   The output displays the full topic name, formatted as projects/ PROJECT_ID /topics/ TOPIC_ID . Make note of the name, and make sure the value for PROJECT_ID is the Cloud project ID for your app. You use the topic name in the following step, and to create the Google Workspace subscription later.

2. Grant access to publish messages to your topic:

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

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

   • TOPIC_NAME : The full topic name, which is the output from the previous step. Formatted as projects/ PROJECT_ID /topics/ TOPIC_ID .

   • GOOGLE_WORKSPACE_APPLICATION : The Google Workspace application that must deliver events to your subscription:

     • To receive events from Chat, use chat-api-push@system.gserviceaccount.com .
     • To receive events from Meet, use meet-api-event-push@system.gserviceaccount.com .

   It can take a few minutes to update the permissions for your topic.

3. Create a Pub/Sub subscription for the topic:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

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

   • SUBSCRIPTION_NAME : A name for your subscription, such as workspace-events-subscription .
   • TOPIC_NAME : The name of your topic that you created in the previous step.

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

1. In your Apps Script project, create a new script file named createSubscription and add the following code:

   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 : The Google Workspace resource that you're subscribing to, formatted as its full resource name. For example, to subscribe to a Google Chat space with the space ID AAAABBBB , use //chat.googleapis.com/spaces/AAAABBBB .
   • EVENT_TYPES : One or more event types that you want to subscribe to in the target resource. Format as an array of strings such as 'google.workspace.chat.message.v1.created' .
   • TOPIC_NAME : The full name of the Pub/Sub topic that you created in your Cloud project. Formatted as projects/ PROJECT_ID /topics/ TOPIC_ID .

   • RESOURCE_DATA : A boolean that specifies whether the subscription includes resource data in the payload:

     • True : Includes all resource data. To limit which fields are included, add the fieldMask field and specify at least one field for the changed resource. Only subscriptions to Chat resources support including resource data.
     • False : Excludes resource data.

2. To create the Google Workspace subscription, run the function createSubscription in your Apps Script project.

پایتون

1. In your working directory, create a file named create_subscription.py and add the following code:

   """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 : One or more OAuth scopes that support each event type for the subscription. Formatted as an array of strings. To list multiple scopes, separate by commas. For example, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly' .
   • TARGET_RESOURCE : The Google Workspace resource that you're subscribing to, formatted as its full resource name. For example, to subscribe to a Google Chat space with the space ID AAAABBBB , use //chat.googleapis.com/spaces/AAAABBBB .
   • EVENT_TYPES : One or more event types that you want to subscribe to in the target resource. Format as an array of strings such as 'google.workspace.chat.message.v1.created' .
   • TOPIC_NAME : The full name of the Pub/Sub topic that you created in your Cloud project. Formatted as projects/ PROJECT_ID /topics/ TOPIC_ID .

   • RESOURCE_DATA : A boolean that specifies whether the subscription includes resource data in the payload:

     • True : Includes all resource data. To limit which fields are included, add the fieldMask field and specify at least one field for the changed resource. Only subscriptions to Chat resources support including resource data.
     • False : Excludes resource data.

2. To create the Google Workspace subscription, run the following in your terminal:

   python3 create_subscription.py

کنسول Google Cloud

1. Trigger one or more types of events in the target resource of your Google Workspace subscription. For example, if you've subscribed to new messages in a Chat space, post a message to the space.

2. In the Google Cloud console, go to the Pub/Sub page:

   به Pub/Sub بروید

   Make sure that the Cloud project for your app is selected.

3. In the Pub/Sub menu, click Subscriptions .

4. In the table, find the Pub/Sub subscription for your topic and click the subscription name.

5. Click the Messages tab.

6. روی Pull کلیک کنید. It can take up to a few minutes for an event to generate a Pub/Sub message.

gcloud

1. Trigger one or more types of events in the target resource of your Google Workspace subscription. For example, if you've subscribed to new messages in a Chat space, post a message in the space.

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

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

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

   • PUBSUB_SUBSCRIPTION_NAME : The full name of your Pub/Sub subscription, formatted as projects/ SUBSCRIPTION_ID /subscriptions/ SUBSCRIPTION_ID .
   • MESSAGE_COUNT : The maximum number of Pub/Sub messages you want to pull.

   It can take up to a few minutes for an event to generate a Pub/Sub message.