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

Apps Script

• Cách 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. Để khởi động CLI gcloud, hãy chạy mã sau:

    gcloud init
    

• Tài nguyên mục tiêu cho gói thuê bao:
  • Để đăng ký một phòng Google Chat, phòng Chat mà người dùng đã xác thực là thành viên. Người dùng phải là thành viên của không gian thông qua Google Workspace hoặc Tài khoản Google của họ (không hỗ trợ những người dùng là thành viên của không gian thông qua một Nhóm Google).
  • Để đăng ký không gian hội họp trên Google Meet, không gian họp mà người dùng đã xác thực là chủ sở hữu là chủ sở hữu. Để tạo không gian, trong tài liệu về Google Meet, hãy xem phần Làm việc với không gian hội họp.
  • Để đăng ký một người dùng Google Meet, mã nhận dạng user của API Cloud Identity
• Một dự án Google Cloud đã bật tính năng thanh toán. Đối với gói thuê bao Chat, bạn cũng phải bật API Chat trong dự án Google Cloud và định cấu hình các trường Tên ứng dụng, URL hình đại diện và Mô tả. Để biết thông tin chi tiết, hãy xem bài viết Tạo ứng dụng Google Chat.
• Tính năng này 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 một phạm vi hỗ trợ từng loại sự kiện cho gói thuê bao. Để định cấu hình màn hình xin phép và xác định các phạm vi cần thiết, hãy xem phần Chọn phạm vi.

• Một dự án Apps Script:
  • Sử dụng dự án của bạn trên Google Cloud thay vì dự án mặc định do Apps Script tạo tự động.
  • Đối với mọi phạm vi 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 các phạm vi đó vào tệp appsscript.json trong dự án Apps Script. Ví dụ:

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

  • Bật dịch vụ nâng cao của 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 các công cụ này, hãy chạy lệnh sau trong giao diện dòng lệnh của bạn:

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

• Cách 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. Để khởi động CLI gcloud, hãy chạy mã sau:

    gcloud init
    

• Tài nguyên mục tiêu cho gói thuê bao:
  • Để đăng ký một phòng Google Chat, phòng Chat mà người dùng đã xác thực là thành viên. Người dùng phải là thành viên của không gian thông qua Google Workspace hoặc Tài khoản Google của họ (không hỗ trợ những người dùng là thành viên của không gian thông qua một Nhóm Google).
  • Để đăng ký không gian hội họp trên Google Meet, không gian họp mà người dùng đã xác thực là chủ sở hữu là chủ sở hữu. Để tạo không gian, trong tài liệu về Google Meet, hãy xem phần Làm việc với không gian hội họp.
  • Để đăng ký một người dùng Google Meet, mã nhận dạng user của API Cloud Identity
• Một dự án Google Cloud đã bật tính năng thanh toán. Đối với gói thuê bao Chat, bạn cũng phải bật API Chat trong dự án Google Cloud và định cấu hình các trường Tên ứng dụng, URL hình đại diện và Mô tả. Để biết thông tin chi tiết, hãy xem bài viết Tạo ứng dụng Google Chat.
• Tính năng này 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 một phạm vi hỗ trợ từng loại sự kiện cho gói thuê bao. Để định cấu hình màn hình xin phép và xác định các phạm vi cần thiết, hãy xem phần 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 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 cho dự án Cloud cho ứng dụng của bạn.

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

   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 chuyển đến trang Pub/Sub:

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

   Hãy nhớ chọn dự án Cloud cho ứng dụng của bạn.

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

   1. Nhập tên cho chủ đề, 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 gói thuê bao mặc định này giống như tên của chủ đề, 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 thuộc tính bổ sung cho chủ đề.

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

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

   1. Trên trang chủ đề của bạn, hãy chuyển đến bảng điều khiển bên rồi mở thẻ Quyền.
   2. Nhấp vào Add Principal (Thêm hiệu trưởng).
   3. Trong trường Add principals (Thêm tài khoản chính), hãy thêm tài khoản dịch vụ cho ứng dụng Google Workspace cung cấp sự kiện vào gói thuê bao của bạn:
      1. Đối với các sự kiện Chat, chat-api-push@system.gserviceaccount.com.
      2. Đối với các 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 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ư workspace-events-topic.

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

2. Cấp quyền đăng thông báo về 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ế các đoạn mã sau:

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

   • GOOGLE_WORKSPACE_APPLICATION: Ứng dụng Google Workspace phải phân phối các sự kiện cho 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ế các đ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ế các đoạn mã sau:

   • TARGET_RESOURCE: Tài nguyên 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 không gian Google Chat có mã không gian là AAAABBBB, hãy 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 đích. Định dạng dưới dạng một mảng chuỗi, chẳng hạn 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 trên Google Cloud. Được định dạng là projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: Bao gồm mọi dữ liệu tài nguyên. Để giới hạn các trường được đưa vào, hãy thêm trường fieldMask và chỉ định ít nhất một trường cho tài nguyên đã thay đổi. Chỉ các gói thuê bao tài nguyên của Chat mới hỗ trợ, bao gồm cả 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 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 rồi 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ế các đ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 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 không gian Google Chat có mã không gian là AAAABBBB, hãy 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 đích. Định dạng dưới dạng một mảng chuỗi, chẳng hạn 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 trên Google Cloud. Được định dạng là projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: Bao gồm mọi dữ liệu tài nguyên. Để giới hạn các trường được đưa vào, hãy thêm trường fieldMask và chỉ định ít nhất một trường cho tài nguyên đã thay đổi. Chỉ các gói thuê bao tài nguyên của Chat mới hỗ trợ, bao gồm cả 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 Google Workspace. Ví dụ: nếu bạn đã đăng ký nhận tin nhắn mới trong phòng Chat, hãy đăng tin nhắn lên phòng đó.

2. Trong bảng điều khiển Google Cloud, hãy chuyển đến trang Pub/Sub:

   Chuyển đến Pub/Sub

   Hãy nhớ chọn dự án Cloud 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 tới 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 Google Workspace. Ví dụ: nếu bạn đã đăng ký nhận tin nhắn mới trong phòng Chat, hãy đăng tin nhắn trong phòng đó.

2. Chạy lệnh sau:

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

   Thay thế các đoạn mã sau:

   • PUBSUB_SUBSCRIPTION_NAME: Tên đầy đủ của gói thuê bao Pub/Sub của bạn, 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 tới vài phút để một sự kiện tạo thông báo Pub/Sub.