Tạo gói thuê bao của Google Workspace

Apps Script

• Để sử dụng các lệnh Google Cloud CLI trong hướng dẫn này:
  1. Cài đặt Google Cloud CLI.
  2. Đến khởi chạy CLI gcloud, chạy mã sau:

    gcloud init
    

• Một dự án trên Google Cloud khi bật tính năng thanh toán. Đối với gói thuê bao Chat, bạn phải đồng thời bật API Chat trong dự án Cloud của bạn và định cấu hình Tên ứng dụng, URL hình đại diện và Mô tả mới. Để biết thông tin chi tiết, hãy xem Tạo ứng dụng Google Chat.
• Yêu cầu xác thực người dùng bằng màn hình xin phép bằng OAuth được định cấu hình cho ứng dụng. Khi định cấu hình màn hình xin phép, bạn phải chỉ định phạm vi để hỗ trợ từng loại sự kiện cho gói thuê bao. Cách thiết lập chế độ đồng ý và xác định các phạm vi bắt buộc, hãy xem Chọn phạm vi.

• Một dự án Apps Script:
  • Sử dụng dự án Google Cloud của bạn thay vì dự án mặc định được tạo tự động bằng Apps Script.
  • Đối với bất kỳ phạm vi nào mà bạn đã thêm để định cấu hình màn hình xin phép bằng OAuth, bạn cũng phải thêm vào tệp appsscript.json trong dự án Apps Script của bạn. Ví dụ:

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

  • Bật dịch vụ nâng cao Google Workspace Events.

Python

• Python 3.6 trở lên
• Công cụ quản lý gói pip
• Các thư viện ứng dụng mới nhất của Google dành cho Python. Để cài đặt hoặc cập nhật chúng, hãy chạy lệnh sau trong giao diện dòng lệnh:

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

• Để sử dụng các lệnh Google Cloud CLI trong hướng dẫn này:
  1. Cài đặt Google Cloud CLI.
  2. Đến khởi chạy CLI gcloud, chạy mã sau:

    gcloud init
    

• Một dự án trên Google Cloud khi bật tính năng thanh toán. Đối với gói thuê bao Chat, bạn phải đồng thời bật API Chat trong dự án Cloud của bạn và định cấu hình Tên ứng dụng, URL hình đại diện và Mô tả mới. Để biết thông tin chi tiết, hãy xem Tạo ứng dụng Google Chat.
• Yêu cầu xác thực người dùng bằng màn hình xin phép bằng OAuth được định cấu hình cho ứng dụng. Khi định cấu hình màn hình xin phép, bạn phải chỉ định phạm vi để hỗ trợ từng loại sự kiện cho gói thuê bao. Cách thiết lập chế độ đồng ý và xác định các phạm vi bắt buộc, hãy xem Chọn phạm vi.

bảng điều khiển Google Cloud

Trong bảng điều khiển Google Cloud, hãy mở dự án Google Cloud cho ứng dụng của bạn rồi bật API Sự kiện của Google Workspace và API Pub/Sub:

Bật API

gcloud

1. Trong thư mục đang làm việc, hãy đăng nhập vào Tài khoản Google của bạn:

   gcloud auth login
   

2. Đặt dự án thành dự án trên đám mây cho ứng dụng của bạn:

   gcloud config set project PROJECT_ID
   

   Thay thế PROJECT_ID bằng mã dự án của dự án trên đám mây cho ứng dụng của bạn.

3. Bật API Sự kiện của Google Workspace và Google Cloud Pub/Sub API:

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

bảng điều khiển Google Cloud

1. Trong bảng điều khiển Google Cloud, hãy truy cập vào trang Pub/Sub:

   Truy cập vào Google Cloud Pub/Sub

   Hãy nhớ chọn Dự án trên đám mây cho ứng dụng của bạn.

