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 chạy CLI gcloud, hãy chạy mã sau:

    gcloud init
    

• Một dự án trên Google Cloud đã bật tính năng thanh toán. Đối với các gói thuê bao Chat, bạn cũng phải bật API Chat trong dự án trê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.
• Yêu cầu xác thực người dùng bằng màn hình xin phép 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. Để định cấu hình màn hình đồng ý và xác định các phạm vi bắt buộc, hãy xem phần Chọn phạm vi.

• Một dự án Apps Script:
  • Sử dụng dự á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 đồ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 Google Workspace Events.

Python

• Python 3.6 trở lên
• Công cụ quản lý gói pip
• Thư viện ứng dụng Google mới nhất cho Python. Để cài đặt hoặc cập nhật các gói này, 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
    

• 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 chạy CLI gcloud, hãy chạy mã sau:

    gcloud init
    

• Một dự án trên Google Cloud đã bật tính năng thanh toán. Đối với các gói thuê bao Chat, bạn cũng phải bật API Chat trong dự án trê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.
• Yêu cầu xác thực người dùng bằng màn hình xin phép 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. Để định cấu hình màn hình đồng ý và xác định các phạm vi bắt buộc, hãy xem phần Chọn phạm vi.

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

Trong Google Cloud Console, hãy mở dự án Google Cloud cho ứng dụng của bạn và bật API Sự kiện Google Workspace và API Pub/Sub:

Bật API

gcloud

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

   gcloud auth login

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

   gcloud config set project PROJECT_ID

   Thay thế PROJECT_ID bằng mã dự án cho dự án trên Google Cloud của ứng dụng.

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 Google Cloud Console, hãy chuyển đến trang Pub/Sub:

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

   Đảm bảo bạn đã chọn dự án trên Cloud cho ứng dụng.

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. Để trạng thái 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 tương tự như 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 thêm thuộc tính 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 tên đầy đủ này trong bước sau.

4. Cấp quyền phát hành thông báo Pub/Sub cho chủ đề của bạn:

   1. Trên trang chủ đề, hãy chuyển đến bảng điều khiển bên và mở thẻ Quyền.
   2. Nhấp vào Thêm người đại diện chính.
   3. Trong trường Add principals (Thêm chủ thể), 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 của bạn:
      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. Quá trình cập nhật quyền cho chủ đề của bạn có thể mất vài phút.

gcloud

1. Trong dự án trên Cloud, 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ẽ hiển thị tên chủ đề đầy đủ, đượ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 bạn. Bạn sẽ sử dụng tên chủ đề trong bước tiếp theo và để tạo gói thuê bao Google Workspace sau này.

2. Cấp quyền phát hành tin nhắn 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ế nội dung sau:

   • TOPIC_NAME: Tên chủ đề đầy đủ, là kết quả của 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 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.

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

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

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

   Thay thế nội dung sau:

   • SUBSCRIPTION_NAME: Tên cho gói thuê bao, chẳng hạn như workspace-events-subscription.
   • TOPIC_NAME: Tên chủ đề mà bạn đã tạo trong 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 tên là createSubscription và 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ế nội dung 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ã nhận dạng 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 mục tiêu. Đị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 Cloud. Có định dạng là projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Giá trị boolean chỉ định xem 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 tất cả 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 hỗ trợ tài nguyên Chat mới bao gồm dữ liệu tài nguyên.
     • False: Loại trừ dữ liệu tài nguyên.

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

Python

1. Trong thư mục đang hoạt động, 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ế nội dung 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ã nhận dạng 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 mục tiêu. Đị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 Cloud. Có định dạng là projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Giá trị boolean chỉ định xem 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 tất cả 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 hỗ trợ tài nguyên Chat mới bao gồm dữ liệu tài nguyên.
     • False: Loại trừ dữ liệu tài nguyên.

2. Để tạo gói thuê bao Google Workspace, hãy chạy mã sau trong dòng lệnh:

   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 một phòng Chat, hãy đăng tin nhắn vào phòng đó.

2. Trong Google Cloud Console, hãy chuyển đến trang Pub/Sub:

   Chuyển đến Pub/Sub

   Đảm bảo bạn đã chọn dự án trên Cloud cho ứng dụng.

3. Trong trình đơn Pub/Sub, hãy nhấp vào Kênh đăng ký.

4. Trong bảng, 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ẻ Tin nhắn.

6. Nhấp vào Kéo. Có thể mất đến vài phút để một sự kiện tạo ra 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 một 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ế nội dung 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.

   Một sự kiện có thể mất đến vài phút để tạo một thông báo Pub/Sub.