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

Trang này giải thích cách sử dụng Google Workspace Events API để tạo một lượt đăng ký cho một tài nguyên Google Workspace. Gói thuê bao Google Workspace cho phép ứng dụng của bạn nhận thông tin về các sự kiện trên Google Workspace. Các sự kiện này thể hiện những thay đổi đối với một tài nguyên trên Google Workspace. Để tìm hiểu về những tài nguyên và loại sự kiện mà Google Workspace Events API hỗ trợ, hãy xem Tổng quan về Google Workspace Events API.

Trang này bao gồm các bước sau để tạo gói thuê bao Google Workspace:

1. Thiết lập môi trường.
2. Tạo và đăng ký một chủ đề Google Cloud Pub/Sub. Bạn sử dụng chủ đề này làm điểm cuối để nhận các sự kiện của Google Workspace.
3. Gọi phương thức create của Google Workspace Events API trên tài nguyên Subscription.
4. Kiểm thử gói thuê bao Google Workspace để xác minh rằng chủ đề Pub/Sub của bạn nhận được các sự kiện mà bạn đã đăng ký.
5. Bạn có thể định cấu hình cách đẩy các sự kiện đến một điểm cuối cho ứng dụng của mình, để ứng dụng có thể xử lý sự kiện và thực hiện hành động (nếu cần).

Lưu ý: Các sự kiện cho Google Drive API được cung cấp trong Chương trình dùng thử trước cho nhà phát triển Google Workspace, chương trình này cho phép truy cập sớm vào một số tính năng. Mã mẫu được liệt kê ở đây sẽ không hoạt động với những sự kiện này.

Điều kiện tiên quyết

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 gcloud CLI, 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 lượt đăng ký Chat, bạn cũng phải bật API Chat trong dự án trên Cloud và định cấu hình các trường Tên ứng dụng, URL hình đại diện và Nội dung 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 người dùng xác thực 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 đồ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 của bạn thay vì dự án mặc định do Apps Script tự động tạo.
  • Đối với mọi phạm vi mà bạn đã thêm để định cấu hình màn hình đồng ý của 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 mới nhất của Google 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:

    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 gcloud CLI, 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 lượt đăng ký Chat, bạn cũng phải bật API Chat trong dự án trên Cloud và định cấu hình các trường Tên ứng dụng, URL hình đại diện và Nội dung 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 người dùng xác thực 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 đồng ý và xác định các phạm vi bắt buộc, hãy xem phần Chọn phạm vi.

Thiết lập môi trường

Phần sau đây giải thích cách thiết lập môi trường trước khi tạo gói thuê bao Google Workspace.

Bật Google Workspace Events API và Google Cloud Pub/Sub API

Trước khi sử dụng API của Google, bạn cần bật các API đó trong một dự án Google Cloud. Bạn có thể bật một hoặc nhiều API trong một dự án Google Cloud.

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 rồi bật Google Workspace Events API và Pub/Sub API:

Bật các API

gcloud

1. Trong thư mục 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 của bạn thành dự án Cloud cho ứng dụng:

   gcloud config set project PROJECT_ID

   Thay PROJECT_ID bằng mã dự án cho dự án trên 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

Tạo thông tin đăng nhập mã ứng dụng OAuth

Lưu ý: Bạn có thể bỏ qua bước này nếu đang sử dụng Apps Script.

Chọn loại ứng dụng để xem hướng dẫn cụ thể về cách tạo mã ứng dụng khách OAuth:

Lưu ý: Để chạy mã mẫu trong hướng dẫn này, hãy chọn Ứng dụng dành cho máy tính rồi làm theo hướng dẫn.

