Tài liệu này chứa thông tin uỷ quyền và xác thực dành riêng cho Google Workspace Events API. 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 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 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 ứ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 của bạn, 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 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. Nói 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 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 có giới hạn và được mô tả rõ ràng.
Google Workspace Events API sử dụng các phạm vi từ các ứng dụng Google Workspace có hỗ trợ tính năng đăng ký. 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 Google Workspace Events API. Nếu bạn thêm các phạm vi, hãy chọn phạm vi ít nhạy cảm nhất nhưng vẫn cho phép ứng dụng của bạn hoạt động. Để biết thông tin chi tiết về 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 Google Workspace Events API:
| 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. Cho phép truy cập vào tất cả cá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ợ 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ỷ thác trên toàn miền bằ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 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ợ 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ỷ thác trên toàn miền bằng phạm vi này. |
Nhạy cảm |
||
https://www.googleapis.com/auth/chat.messages.reaction giây |
Xem, thêm và xoá các phản ứng đố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á 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 ứ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ợ 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ỷ thác trên toàn miền bằ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. | Bị hạn chế | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Xem siêu dữ liệu của các tệp trong Drive. | 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ề mọi không gian họp 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 mức độ nhạy cảm của từng phạm vi:
Không nhạy cảm: Các phạm vi này cung cấp phạm vi nhỏ nhất về quyền truy cập uỷ quyền 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 yêu cầu về việc xác minh.
Nhạy cảm: Các phạm vi này cho phép 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 bài viết Yêu cầu về phạm vi nhạy cảm và bị hạn chế.
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 trong 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 cần 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ề 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 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 Phạm vi OAuth 2.0 cho các 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 phải trải qua Trung tâm trợ giúp xác minh ứng dụng OAuth. Đọ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 trải qua quy trình xác minh và loại xác minh bắt buộc. Bạn cũng có thể xem Điều khoản dịch vụ của Drive.
Các loại phương thức 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 trên Google Workspace.
Đối với các sự kiện đăng ký trong Chat, Google Workspace Events API 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ày. Nếu một phương thức API hỗ trợ cả hai loại thông tin đăng nhập, thì loại thông tin đăng nhập đượ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 tính năng 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 Chat API.
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 Google Workspace Events API:
| 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 trò chuyện) | Các phạm vi uỷ quyền được hỗ trợ | |
|---|---|---|---|---|
| Tạo gói thuê bao | — |
Với 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:
Bản dùng trước cho nhà phát triển: Với xác thực ứng dụng và sự phê duyệt của quản trị viên (chỉ dành cho ứng dụng Chat), yêu cầu phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Mua gói thuê bao |
Với 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 tính năng xác thực ứng dụng (chỉ dành cho ứng dụng Chat):
|
|||
| Liệt kê các gói thuê bao |
Với 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 tính năng xác thực ứng dụng (chỉ dành cho ứng dụng Chat):
|
|||
| Cập nhật gói thuê bao | — |
Với 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:
Bản dùng trước cho nhà phát triển: Với xác thực ứng dụng và sự phê duyệt của quản trị viên (chỉ dành cho ứng dụng Chat), yêu cầu phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Kích hoạt lại gói thuê bao | — |
Với 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:
Bản dùng trước cho nhà phát triển: Với xác thực ứng dụng và phê duyệt của quản trị viên (Chỉ dành cho ứng dụng Chat), yêu cầu phạm vi được hỗ trợ cho từng loại sự kiện:
|
||
| Xoá gói thuê bao |
Với 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 tính năng 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 Sự kiện của Google Workspace bằng cách 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 | Các phạm vi uỷ quyền được hỗ trợ | ||||||
|---|---|---|---|---|---|---|---|---|
| Trò chuyện | ||||||||
| Một thông báo được đăng hoặc cập nhật. |
|
Với Xác thực người dùng:
|
||||||
| Một phản ứng được thêm hoặc xoá, hoặc nhiều phản ứng được thay đổi. |
|
|
||||||
| Gói hội viên được tạo, cập nhật hoặc xoá, hoặc nhiều gói hội viên được thay đổi. |
|
Với Xác thực người dùng:
|
||||||
| Không gian được cập nhật hoặc bị xoá. |
|
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. |
|
|
||||||
| Đề xuất cấp quyền truy cập được tạo hoặc giải quyết trên một tệp. |
|
|
||||||
| Yêu cầu phê duyệt bị huỷ, hoàn tất, 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 Bình luận đượ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 Phản hồi được tạo, xoá hoặc chỉnh sửa trên một tệp. |
|
|
||||||
| Một Quyền được tạo, xoá hoặc chỉnh sửa trên một tệp. |
|
|
||||||
| Meet | ||||||||
| Một hội nghị bắt đầu hoặc kết thúc. |
|
|
||||||
| Người tham gia tham gia hoặc rời khỏi một hội nghị. |
|
|
||||||
| Một bản ghi đã được tạo. |
|
|
||||||
| Một bản chép lời đã được tạo. |
|
|
||||||