Tài liệu này chứa thông tin uỷ quyền dành riêng cho API Sự kiện của Google Workspace và thông tin xác thực. Trước khi đọc tài liệu này, hãy nhớ đọc Thông tin uỷ quyền và xác thực chung của Google Workspace tại Tìm hiểu về tính năng 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, cũng như đăng ký ứng dụng của bạn để bạn có thể xuất bản sau này.
Phạm vi của API Sự kiện trên 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 uỷ 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 trên Google Workspace, loại dữ liệu mà ứng dụng truy cập và cấp truy cập. Phạm vi là những yêu cầu mà ứng dụng của bạn yêu cầu để làm việc với dữ liệu trong Google Workspace, bao gồm cả của người dùng dữ liệu trong Tài khoản Google.
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 phạm vi đã sử dụng theo ứng dụng. Thông thường, bạn nên chọn phạm vi có độ tập trung hẹp nhất 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 có thêm 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.
Khi 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 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 trong Google Workspace các ứng dụng có hỗ trợ đăng ký. Nếu ứng dụng của bạn đã sử dụng các phạm vi bắt buộc đối với gói thuê bao của bạn, bạn không cần thêm các phạm vi 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 | 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. Cho quyền sử dụng mọi tính năng dành 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 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á các 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 các lượt bày tỏ cảm xúc 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à lượt thể hiện cảm xúc trong Google 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 ra. | 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 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 cung cấp phạm vi nhỏ nhất của uỷ quyền và chỉ yêu cầu xác minh ứng dụng cơ bản. Cho thông tin về yêu cầu này, hãy xem 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 được người dùng uỷ quyền cho ứng dụng của bạn. Bạn phải thực hiện xác minh ứng dụng bổ sung. Để biết thông tin về yêu cầu này, hãy xem Các bước đối với các ứng dụng yêu cầu quyền truy cập thông tin nhạy cảm các phạm vi
Bị hạn chế—Các phạm vi này 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 thực hiện quy trình xác minh trong phạm vi hạn chế. Cho thông tin về yêu cầu này, hãy xem bài viết Dịch vụ API của Google: Dữ liệu người dùng Chính sách và Yêu cầu bổ sung đối với API cụ thể Phạm vi. Nếu lưu trữ dữ liệu trong phạm vi bị hạn chế trên máy chủ (hoặc máy chủ truyền dữ liệu), bạn phải sẽ 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ó thể thêm các phạm vi đó của Google. Để biết thêm thông tin về các phạm vi API của Google, hãy xem bài viết Sử dụng OAuth 2.0 để Truy cập 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 phần Các phạm vi của OAuth 2.0 cho API của Google.
Xác minh OAuth
Việc sử dụng một số phạm vi OAuth nhất định có thể yêu cầu ứng dụng của bạn tiến hành thông qua Xác minh OAuth . Đọc bài viết về xác minh API của OAuth Câu hỏi thường gặp để xác định thời điểm ứng dụng của bạn phải trải qua quy trình xác minh và loại bắt buộc phải xác minh. Xem thêm Điều khoản bổ sung của Google Drive Dịch vụ.
Các loại xác thực bắt buộc
Phần này giải thích 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 của Google Workspace.
Đối với gói thuê bao tham gia 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. Nếu một API
phương thức hỗ trợ cả thông tin xác thực, loại thông tin xác thực được sử dụng trong lệnh gọi
ảnh hưởng đến kết quả được trả về. Ví dụ: nếu bạn gọi hàm
subscriptions.list()
có xác thực người dùng thì API sẽ trả về danh sách các gói thuê bao
người dùng được xác thực mới 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 phần Xác thực và uỷ quyền
Các ứng dụng trong Chat và API của Google Chat
.
Bảng sau đây trình bày phạm vi và loại là yêu cầu bắt buộc hoặc được hỗ trợ xác thực đối với từng API Sự kiện của Google Workspace phương thức:
| Phương thức | Yêu cầu hoặc được hỗ trợ xác thực người dùng | Hỗ trợ phương thức xác thực ứng dụng (chỉ dành cho các ứng dụng Google Chat) | Phạm vi uỷ quyền được hỗ trợ | |
|---|---|---|---|---|
| Tạo gói thuê bao | — |
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 cần có 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 Google Chat):
|
|||
| Đăng ký danh sách |
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 Google Chat):
|
|||
| Cập nhật gói thuê bao | — |
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 | — |
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 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 của bạn.
Bảng sau đây trình bày những phạm vi uỷ quyền được hỗ trợ cho mỗi 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 thông báo được đăng hoặc cập nhật. |
|
|
||||||
| Một lượt thể hiện cảm xúc được thêm vào hoặc bị xoá hoặc nhiều lượt thể hiện cảm xúc được thay đổi. |
|
|
||||||
| Gói thành viên được tạo, cập nhật hoặc bị xoá hoặc có nhiều gói thành viên đều bị 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. |
|
|
||||||
| Một người tham gia sẽ tham gia hoặc rời khỏi cuộc hội thảo. |
|
|
||||||
| Một bản ghi đã được tạo. |
|
|
||||||
| Một bản chép lời đã được tạo. |
|
|
||||||