Ứng dụng web

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Loại ứng dụng > Ứng dụng web.
4. Trong trường Name (Tên), hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Thêm các URI được uỷ quyền liên quan đến ứng dụng của bạn:
   • Ứng dụng phía máy khách (JavaScript) – Trong phần Nguồn gốc JavaScript được uỷ quyền, hãy nhấp vào Thêm URI. Sau đó, hãy nhập một URI để sử dụng cho các yêu cầu của trình duyệt. Tham số này xác định những miền mà ứng dụng của bạn có thể gửi yêu cầu API đến máy chủ OAuth 2.0.
   • Ứng dụng phía máy chủ (Java, Python và các ứng dụng khác) – Trong mục URI chuyển hướng được uỷ quyền, hãy nhấp vào Thêm URI. Sau đó, hãy nhập một URI điểm cuối mà máy chủ OAuth 2.0 có thể gửi phản hồi.
6. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần Mã ứng dụng OAuth 2.0.

   Ghi lại Mã ứng dụng khách. Khoá bí mật ứng dụng không được dùng cho các ứng dụng Web.

Android

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Loại ứng dụng > Android.
4. Trong trường "Tên", hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Trong trường "Tên gói", hãy nhập tên gói trong tệp AndroidManifest.xml.
6. Trong trường "SHA-1 certificate fingerprint" (Dấu vân tay chứng chỉ SHA-1), hãy nhập dấu vân tay chứng chỉ SHA-1 đã tạo.
7. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".

iOS

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Loại ứng dụng > iOS.
4. Trong trường "Tên", hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Trong trường "Mã nhận dạng gói", hãy nhập giá trị nhận dạng gói có trong tệp Info.plist của ứng dụng.
6. Không bắt buộc: Nếu ứng dụng của bạn xuất hiện trong Apple App Store, hãy nhập mã App Store.
7. Không bắt buộc: Trong trường "Team ID" (Mã nhóm), hãy nhập chuỗi gồm 10 ký tự duy nhất do Apple tạo và chỉ định cho nhóm của bạn.
8. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".

Ứng dụng Chrome

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Loại ứng dụng > Tiện ích Chrome.
4. Trong trường "Tên", hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Trong trường "Mã mặt hàng", hãy nhập chuỗi mã nhận dạng duy nhất gồm 32 ký tự của ứng dụng. Bạn có thể tìm thấy giá trị mã nhận dạng này trong URL của ứng dụng trên Cửa hàng Chrome trực tuyến và trong Trang tổng quan dành cho nhà phát triển của Cửa hàng Chrome trực tuyến.
6. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".

Ứng dụng dành cho máy tính

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Loại ứng dụng > Ứng dụng dành cho máy tính.
4. Trong trường Name (Tên), hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".

TV và thiết bị đầu vào giới hạn

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Loại ứng dụng > TV và thiết bị có phương thức nhập hạn chế.
4. Trong trường "Tên", hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".

Universal Windows Platform (UWP)

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn > > Ứng dụng.

   Chuyển đến mục Khách hàng

2. Nhấp vào Tạo ứng dụng.
3. Nhấp vào Application type (Loại ứng dụng) > Universal Windows Platform (UWP) (Nền tảng Windows đa năng).
4. Trong trường "Tên", hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Trong trường "Mã cửa hàng", hãy nhập giá trị mã Microsoft Store gồm 12 ký tự duy nhất của ứng dụng. Bạn có thể tìm thấy mã này trong URL của ứng dụng trên Microsoft Store và trong Partner Center.
6. Nhấp vào Tạo.

   Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".

Tải tệp JSON chứa mật khẩu ứng dụng khách xuống

Lưu ý: Bạn có thể bỏ qua bước này nếu đang sử dụng Apps Script.

Tệp mật khẩu ứng dụng khách là một biểu thị JSON của thông tin đăng nhập mã ứng dụng OAuth mà ứng dụng của bạn có thể tham chiếu khi cung cấp thông tin đăng nhập.

1. Trong Google Cloud Console, hãy chuyển đến phần Trình đơn > API và dịch vụ > Thông tin xác thực.

   Chuyển đến phần Thông tin đăng nhập

2. Trong phần Mã ứng dụng OAuth 2.0, hãy nhấp vào mã ứng dụng mà bạn đã tạo.

3. Nhấp vào Tải tệp JSON xuống.

4. Lưu tệp dưới dạng credentials.json.

