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 Drive API. 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 tại Tìm hiểu về việc 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 đồ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 để bạn có thể xuất bản ứng dụng sau này.
Phạm vi Drive 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à 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 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.
Nếu có thể, bạn nên sử dụng các phạm vi không nhạy cảm vì phạm vi này cấp quyền truy cập theo từng tệp và thu hẹp quyền truy cập vào các tính năng cụ thể mà ứng dụng cần.
Drive API hỗ trợ các phạm vi sau:
Mã phạm vi | Mô tả | Cách sử dụng |
---|---|---|
https://www.googleapis.com/auth/drive.appdata |
Xem và quản lý dữ liệu cấu hình riêng của ứng dụng trong Google Drive. | Nên dùng Không nhạy cảm |
https://www.googleapis.com/auth/drive.install |
Cho phép các ứng dụng xuất hiện dưới dạng một lựa chọn trong trình đơn "Mở bằng" hoặc "Mới". | Nên dùng Không nhạy cảm |
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 trình chọn tệp của ứng dụng. | Nên dùng Không nhạy cảm |
https://www.googleapis.com/auth/drive.apps.readonly |
Xem những ứng dụng được phép truy cập vào Drive của bạn. | 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.activity |
Xem và thêm vào hồ sơ hoạt động của các tệp trong Drive. | Bị hạn chế |
https://www.googleapis.com/auth/drive.activity.readonly |
Xem hồ sơ hoạt động của các tệp trong Drive. | Bị hạn chế |
https://www.googleapis.com/auth/drive.meet.readonly |
Xem các tệp trên Drive do Google Meet tạo hoặc chỉnh sửa. | 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ế |
https://www.googleapis.com/auth/drive.scripts |
Sửa đổi hoạt động của các tập lệnh Google Apps Script. | 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:
Nên dùng / Không nhạy cảm: Các phạm vi này cung cấp phạm vi nhỏ nhất của 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 Các yêu cầu về việc xác minh.
Được đề xuất / 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 cho phép ứng dụng của bạn truy cập. Bạ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 trên 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 Chính sách dữ liệu người dùng của các dịch vụ API của Google 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 thuộc 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 có 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 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. Xem thêm Điều khoản dịch vụ của Google Drive.
Trường hợp sử dụng phạm vi bị hạn chế
Đối với Drive, chỉ những loại ứng dụng sau đây mới có thể truy cập vào các phạm vi bị hạn chế:
- Các ứng dụng dành riêng cho nền tảng và ứng dụng web cung cấp tính năng đồng bộ hoá cục bộ hoặc sao lưu tự động các tệp của người dùng trên Drive.
- Các ứng dụng năng suất và giáo dục có giao diện người dùng có thể liên quan đến hoạt động tương tác với các tệp trên Drive (hoặc siêu dữ liệu hoặc quyền của các tệp đó). Các ứng dụng cải thiện hiệu suất bao gồm ứng dụng quản lý công việc, ghi chú, giao tiếp nhóm làm việc và cộng tác trong lớp học.
- Các ứng dụng báo cáo và bảo mật cung cấp thông tin chi tiết về người dùng hoặc khách hàng về cách chia sẻ hoặc truy cập vào tệp.
Để tiếp tục sử dụng các phạm vi bị hạn chế, bạn nên chuẩn bị ứng dụng của mình cho quy trình xác minh phạm vi bị hạn chế.
Di chuyển một ứng dụng hiện có từ các phạm vi bị hạn chế
Nếu đã phát triển một ứng dụng Drive bằng cách sử dụng bất kỳ phạm vi bị hạn chế nào, bạn nên di chuyển ứng dụng của mình để sử dụng một phạm vi không nhạy cảm vì phạm vi này cấp quyền truy cập theo từng tệp và thu hẹp quyền truy cập vào các tính năng cụ thể mà ứng dụng cần. Nhiều ứng dụng hoạt động với quyền truy cập theo từng tệp mà không cần thay đổi. Nếu đang sử dụng công cụ chọn tệp của riêng mình, bạn nên chuyển sang Google Picker API. API này hỗ trợ đầy đủ các phạm vi khác nhau.
Lợi ích của phạm vi OAuth drive.file
Việc sử dụng phạm vi OAuth drive.file
và Google Picker API giúp tối ưu hoá cả trải nghiệm người dùng và độ an toàn cho ứng dụng của bạn.
Phạm vi drive.file
OAuth cho phép người dùng chọn những tệp mà họ muốn chia sẻ với ứng dụng của bạn. Điều này giúp họ có nhiều quyền kiểm soát hơn và yên tâm rằng quyền truy cập của ứng dụng vào tệp của họ bị hạn chế và an toàn hơn. Ngược lại, việc yêu cầu quyền truy cập rộng rãi vào tất cả các tệp trên Drive có thể khiến người dùng không muốn tương tác với ứng dụng của bạn. Sau đây là một số lý do bạn nên sử dụng phạm vi drive.file
:
Khả năng sử dụng: Phạm vi
drive.file
hoạt động với tất cả Tài nguyên REST của Drive API, nghĩa là bạn có thể sử dụng phạm vi này theo cách tương tự như khi sử dụng các phạm vi OAuth rộng hơn.Tính năng: Google Picker API cung cấp một giao diện tương tự như giao diện người dùng Drive. Điều này bao gồm một số khung hiển thị cho thấy bản xem trước và hình thu nhỏ của các tệp trên Drive, cũng như một cửa sổ phương thức nội tuyến để người dùng không bao giờ rời khỏi ứng dụng chính.
Tiện lợi: Các ứng dụng có thể áp dụng bộ lọc cho một số loại tệp nhất định trên Drive (chẳng hạn như Google Tài liệu, Trang tính và ảnh) khi sử dụng bộ lọc trên các tệp của Google Picker.
Ngoài ra, vì drive.file
không phải là thông tin nhạy cảm nên quy trình xác minh sẽ diễn ra suôn sẻ hơn.
Lưu mã làm mới
Lưu mã làm mới trong bộ nhớ bảo mật, dài hạn và tiếp tục sử dụng chúng miễn là chúng vẫn còn hiệu lực.