2. Nhấp vào add_box Tạo chủ đề rồi hãy làm như sau:

   1. Nhập tên cho chủ đề của bạn, chẳng hạn như workspace-events-topic.
   2. Chọn Thêm gói thuê bao mặc định. Pub/Sub đặt tên cho văn bản này gói thuê bao mặc định giống với tên chủ đề của bạn, chẳng hạn như workspace-events-topic-sub.
   3. Không bắt buộc: Cập nhật hoặc định cấu hình các tài sản bổ sung cho chủ đề của bạn.

3. Nhấp vào Tạo. Tên chủ đề đầy đủ của bạn được định dạng là projects/PROJECT_ID/topics/TOPIC_ID. Bạn sẽ sử dụng họ và tên này ở bước sau.

4. Cấp quyền truy cập để đăng thông báo Pub/Sub lên chủ đề của bạn:

   1. Trên trang của chủ đề, hãy chuyển đến bảng điều khiển bên rồi mở Thẻ Quyền.
   2. Nhấp vào Thêm hiệu trưởng.
   3. Trong trường Thêm người dùng chính, hãy thêm tài khoản dịch vụ cho Ứng dụng Google Workspace phân phối sự kiện đến gói thuê bao:
      1. Đối với sự kiện Chat, chat-api-push@system.gserviceaccount.com.
      2. Đối với sự kiện trên Meet, meet-api-event-push@system.gserviceaccount.com.
   4. Trong trình đơn Chỉ định vai trò, hãy chọn Pub/Sub Publisher.
   5. Nhấp vào Lưu. Có thể mất vài phút để cập nhật các quyền cho chủ đề của bạn.

gcloud

1. Trong dự án Cloud của bạn, hãy tạo một chủ đề bằng cách chạy lệnh sau :

   gcloud pubsub topics create TOPIC_ID
   

   Thay thế TOPIC_ID bằng một mã nhận dạng duy nhất cho chủ đề của bạn, chẳng hạn như dưới tên workspace-events-topic.

   Kết quả hiển thị tên đầy đủ của chủ đề, có định dạng là projects/PROJECT_ID/topics/TOPIC_ID. Ghi lại tên và đảm bảo giá trị của PROJECT_ID là mã dự án trên Google Cloud cho ứng dụng của mình. Bạn sử dụng tên chủ đề trong bước sau và để tạo gói thuê bao Google Workspace của bạn sau này.

2. Cấp quyền truy cập để đăng thông báo cho chủ đề của bạn:

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

   Thay thế đoạn mã sau:

   • TOPIC_NAME: Tên chủ đề đầy đủ là kết quả của bước trước. Được định dạng thành projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: Ứng dụng Google Workspace phải gửi sự kiện đến gói thuê bao của bạn:

     • Để nhận sự kiện từ Chat, hãy sử dụng chat-api-push@system.gserviceaccount.com.
     • Để nhận sự kiện từ Meet, hãy sử dụng meet-api-event-push@system.gserviceaccount.com.

   Có thể mất vài phút để cập nhật quyền cho chủ đề của bạn.

3. Tạo gói thuê bao Pub/Sub cho chủ đề:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   Thay thế đoạn mã sau:

   • SUBSCRIPTION_NAME: Tên cho gói thuê bao của bạn, chẳng hạn như workspace-events-subscription.
   • TOPIC_NAME: Tên chủ đề mà bạn đã tạo ở bước trước.

Apps Script

1. Trong dự án Apps Script, hãy tạo một tệp tập lệnh mới có tên là createSubscription rồi thêm mã sau:

   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);
   }
   

   Thay thế đoạn mã sau:

   • TARGET_RESOURCE: Tài nguyên của Google Workspace mà bạn đang đăng ký, được định dạng là tên tài nguyên đầy đủ. Để ví dụ: để đăng ký một phòng Google Chat bằng mã nhận dạng không gian AAAABBBB, sử dụng //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Một hoặc nhiều loại sự kiện mà bạn muốn đăng ký trong tài nguyên mục tiêu. Định dạng thành một mảng chuỗi như 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Tên đầy đủ của chủ đề Pub/Sub mà bạn đã tạo trong dự án Cloud của mình. Được định dạng thành projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Giá trị boolean chỉ định liệu giá trị gói thuê bao bao gồm dữ liệu tài nguyên trong tải trọng:

     • True: Bao gồm tất cả dữ liệu tài nguyên. Để giới hạn những trường nào đã bao gồm, hãy thêm fieldMask và chỉ định ít nhất một trường cho tài nguyên đã thay đổi. Chỉ gói đăng ký nhận dịch vụ hỗ trợ tài nguyên của Chat, bao gồm dữ liệu tài nguyên.
     • False: Không bao gồm dữ liệu tài nguyên.