Tạo và đăng ký theo dõi một chủ đề Pub/Sub

Trong phần này, bạn sẽ tạo một chủ đề Pub/Sub và gói thuê bao cho chủ đề đó. Chủ đề Pub/Sub của bạn đóng vai trò là điểm cuối thông báo nơi gói thuê bao Google Workspace của bạn nhận được các sự kiện.

Để tìm hiểu thêm về cách tạo và quản lý chủ đề Pub/Sub, hãy xem tài liệu về Pub/Sub.

Lưu ý: Google Workspace Events API sử dụng khoá sắp xếp để ứng dụng của bạn nhận được thông báo theo thứ tự mà thông báo được xuất bản. Bạn nên tránh sử dụng chính sách lưu trữ tin nhắn. Các sự kiện được xuất bản cho những chủ đề có chính sách như vậy có thể sẽ không thành công, vì các khu vực trong chính sách có thể không khớp với nguồn sự kiện.

Cách tạo và đăng ký một chủ đề Pub/Sub:

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

   Đảm bảo bạn đã chọn dự án trên Đám mây cho ứng dụng của mình.

2. Nhấp vào 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. Giữ nguyên lựa 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 một bước sau.

4. Cấp quyền đăng thông báo Pub/Sub cho 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 và mở thẻ Quyền.
   2. Nhấp vào Thêm người uỷ quyền.
   3. Trong trường Thêm các thực thể chính, hãy thêm tài khoản dịch vụ cho ứng dụng Google Workspace gửi các sự kiện đến gói thuê bao của bạn:
      1. Đối với các sự kiện trong Chat, hãy xem [e-mail].
      2. Bản dùng thử cho nhà phát triển:: Đối với các sự kiện trên Drive, hãy dùng [e-mail].
      3. Đối với sự kiện trên Meet, hãy [e-mail].
   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 trên đám mây, 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 đầ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ị cho PROJECT_ID là mã dự án Cloud cho ứng dụng của bạn. Bạn 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 xuất bản 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ế nội dung sau:

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

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

     • Để nhận các sự kiện từ Chat, hãy sử dụng [e-mail].
     • Bản dùng thử cho nhà phát triển:: Để nhận các sự kiện từ Drive, hãy sử dụng [e-mail].
     • Để nhận sự kiện từ Meet, hãy sử dụng [e-mail].

   Quá trình cập nhật quyền cho chủ đề 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 của gói thuê bao, chẳng hạn như workspace-events-subscription.
   • TOPIC_NAME: Tên của chủ đề mà bạn đã tạo ở bước trước.

Đăng ký nhận thông tin về một tài nguyên của Google Workspace

Trong phần này, bạn sẽ đăng ký tài nguyên Google Workspace mà bạn muốn theo dõi các sự kiện.

Chọn và xác định tài nguyên mục tiêu

Trong gói thuê bao Google Workspace, tài nguyên đích là tài nguyên Google Workspace mà bạn giám sát các sự kiện. Tài nguyên đích được biểu thị trong trường targetResource của gói thuê bao, được định dạng bằng tên tài nguyên đầy đủ. Ví dụ: đối với một gói thuê bao theo dõi một không gian trên Google Chat (spaces/AAAABBBBBBB), giá trị của targetResource là //chat.googleapis.com/spaces/AAAABBBBBBB.

Trước khi tạo gói thuê bao, hãy tham khảo các phần sau để tìm hiểu cách xác định và định dạng tài nguyên mục tiêu.

Xác định tài nguyên mục tiêu cho Chat

