Tài liệu này chứa thông tin xác thực và cấp quyền dành riêng cho API Gmail. Trước khi đọc tài liệu này, hãy nhớ đọc thông tin chung về 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 để 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 những 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 của bạn để có thể phát hành sau.
Phạm vi API Gmail
Để 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 xử lý của ứng dụng về việc 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 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 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 được mô tả rõ ràng, có giới hạn.
API Gmail hỗ trợ các phạm vi sau:
| Mã phạm vi | Nội dung 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 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 của email 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 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 chúng mà 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ả thao tác đọc/ghi, ngoại trừ thao tác xoá ngay lập tức và vĩnh viễn các chuỗi 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 tài nguyên bao gồm nhãn, bản ghi nhật ký và tiêu đề email, nhưng không đọc nội dung hoặc tệp đính kèm của thư. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.settings.basic |
Quản lý các chế độ cài đặt cơ bản của thư. | Bị hạn chế |
https://www.googleapis.com/auth/gmail.settings.sharing |
Quản lý chế độ cài đặt cho thư nhạy cảm, bao gồm cả các quy tắc chuyển tiếp và email đại diện.
Lưu ý:Bạn chỉ có thể sử dụng các thao tác quản trị trong phạm vi này. Các gói này chỉ dành cho những khách hàng Google Workspace sử dụng tài khoản dịch vụ có tính năng 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ư | Bị hạn chế |
Cột Mức 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 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 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. Những 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 cung cấp quyền truy cập rộng 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 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 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), thì bạn cần trải qua quy trình đánh giá bảo mật.
Bạn có thể xem thêm thông tin chi phối việc sử dụng và truy cập vào API Gmail khi yêu cầu truy cập vào dữ liệu người dùng trong Chính sách dành cho nhà phát triển và dữ liệu người dùng của Dịch vụ API 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, thì 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 các API của Google.
Xác minh OAuth
Việc sử dụng một số phạm vi OAuth nhạy cảm có thể yêu cầu ứng dụng phải trải qua 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 bằ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 cần thiết. Xem thêm Dịch vụ API của Google: Chính sách dữ liệu người dùng.