Tài liệu này chứa thông tin uỷ quyền dành riêng cho API của Gmail 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 API của Gmail
Để 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.
API Gmail hỗ trợ các phạm vi sau:
| Mã phạm vi | Mô tả | Cách sử dụng |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Quản lý thư nháp và gửi email khi bạn tương tác với tiện ích bổ sung. | Không nhạy cảm |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Xem thông báo bằng email của bạn khi bạn tương tác với tiện ích bổ sung. | Không nhạy cảm |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Xem siêu dữ liệu nội dung email của bạn khi tiện ích bổ sung đang chạy. | Nhạy cảm |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Xem email của bạn khi tiện ích bổ sung đang chạy. | Nhạy cảm |
https://www.googleapis.com/auth/gmail.labels |
Chỉ tạo, đọc, cập nhật và xoá nhãn. | Không nhạy cảm |
https://www.googleapis.com/auth/gmail.send |
Chỉ gửi tin nhắn. Không có đặc quyền đọc hoặc sửa đổi đặc quyền đối với hộp thư. | Nhạy cảm |
https://www.googleapis.com/auth/gmail.readonly |
Đọc tất cả tài nguyên và siêu dữ liệu của tài nguyên đó – không cần thao tác ghi. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.compose |
Tạo, đọc, cập nhật và xoá bản nháp. Gửi thư và thư nháp. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.insert |
Chỉ chèn và nhập thư. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.modify |
Tất cả các thao tác đọc/ghi ngoại trừ thao tác xoá vĩnh viễn ngay lập tức chuỗi thư và thư, bỏ qua Thùng rác. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.metadata |
Đọc siêu dữ liệu về tài nguyên, bao gồm cả nhãn, bản ghi nhật ký và email tiêu đề thư chứ không phải nội dung thư hoặc tệp đính kèm. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.settings.basic |
Quản lý các chế độ cài đặt cơ bản về thư. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.settings.sharing |
Quản lý các tùy chọn cài đặt thư nhạy cảm, bao gồm cả quy tắc chuyển tiếp và bí danh.
Lưu ý:Các thao tác được bảo vệ theo phạm vi này chỉ được hỗ trợ chỉ sử dụng cho mục đích quản trị. Gói thuê bao chỉ dành cho khách hàng Google Workspace thông qua tài khoản dịch vụ có uỷ quyền trên toàn miền. |
Bị hạn chế |
https://mail.google.com/ |
Có toàn quyền truy cập vào hộp thư của tài khoản, bao gồm cả việc xoá vĩnh viễn chuỗi và thư Phạm vi này chỉ nên được yêu cầu nếu ứng dụng của bạn cần xoá ngay lập tức và vĩnh viễn các chuỗi và tin nhắn, bỏ qua Thùng rác; tất cả các hành động khác đều có thể được thực hiện với phạm vi nhỏ hơn. | Bị hạn chế |
Cột Sử dụng trong bảng trên 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 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 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 cho phép truy cập vào Dữ liệu người dùng của Google và yêu cầu quy trình xác minh phạm vi nhạy cảm. Để 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. Các phạm vi này không yêu cầu đánh giá bảo mật.
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 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 máy chủ truyền dữ liệu), bạn cần sẽ trải qua quy trình đánh giá bảo mật.
Thông tin bổ sung điều chỉnh việc bạn sử dụng và truy cập vào API Gmail khi bạn Bạn có thể tìm thấy các yêu cầu truy cập vào dữ liệu người dùng trong Dữ liệu người dùng và Chính sách dành cho nhà phát triển của dịch vụ API của Gmail.
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ả những phạm vi đó. Để biết thêm thông tin về phạm vi API của Google, xem Sử dụng OAuth 2.0 để truy cập Google API.
Xác minh OAuth
Việc sử dụng một số phạm vi OAuth nhạy cảm nhất định có thể yêu cầu ứng dụng của bạn phải truy cập Quy trình xác minh OAuth của Google. Đọc phần Câu hỏi thường gặp về quy trình xác minh OAuth để 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 Dịch vụ API của Google: Chính sách dữ liệu người dùng.