Tài nguyên đích đến	Định dạng	Giới hạn
Không gian	//chat.googleapis.com/spaces/SPACE trong đó SPACE là mã nhận dạng trong tên tài nguyên của tài nguyên space Chat API. Bạn có thể lấy mã nhận dạng từ URL của không gian hoặc bằng cách sử dụng phương thức spaces.list().	Người dùng Chat uỷ quyền cho lượt đăng ký phải là thành viên của không gian thông qua Tài khoản Google hoặc Google Workspace của họ.
Tất cả không gian của một người dùng	//chat.googleapis.com/spaces/-	Đăng ký này chỉ nhận các sự kiện cho những không gian mà người dùng là thành viên thông qua tài khoản Google Workspace hoặc Tài khoản Google của họ.
Người dùng	//cloudidentity.googleapis.com/users/USER trong đó USER là mã nhận dạng trong tên tài nguyên của tài nguyên user Chat API. Để biết thông tin chi tiết, hãy xem phần Xác định và chỉ định người dùng Google Chat.	Gói thuê bao chỉ nhận các sự kiện về người dùng đã uỷ quyền cho gói thuê bao đó. Người dùng không thể uỷ quyền đăng ký thay cho người dùng khác.

Xác định tài nguyên đích cho Drive

Bản dùng thử cho nhà phát triển: Được cung cấp trong Chương trình Bản dùng thử cho nhà phát triển của Google Workspace, cho phép truy cập sớm vào một số tính năng.

Tài nguyên đích đến	Định dạng	Các điểm hạn chế (nếu có)
Tệp	//googleapis.com/drive/v3/files/FILE trong đó FILE là mã nhận dạng trong tên tài nguyên của tài nguyên files Drive API. Bạn có thể lấy mã nhận dạng từ URL của tệp hoặc bằng cách sử dụng phương thức files.list.	Người dùng uỷ quyền cho gói thuê bao phải có quyền đối với tệp trong gói thuê bao so với sự kiện đăng ký.
Bộ nhớ dùng chung	//googleapis.com/drive/v3/drives/DRIVE trong đó DRIVE là mã nhận dạng trong tên tài nguyên của tài nguyên drives Drive API. Bạn có thể lấy mã nhận dạng từ URL của ổ đĩa hoặc bằng cách sử dụng phương thức drives.list.	Dịch vụ đăng ký chỉ nhận các sự kiện cho những mục trong ổ đĩa dùng chung mà người dùng là thành viên thông qua Tài khoản Google Workspace hoặc Tài khoản Google của họ.

Xác định tài nguyên mục tiêu cho Meet

Tài nguyên đích đến	Định dạng	Các điểm hạn chế (nếu có)
Không gian hội họp	//meet.googleapis.com/spaces/SPACE trong đó SPACE là mã nhận dạng trong tên tài nguyên của tài nguyên space Meet REST API. Để biết thông tin chi tiết, hãy xem bài viết Cách Meet xác định không gian họp.
Người dùng	//cloudidentity.googleapis.com/users/USER trong đó USER là mã nhận dạng trong trường signedinUser.user của tài nguyên participant Meet REST API. Để biết thông tin chi tiết, hãy xem bài viết Làm việc với người tham gia.	Đăng ký nhận các sự kiện về không gian họp nơi người dùng là một trong những đối tượng sau: Chủ sở hữu của không gian tổ chức cuộc họp. Một người tham gia trong không gian họp. Người tổ chức sự kiện trên Lịch Google được liên kết với không gian họp.

Tạo gói thuê bao Google Workspace

Để tạo một lượt đăng ký, bạn sử dụng phương thức subscriptions.create của Google Workspace Events API để tạo một tài nguyên Subscription. Bạn chỉ định các trường sau:

• targetResource: Một Google Workspace mà bạn đã xác định trong phần trước, được định dạng bằng tên tài nguyên đầy đủ.
• eventTypes: Một mảng gồm một hoặc nhiều loại sự kiện mà bạn muốn nhận về tài nguyên. Ví dụ: nếu ứng dụng của bạn chỉ cần biết về những tin nhắn mới được đăng lên một không gian Chat, thì ứng dụng đó chỉ cần đăng ký nhận các sự kiện về tin nhắn đã tạo.
• notificationEndpoint: Một điểm cuối thông báo nơi gói thuê bao Google Workspace của bạn gửi các sự kiện. Bạn sử dụng chủ đề Pub/Sub mà bạn đã tạo trong phần trước.
• payloadOptions: Các lựa chọn để chỉ định lượng dữ liệu tài nguyên cần đưa vào tải trọng sự kiện. Cấu hình này ảnh hưởng đến thời gian hết hạn của gói thuê bao. Để tìm hiểu thêm, hãy xem bài viết Dữ liệu sự kiện.

