Tài liệu này chứa thông tin về việc uỷ quyền và xác thực dành riêng cho API Sự kiện của Google Workspace. Trước khi đọc tài liệu này, hãy nhớ đọc thông tin chung về việc xác thực và uỷ quyền của Google Workspace tại bài viết Tìm hiểu về việc 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ể phát hành ứng dụng 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à các yêu cầu của ứng dụng để xử lý dữ liệu Google Workspace, bao gồm cả dữ liệu Tài khoản Google của người dùng.
Khi cài đặt ứng dụng, 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 tập trung hẹp nhất có thể và tránh yêu cầu các phạm vi mà ứng dụng không yêu cầu. Người dùng sẵn sàng cấp quyền truy cập vào các phạm vi bị giới hạn và được mô tả rõ ràng hơn.
Khi có thể, bạn nên sử dụng các phạm vi không nhạy cảm vì phạm vi này cấp phạm vi truy cập cho mỗi tệp và thu hẹp quyền truy cập vào chức năng cụ thể mà ứng dụng cần.
API Sự kiện của Google Workspace sử dụng các phạm vi từ các ứng dụng Google Workspace 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 các phạm vi khác để sử dụng API Sự kiện của Google Workspace.
Bảng sau đây cho thấy các phạm vi được hỗ trợ cho API Sự kiện của Google Workspace:
| 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 Google 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ó sẵn cho ứng dụng Chat. | Không nhạy cảm | ||
https://www.googleapis.com/auth/chat.memberships |
Xem, thêm và xoá thành viên khỏi các cuộc trò chuyện trong Google 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 Google Chat. | 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 Google Chat. | Nhạy cảm | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Xem cuộc trò chuyện và không gian trong Google Chat. | Nhạy cảm |
||
https://www.googleapis.com/auth/chat.messages.reaction giây |
Xem, thêm và xoá 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.reactions.readonly |
Xem biểu tượng cảm xúc đối với một 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á tin nhắn trả lời. | 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 Google Chat. | Bị hạn chế |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Cho phép ứ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ề bất kỳ không gian họp nào mà người dùng có quyền truy cập. | Nhạy cảm |
||
Cột Mức sử dụng trong bảng trước cho biết độ nhạy của từng phạm vi, theo các định nghĩa sau:
Không nhạy cảm – Các phạm vi này cung cấp phạm vi quyền 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 bài viết Các bước chuẩn bị cho quy trình xác minh.
Nhạy cảm – Các phạm vi này cung cấp quyền truy cập vào một số Dữ liệu người dùng trên Google cụ thể 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 bài viết Các bước dành cho ứng dụng yêu cầu phạm vi nhạy cảm
Bị hạn chế – Các phạm vi này cung cấp quyền truy cập rộng rãi 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 Dịch vụ API của Google: Chính sách dữ liệu người dùng và Các yêu cầu bổ sung đối với 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, 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 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 API của Google.
Xác minh OAuth
Để sử dụng một số phạm vi OAuth nhất định, ứng dụng của bạn có thể phải trải qua quy trình xác minh OAuth của Google. Hãy đọc Câu hỏi thường gặp về quy trình xác minh API OAuth để xác định thời điểm ứng dụng của bạn cần được xác minh và loại hình xác minh cần thiết. Xem thêm Điều khoản dịch vụ bổ sung của Google 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 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 API Sự kiện Google Workspace.
Đối với các gói thuê bao sự kiện trên Google Chat, API Sự kiện của Google Workspace hỗ trợ cả xác thực người dùng và ứng dụng để gọi một số phương thức của API. 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 thông tin 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 tính năng 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 xác thực Chat, hãy xem bài viết Xác thực và uỷ quyền cho các ứng dụng Chat và yêu cầu API Google Chat.
Bảng sau đây cho biết những phạm vi và loại xác thực bắt buộc hoặc được hỗ trợ cho từng phương thức API Sự kiện của Google Workspace:
| 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 Google Chat) | Phạm vi uỷ quyền được hỗ trợ | |
|---|---|---|---|---|
| Tạo gói thuê bao | — |
Yêu cầu phạm vi được hỗ trợ cho mỗi loại sự kiện:
|
||
| Mua gói thuê bao |
Với phương thức 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.
Bằng phương thức xác thực ứng dụng (chỉ dành cho ứng dụng Google Chat):
|
|||
| Liệt kê gói thuê bao |
Với phương thức 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.
Bằng phương thức xác thực ứng dụng (chỉ dành cho ứng dụng Google Chat):
|
|||
| Cập nhật gói thuê bao | — |
Yêu cầu phạm vi được hỗ trợ cho mỗi loại sự kiện:
|
||
| Kích hoạt lại gói thuê bao | — |
Yêu cầu phạm vi được hỗ trợ cho mỗi loại sự kiện:
|
||
| Xoá gói thuê bao |
Với phương thức 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.
Bằng phương thức xác thực ứng dụng (chỉ dành cho ứng dụng Google Chat):
|
|||
Phạm vi theo loại sự kiện
Khi gọi API Sự kiện của Google Workspace 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ợ | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Tin nhắn được đăng hoặc cập nhật. |
|
|
||||||
| Một phản ứng được thêm hoặc xoá, hoặc nhiều phản ứng được thay đổi. |
|
|
||||||
| Một gói thành viên được tạo, cập nhật hoặc xoá, hoặc nhiều gói thành viên được thay đổi. |
|
|
||||||
| Một không gian được cập nhật hoặc xoá. |
|
|
||||||
| Google Meet | ||||||||
| Một hội nghị bắt đầu hoặc kết thúc. |
|
|
||||||
| Một người tham gia tham gia hoặc rời khỏi một cuộc họp. |
|
|
||||||
| Đã tạo một bản ghi. |
|
|
||||||
| Đã tạo bản chép lời. |
|
|
||||||