Tài liệu này chứa thông tin xác thực và việc uỷ quyền dành riêng cho API Sự kiện 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 trong bài viết Tìm hiểu về quy trình xác thực và uỷ quyền.
Định cấu hình OAuth 2.0 để ủy 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 của bạn để bạn có thể phát hành sau.
Phạm vi API Sự kiện của Google Workspace
Để xác định cấp truy cập được cấp cho ứng dụng của mình, bạn cần xác định và khai báo phạm vi cấp quyền. Phạm vi uỷ quyền là một chuỗi URI OAuth 2.0 có 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 mà ứng dụng của bạn yêu cầu để hoạt động với dữ liệu Google Workspace, bao gồm cả dữ liệu trong 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 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 cần. Người dùng dễ dàng cấp quyền truy cập vào các phạm vi giới hạn, được mô tả rõ ràng.
Nếu có thể, bạn nên sử dụng 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 phạm vi từ 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 các phạm vi khác để sử dụng API Sự kiện của Google Workspace.
Bảng sau đây trình bày các phạm vi được hỗ trợ cho API Sự kiện của Google Workspace:
| Mã phạm vi | Nội dung 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ó trong các ứng dụng trong 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 |
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à lượt thể hiện cảm xúc trong Google Chat. | Bị hạn chế |
||
https://www.googleapis.com/auth/chat.messages.reaction giây |
Xem, thêm và xoá lượt thể hiện cảm xúc đối với tin nhắn trong Chat. | Bị hạn chế |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Xem các lượt thể hiện cảm xúc đối với tin nhắn trong Chat. | 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ề 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 Sử dụng trong bảng trước cho biết mức độ nhạy cảm 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 có phạm vi 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ị 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ể của Google mà người dùng đã ủy quyền cho ứng dụng của bạn. Bạn phải thực hiện 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ế – Những 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 thực hiện quy trình xác minh trong 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à 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 trong phạm vi bị hạn chế trên máy chủ (hoặc truyền), 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ề các phạm vi API của Google, hãy xem phần Sử dụng OAuth 2.0 để truy cập API Google.
Để biết thêm thông tin về các phạm vi OAuth 2.0 cụ thể, hãy xem nội dung Các phạm vi OAuth 2.0 cho API Google.
Xác minh OAuth
Việc sử dụng một số phạm vi OAuth có thể yêu cầu ứng dụng của bạn phải tiếp tục thông qua quy trình xác minh OAuth của Google. Hãy đọc bài viết Câu hỏi thường gặp về việc xác minh ứng dụng bằng API OAuth để xác định thời điểm ứng dụng của bạn cần trải qua quy trình xác minh và loại quy trình xác minh là bắt buộc. Ngoài ra, hãy xem Điều khoản dịch vụ bổ sung của Google Drive.
Loại xác thực bắt buộc
Phần này giải thích các 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 API Sự kiện Google Workspace.
Đối với các gói thuê bao nhận sự kiện trong Google Chat, API Sự kiện Google Workspace hỗ trợ cả phương thức xác thực người dùng và ứng dụng để gọi một số phương thức. 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 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 phương thức xác thực người dùng, 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 trong Chat, hãy xem bài viết Xác thực và uỷ quyền cho các ứng dụng trong Chat cũng như yêu cầu API Google Chat.
Bảng sau đây cho biết những phạm vi và loại hình xác thực bắt buộc hoặc được hỗ trợ cho mỗi phương thức API Sự kiện của Google Workspace:
| Phương thức | Yêu cầu xác thực người dùng hoặc được hỗ trợ | 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 | — |
Cần có một phạm vi được hỗ trợ cho từng 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 đòi hỏi một phạm vi hỗ trợ ít nhất một loại sự kiện cho gói thuê bao.
Với tính năng xác thực ứng dụng (chỉ dành cho ứng dụng Google Chat):
|
|||
| Danh sách gói thuê bao |
Với phương thức xác thực người dùng, phương thức này đòi hỏi một phạm vi hỗ trợ ít nhất một loại sự kiện cho gói thuê bao.
Với tính năng xác thực ứng dụng (chỉ dành cho ứng dụng Google Chat):
|
|||
| Cập nhật gói thuê bao | — |
Cần có một phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Kích hoạt lại gói thuê bao | — |
Cần có một phạm vi được hỗ trợ cho từng 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 đòi hỏi một phạm vi hỗ trợ ít nhất một loại sự kiện cho gói thuê bao.
Với tính năng 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 Google Workspace bằng tính năng 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 | ||||||||
| Một tin nhắn đã được đăng hoặc cập nhật. |
|
|
||||||
| Một biểu tượng bày tỏ cảm xúc được thêm/xoá hoặc nhiều lượt thể hiện cảm xú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 bị xoá. |
|
|
||||||
| Google Meet | ||||||||
| Hội nghị truyền hình 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. |
|
|
||||||
| Một bản chép lời đã được tạo. |
|
|
||||||