Cách tạo gói thuê bao Google Workspace:

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ế nội dung sau:

   • TARGET_RESOURCE: Tài nguyên Google Workspace mà bạn đang đăng ký nhận thông báo, được định dạng dưới dạng tên tài nguyên đầy đủ. Ví dụ: để đăng ký theo dõi một phòng Google Chat có mã nhận dạng phòng là AAAABBBB, hãy 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 Cloud. Được định dạng dưới dạng 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 những 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ỉ những lượt đăng ký tài nguyên Chat mới hỗ trợ việc đưa dữ liệu tài nguyên vào.
     • 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 của bạn.

Python

1. Trong thư mục làm việc, hãy tạo một tệp có tên là create_subscription.py rồi thêm đoạn 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('credentials.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ý nhận thông báo, được định dạng dưới dạng tên tài nguyên đầy đủ. Ví dụ: để đăng ký theo dõi một phòng Google Chat có mã nhận dạng phòng là AAAABBBB, hãy 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 Cloud. Được định dạng dưới dạng 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 những 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ỉ những lượt đăng ký tài nguyên Chat mới hỗ trợ việc đưa dữ liệu tài nguyên vào.
     • False: Loại trừ dữ liệu tài nguyên.

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

   python3 create_subscription.py

Google Workspace Events API trả về một thao tác kéo dài đã hoàn tất. Thao tác này chứa phiên bản của tài nguyên Subscription mà bạn đã tạo.

Dùng thử gói thuê bao Google Workspace

Để kiểm thử xem bạn có nhận được các sự kiện Google Workspace hay không, bạn có thể kích hoạt một sự kiện và kéo tin nhắn đến gói thuê bao Pub/Sub.

Cách kiểm thử gói thuê bao Google Workspace:

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 một tin nhắn vào 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

   Đảm bảo bạn đã chọn dự án trên Đám mây cho ứng dụng của mình.

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

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 vài phút thì một sự kiện mới 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 một 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/PROJECT_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: Số lượng tối đa tin nhắn Pub/Sub mà bạn muốn kéo.

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

Đối với mỗi sự kiện Google Workspace mà bạn đã kích hoạt, một thông báo sẽ được gửi đến gói thuê bao Pub/Sub của bạn có chứa sự kiện đó. Để biết thông tin chi tiết, hãy xem phần Nhận sự kiện dưới dạng thông báo của Google Cloud Pub/Sub.

Định cấu hình cách ứng dụng của bạn nhận các sự kiện

Gói thuê bao Pub/Sub mà bạn tạo là gói dựa trên thao tác kéo. Sau khi kiểm thử gói thuê bao Pub/Sub, bạn có thể cập nhật loại phân phối để thay đổi cách ứng dụng nhận sự kiện. Ví dụ: bạn có thể định cấu hình gói thuê bao Pub/Sub thành loại phân phối đẩy để ứng dụng của bạn có thể nhận các sự kiện trực tiếp đến một điểm cuối của ứng dụng.

Để tìm hiểu về cách định cấu hình gói thuê bao Pub/Sub, hãy xem tài liệu về Pub/Sub.

Lưu ý: Bạn không thể đặt dự án Apps Script làm điểm cuối phân phối đẩy trong Pub/Sub. Để truyền thông báo Pub/Sub đến một dự án Apps Script, bạn phải xuất bản tập lệnh dưới dạng một ứng dụng web.

Chủ đề có liên quan

• Hướng dẫn: Theo dõi các sự kiện trong cuộc họp bằng Python và Google Meet REST API
• Mua gói thuê bao
• Liệt kê các gói thuê bao
• Cập nhật hoặc gia hạn gói thuê bao
• Giải quyết lỗi và kích hoạt lại gói thuê bao
• Xoá gói thuê bao