Tài liệu này chứa thông tin uỷ quyền và xác thực dành riêng cho API Google Workspace Events. Trước khi đọc tài liệu này, hãy nhớ đọc thông tin chung về quy trình xác thực và uỷ quyền của Google Workspace tại phần Tìm hiểu về quy trình xác thực và uỷ quyền.
Định cấu hình OAuth 2.0 để uỷ quyền
Định cấu hình màn hình xin phép bằng OAuth và chọn phạm vi để xác định thông tin nào sẽ hiển thị cho người dùng và người đánh giá ứng dụng, đồng thời đăng ký ứng dụng để bạn có thể xuất bản sau này.
Phạm vi của Google Workspace Events API
Để xác định cấp truy cập được cấp cho ứng dụng, bạn cần xác định và khai báo phạm vi uỷ quyền. Phạm vi uỷ quyền là một chuỗi URI OAuth 2.0 chứa tên ứng dụng Google Workspace, loại dữ liệu mà ứng dụng truy cập và cấp truy cập. Phạm vi là yêu cầu của ứng dụng để làm việc với dữ liệu trên Google Workspace, bao gồm cả dữ liệu trong Tài khoản Google của người dùng.
Khi ứng dụng của bạn được cài đặt, người dùng sẽ được yêu cầu xác thực các phạm vi mà ứng dụng sử dụng. Nhìn chung, bạn nên chọn phạm vi hẹp nhất có thể và tránh yêu cầu các phạm vi mà ứng dụng của bạn không cần. Người dùng sẵn sàng cấp quyền truy cập vào các phạm vi hạn chế, được mô tả rõ ràng.
API Google Workspace Events sử dụng phạm vi của các ứng dụng Google Workspace có hỗ trợ gói thuê bao. Nếu ứng dụng của bạn đã sử dụng các phạm vi cần thiết cho gói thuê bao, thì bạn không cần thêm phạm vi để sử dụng API Google Workspace Events. Nếu bạn thêm phạm vi, hãy chọn phạm vi ít nhạy cảm nhất mà vẫn cho phép ứng dụng của bạn hoạt động. Để biết thông tin chi tiết về các danh mục phạm vi, hãy xem phần Danh mục phạm vi.
Bảng sau đây liệt kê các phạm vi được hỗ trợ cho API Google Workspace Events:
| Mã phạm vi | Mô tả | Cách sử dụng | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Cho phép các ứng dụng Chat xem cuộc trò chuyện và gửi tin nhắn. Cấp quyền truy cập vào tất cả tính năng có trong ứng dụng Chat. | Không nhạy cảm | ||
https://www.googleapis.com/auth/chat.memberships |
Xem, thêm và loại thành viên khỏi các cuộc trò chuyện trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Xem thành viên trong các cuộc trò chuyện trên Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.app.memberships |
Xem, thêm, cập nhật và xoá thành viên khỏi cuộc trò chuyện và không gian trong Chat dưới dạng một ứng dụng Chat. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng quyền uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Nhạy cảm |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Xem thành viên trong các cuộc trò chuyện và không gian trên Google Chat dưới dạng một ứng dụng Chat. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng quyền uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Nhạy cảm |
||
https://www.googleapis.com/auth/chat.spaces |
Tạo cuộc trò chuyện và không gian cũng như xem hoặc cập nhật siêu dữ liệu (bao gồm cả chế độ cài đặt nhật ký) trong Chat. | Nhạy cảm | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Xem cuộc trò chuyện và không gian trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.app.spaces |
Tạo cuộc trò chuyện và không gian cũng như xem hoặc cập nhật siêu dữ liệu (bao gồm cả chế độ cài đặt nhật ký) trong Chat dưới dạng ứng dụng Chat. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng quyền uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Nhạy cảm |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Xem siêu dữ liệu (bao gồm cả chế độ cài đặt nhật ký) trong Google Chat dưới dạng một ứng dụng Chat. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng quyền uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Nhạy cảm |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Xem, thêm và xoá các lượt bày tỏ cảm xúc đối với tin nhắn trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Xem biểu tượng cảm xúc đối với tin nhắn trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.messages |
Xem, soạn, gửi, cập nhật và xoá tin nhắn, cũng như thêm, xem và xoá biểu tượng cảm xúc đối với tin nhắn. | Bị hạn chế | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Xem tin nhắn và biểu tượng cảm xúc trong Chat. | Bị hạn chế |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Xem tin nhắn và biểu tượng cảm xúc trong Chat dưới dạng một ứng dụng Chat. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng quyền uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Bị hạn chế |
||
https://www.googleapis.com/auth/chat.users.readstate |
Xem và cập nhật trạng thái đọc của người dùng trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Xem trạng thái đọc của người dùng trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.users.availability |
Xem và thay đổi trạng thái rảnh/bận trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Xem trạng thái có mặt/vắng mặt trong Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Xem siêu dữ liệu về tất cả không gian và cuộc trò chuyện trong Google Chat trên toàn bộ tổ chức của bạn trong Google Workspace, ngay cả khi ứng dụng Chat không phải là một thành viên. Phạm vi này chỉ được hỗ trợ cho gói thuê bao của khách hàng. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng tính năng uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Bị hạn chế | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Xem tất cả thành viên trong các không gian và cuộc trò chuyện trên Google Chat trong toàn bộ tổ chức của bạn trên Google Workspace, ngay cả khi ứng dụng Chat không phải là thành viên. Phạm vi này chỉ được hỗ trợ cho gói thuê bao của khách hàng. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng tính năng uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Bị hạn chế | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Xem tất cả tin nhắn và lượt thể hiện cảm xúc trong toàn bộ tổ chức của bạn trên Google Workspace, ngay cả khi ứng dụng Chat không phải là thành viên của một không gian hoặc cuộc trò chuyện. Phạm vi này chỉ được hỗ trợ cho gói thuê bao của khách hàng. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng tính năng uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Bị hạn chế | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Xem thời gian đọc tin nhắn gần đây nhất của tất cả người dùng trong tất cả không gian và cuộc trò chuyện trong toàn bộ tổ chức của bạn trên Google Workspace, ngay cả khi ứng dụng Chat không phải là thành viên. Phạm vi này chỉ được hỗ trợ cho gói thuê bao của khách hàng. Cần có sự phê duyệt của quản trị viên. Phạm vi này chỉ hỗ trợ phương thức xác thực ứng dụng bằng tài khoản dịch vụ. Bạn không thể xác thực bằng thông tin đăng nhập của người dùng hoặc bằng tính năng uỷ quyền trên toàn miền khi sử dụng phạm vi này. |
Bị hạn chế | ||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
Tạo tệp mới trên Drive hoặc sửa đổi tệp hiện có mà bạn mở bằng một ứng dụng hoặc người dùng chia sẻ với một ứng dụng trong khi sử dụng Google Picker API hoặc bộ chọn tệp của ứng dụng. | Không nhạy cảm | ||
https://www.googleapis.com/auth/drive |
Xem và quản lý tất cả tệp của bạn trên Drive. | Bị hạn chế | ||
https://www.googleapis.com/auth/drive.readonly |
Xem và tải tất cả tệp của bạn trên Drive xuống. | Bị hạn chế | ||
https://www.googleapis.com/auth/drive.metadata |
Xem và quản lý siêu dữ liệu của các tệp trong Drive của bạn. | Bị hạn chế | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Xem siêu dữ liệu cho tệp trong Drive của bạn. | Bị hạn chế | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Cho phép các ứng dụng tạo, sửa đổi và đọc siêu dữ liệu về không gian họp do ứng dụng của bạn tạo. | Nhạy cảm |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Cho phép ứng dụng đọc siêu dữ liệu về mọi không gian họp mà người dùng có quyền truy cập. | Nhạy cảm |
||
Cột Cách sử dụng trong bảng trước cho biết mức độ nhạy cảm của từng phạm vi:
Không nhạy cảm: Những phạm vi này cung cấp phạm vi truy cập uỷ quyền nhỏ nhất và chỉ yêu cầu xác minh ứng dụng cơ bản. Để biết thông tin về yêu cầu này, hãy xem Yêu cầu xác minh.
Nhạy cảm: Các phạm vi này cung cấp quyền truy cập vào Dữ liệu người dùng cụ thể trên Google mà người dùng đã cho phép ứng dụng của bạn truy cập. Bạn cần phải trải qua quy trình xác minh ứng dụng bổ sung. Để biết thông tin về yêu cầu này, hãy xem Yêu cầu về phạm vi nhạy cảm và bị hạn chế.
Bị hạn chế: Những phạm vi này cung cấp quyền truy cập rộng vào Dữ liệu người dùng của Google và yêu cầu bạn phải trải qua quy trình xác minh phạm vi bị hạn chế. Để biết thông tin về yêu cầu này, hãy xem bài viết Dịch vụ API của Google: Chính sách dữ liệu người dùng và Yêu cầu bổ sung đối với các phạm vi API cụ thể. Nếu lưu trữ dữ liệu thuộc phạm vi bị hạn chế trên máy chủ (hoặc truyền dữ liệu), thì bạn phải trải qua quy trình đánh giá bảo mật.
Nếu ứng dụng của bạn yêu cầu quyền truy cập vào bất kỳ API nào khác của Google, thì bạn cũng có thể thêm các phạm vi đó. Để biết thêm thông tin về phạm vi API của Google, hãy xem bài viết Sử dụng OAuth 2.0 để truy cập vào các API của Google.
Để biết thêm thông tin về các phạm vi OAuth 2.0 cụ thể, hãy xem bài viết Phạm vi OAuth 2.0 cho các API của Google.
Xác minh OAuth
Khi sử dụng một số phạm vi OAuth, ứng dụng của bạn có thể phải thực hiện quy trình Xác minh ứng dụng OAuth trong Trung tâm trợ giúp. Đọc Câu hỏi thường gặp về ứng dụng OAuth để xác định thời điểm ứng dụng của bạn cần được xác minh và loại xác minh cần thiết. Xem thêm Điều khoản dịch vụ của Drive.
Các loại xác thực bắt buộc
Phần này giải thích những loại xác thực nào là bắt buộc hoặc được hỗ trợ, đồng thời cung cấp các phạm vi được hỗ trợ cho từng phương thức của Google Workspace Events API.
Đối với gói thuê bao sự kiện trong Chat, API Sự kiện của Google Workspace hỗ trợ cả phương thức xác thực người dùng và xác thực ứng dụng để gọi một số phương thức của API này. Nếu một phương thức API hỗ trợ cả hai thông tin xác thực, thì loại thông tin xác thực được dùng trong lệnh gọi sẽ ảnh hưởng đến kết quả được trả về. Ví dụ: nếu bạn gọi phương thức subscriptions.list bằng quy trình xác thực người dùng, thì API sẽ trả về danh sách các gói thuê bao mà người dùng đã xác thực có thể truy cập. Nếu bạn sử dụng phương thức xác thực ứng dụng, API sẽ trả về danh sách các gói thuê bao mà ứng dụng có thể truy cập. Để tìm hiểu thêm về
các loại phương thức xác thực trong Chat, hãy xem bài viết Xác thực và uỷ quyền
ứng dụng Chat và yêu cầu
API Chat.
Bảng sau đây cho biết những phạm vi và loại xác thực nào là bắt buộc hoặc được hỗ trợ cho từng phương thức của API Google Workspace Events:
| Phương thức | Yêu cầu hoặc hỗ trợ xác thực người dùng | Hỗ trợ xác thực ứng dụng (chỉ dành cho ứng dụng Chat) | Phạm vi uỷ quyền được hỗ trợ | |
|---|---|---|---|---|
| Tạo gói thuê bao | — |
Khi xác thực người dùng, bạn cần có phạm vi được hỗ trợ cho từng loại sự kiện:
Khi ứng dụng xác thực và quản trị viên phê duyệt (chỉ dành cho ứng dụng Google Chat), cần có phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Mua gói thuê bao |
Khi xác thực người dùng, phương thức này yêu cầu một phạm vi hỗ trợ ít nhất một loại sự kiện cho gói thuê bao.
Với phương thức xác thực ứng dụng (chỉ dành cho ứng dụng Chat):
|
|||
| Liệt kê các gói thuê bao |
Khi xác thực người dùng, phương thức này yêu cầu một phạm vi hỗ trợ ít nhất một loại sự kiện cho gói thuê bao.
Với phương thức xác thực ứng dụng (chỉ dành cho ứng dụng Chat):
|
|||
| Cập nhật gói thuê bao | — |
Khi xác thực người dùng, bạn cần có phạm vi được hỗ trợ cho từng loại sự kiện:
Khi ứng dụng xác thực và quản trị viên phê duyệt (chỉ dành cho ứng dụng Google Chat), cần có phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Kích hoạt lại gói thuê bao | — |
Khi xác thực người dùng, bạn cần có phạm vi được hỗ trợ cho từng loại sự kiện:
Khi ứng dụng xác thực và quản trị viên phê duyệt (chỉ dành cho ứng dụng Chat), cần có phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Xoá gói thuê bao |
Khi xác thực người dùng, phương thức này yêu cầu một phạm vi hỗ trợ ít nhất một loại sự kiện cho gói thuê bao.
Với phương thức xác thực ứng dụng (chỉ dành cho ứng dụng Chat):
|
|||
Phạm vi theo loại sự kiện
Khi gọi API Google Workspace Events bằng phương thức xác thực người dùng, bạn phải chỉ định một hoặc nhiều phạm vi tương ứng với các loại sự kiện của gói thuê bao.
Bảng sau đây cho biết những phạm vi uỷ quyền được hỗ trợ cho từng loại sự kiện:
| Sự kiện | Loại sự kiện | Phạm vi uỷ quyền được hỗ trợ | ||||||
|---|---|---|---|---|---|---|---|---|
| Trò chuyện | ||||||||
| Một tin nhắn được đăng hoặc cập nhật. |
|
Với Xác thực người dùng:
|
||||||
| Một biểu tượng cảm xúc được thêm hoặc xoá, hoặc nhiều biểu tượng cảm xúc được thay đổi. |
|
Với Xác thực người dùng:
|
||||||
| Một thành viên được tạo, cập nhật hoặc xoá, hoặc nhiều thành viên bị thay đổi. |
|
Với Xác thực người dùng:
|
||||||
| Một không gian được cập nhật hoặc xoá. |
|
Với Xác thực người dùng:
|
||||||
| Trạng thái đọc không gian hoặc trạng thái đọc chuỗi tin nhắn của người dùng được cập nhật. |
|
Với Xác thực người dùng:
|
||||||
| Tình trạng còn hàng được cập nhật. |
|
Với Xác thực người dùng:
|
||||||
| Drive | ||||||||
| Một tệp được tạo, thay đổi, di chuyển, xoá, đổi tên, chuyển vào thùng rác hoặc xoá khỏi thùng rác. |
|
|
||||||
| Một Đề xuất quyền truy cập được tạo hoặc giải quyết trên một tệp. |
|
|
||||||
| Một Yêu cầu phê duyệt bị huỷ, hoàn tất, được tạo, đặt lại, thay đổi người đánh giá hoặc người đánh giá đã phản hồi về một tệp. |
|
|
||||||
| Một Nhận xét được tạo, xoá, chỉnh sửa, mở lại hoặc giải quyết trên một tệp. |
|
|
||||||
| Một Câu trả lời được tạo, xoá hoặc chỉnh sửa trên một tệp. |
|
|
||||||
| Quyền được tạo, xoá hoặc chỉnh sửa trên một tệp. |
|
|
||||||
| Meet | ||||||||
| Một cuộc họp bắt đầu hoặc kết thúc. |
|
|
||||||
| Người tham gia tham gia hoặc rời khỏi hội nghị. |
|
|
||||||
| Đã tạo một bản ghi. |
|
|
||||||
| Đã tạo bản chép lời. |
|
|
||||||