2. Để tạo gói thuê bao của Google Workspace, hãy chạy hàm này createSubscription trong dự án Apps Script.

Python

1. Trong thư mục đang làm việc, hãy tạo một tệp có tên create_subscription.py và thêm mã sau:

   """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)
   

   Thay thế đoạn mã sau:

   • SCOPES: Một hoặc nhiều phạm vi OAuth hỗ trợ từng loại sự kiện cho gói thuê bao. Được định dạng dưới dạng một mảng chuỗi. Để liệt kê nhiều phạm vi, hãy phân tách bằng dấu phẩy. Ví dụ: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: Tài nguyên của Google Workspace mà bạn đang đăng ký, được định dạng là tên tài nguyên đầy đủ. Để ví dụ: để đăng ký một phòng Google Chat bằng mã nhận dạng không gian AAAABBBB, sử dụng //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Một hoặc nhiều loại sự kiện mà bạn muốn đăng ký trong tài nguyên mục tiêu. Định dạng thành một mảng chuỗi như 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Tên đầy đủ của chủ đề Pub/Sub mà bạn đã tạo trong dự án Cloud của mình. Được định dạng thành projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Giá trị boolean chỉ định liệu giá trị gói thuê bao bao gồm dữ liệu tài nguyên trong tải trọng:

     • True: Bao gồm tất cả dữ liệu tài nguyên. Để giới hạn những trường nào đã bao gồm, hãy thêm fieldMask và chỉ định ít nhất một trường cho tài nguyên đã thay đổi. Chỉ gói đăng ký nhận dịch vụ hỗ trợ tài nguyên của Chat, bao gồm dữ liệu tài nguyên.
     • False: Không bao gồm dữ liệu tài nguyên.

2. Để tạo gói thuê bao của Google Workspace, hãy chạy lệnh sau trong thiết bị đầu cuối của bạn:

   python3 create_subscription.py
   

bảng điều khiển Google Cloud

1. Kích hoạt một hoặc nhiều loại sự kiện trong tài nguyên mục tiêu của Gói thuê bao của Google Workspace. Ví dụ: nếu bạn đã đăng ký kênh mới tin nhắn trong phòng Chat, hãy đăng tin nhắn lên phòng Chat.

2. Trong bảng điều khiển Google Cloud, hãy truy cập vào trang Pub/Sub:

   Truy cập Pub/Sub

   Hãy nhớ chọn Dự án trên đám mây cho ứng dụng của bạn.

3. Trong trình đơn Pub/Sub, hãy nhấp vào Gói thuê bao.

4. Trong bảng này, hãy tìm gói thuê bao Pub/Sub cho chủ đề của bạn rồi nhấp vào tên gói thuê bao.

5. Nhấp vào thẻ Thông báo.

6. Nhấp vào Kéo. Có thể mất đến vài phút để một sự kiện tạo Thông báo Pub/Sub.

gcloud

1. Kích hoạt một hoặc nhiều loại sự kiện trong tài nguyên mục tiêu của Gói thuê bao của Google Workspace. Ví dụ: nếu bạn đã đăng ký kênh mới tin nhắn trong phòng Chat, hãy đăng tin nhắn trong phòng Chat.

2. Chạy lệnh sau:

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

   Thay thế đoạn mã sau:

   • PUBSUB_SUBSCRIPTION_NAME: Tên đầy đủ của Gói thuê bao Pub/Sub, có định dạng là projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID
   • MESSAGE_COUNT: Số lượng tin nhắn Pub/Sub tối đa mà bạn muốn lấy.

   Có thể mất vài phút để một sự kiện tạo một Pub/Sub .