Hướng dẫn so sánh API Drive phiên bản 2 và phiên bản 3

Phiên bản mới nhất của Google Drive API là phiên bản 3. Hiệu suất trong phiên bản 3 tốt hơn vì các tìm kiếm chỉ trả về một tập hợp con các trường. Sử dụng phiên bản hiện tại, trừ phi bạn cần bộ sưu tập v2. Nếu bạn đang sử dụng phiên bản 2, hãy cân nhắc việc di chuyển sang phiên bản 3. Để di chuyển, hãy xem phần Di chuyển sang Drive API phiên bản 3. Để xem danh sách đầy đủ về điểm khác biệt giữa các phiên bản, hãy xem Tài liệu tham khảo so sánh Drive API phiên bản 2 và phiên bản 3.

Nếu bạn muốn tiếp tục sử dụng phiên bản 2, hãy xem nội dung sửa đổi Hướng dẫn về Drive API phiên bản 2 để tìm hiểu cách một số hướng dẫn trong hướng dẫn về phiên bản 3 phải được sửa đổi cho nhà phát triển phiên bản 2.

Để tìm hiểu thêm về những điểm cải tiến của Drive API phiên bản 3, bạn có thể xem video sau đây của các kỹ sư Google thảo luận về thiết kế API mới.

Các điểm cải tiến của V3

Để tối ưu hoá hiệu suất và giảm độ phức tạp của hành vi API, phiên bản 3 cung cấp những điểm cải tiến sau so với phiên bản API trước:

  • Theo mặc định, các cụm từ tìm kiếm tệp và bộ nhớ dùng chung sẽ không trả về toàn bộ tài nguyên, mà chỉ trả về một nhóm nhỏ các trường thường dùng. Để biết thêm thông tin chi tiết về fields, hãy xem phương thức files.list và phương thức drives.list.
  • Hầu hết các phương thức trả về phản hồi hiện đều yêu cầu tham số fields. Để biết danh sách tất cả các phương thức yêu cầu fields, hãy xem tài liệu tham khảo về Drive API.
  • Đã xoá những tài nguyên có các chức năng trùng lặp. Một số ví dụ:
    • Phương thức files.list thực hiện cùng chức năng với các tập hợp ChildrenParents, nên các tập hợp này sẽ bị xoá khỏi phiên bản 3.
    • Các phương thức Realtime.* đã bị xoá.
  • Theo mặc định, Dữ liệu ứng dụng không được trả về trong các lượt tìm kiếm. Trong phiên bản 2, bạn có thể đặt phạm vi drive.appdata và phạm vi này sẽ trả về dữ liệu ứng dụng từ phương thức files.list và phương thức changes.list, nhưng điều này sẽ làm giảm hiệu suất. Trong phiên bản 3, bạn đặt phạm vi drive.appdata, đồng thời đặt tham số truy vấn spaces=appDataFolder để yêu cầu dữ liệu ứng dụng.
  • Tất cả các thao tác cập nhật đều sử dụng PATCH thay vì PUT.
  • Để xuất Tài liệu trên Google, hãy sử dụng phương thức files.export.
  • Hành vi của phương thức changes.list sẽ khác. Thay vì mã nhận dạng thay đổi, hãy sử dụng mã thông báo trang không công khai. Để thăm dò tập hợp thay đổi, trước tiên, hãy gọi phương thức changes.getStartPageToken cho giá trị ban đầu. Đối với các truy vấn tiếp theo, phương thức changes.list sẽ trả về giá trị newStartPageToken.
  • Giờ đây, các phương thức cập nhật sẽ từ chối những yêu cầu chỉ định các trường không thể ghi.
  • Các trường exportFormatsimportFormats phiên bản 2 trong tài nguyên about là danh sách các định dạng nhập hoặc xuất cho phép. Trong phiên bản 3, đây là các bản đồ loại MIME của các mục tiêu có thể có đối với tất cả các hoạt động nhập hoặc xuất được hỗ trợ.
  • Các bí danh appdataappfolder của phiên bản 2 hiện là appDataFolder trong phiên bản 3.
  • Tài nguyên properties sẽ bị xoá khỏi phiên bản 3. Tài nguyên files có trường properties chứa các cặp khoá-giá trị thực. Trường properties chứa các thuộc tính công khai và trường appProperties chứa các thuộc tính riêng tư, vì vậy bạn không cần trường hiển thị.
  • Trường modifiedTime trong tài nguyên files sẽ cập nhật thời điểm sửa đổi tệp gần đây nhất. Trong phiên bản 2, trường modifiedDate chỉ có thể thay đổi khi cập nhật nếu bạn đặt trường setModifiedDate.
  • Trường viewedByMeTime trong tài nguyên files không tự động cập nhật.
  • Để nhập các định dạng của Google Tài liệu, bạn hãy đặt mục tiêu thích hợp mimeType trong nội dung tài nguyên. Trong phiên bản 2, bạn đặt ?convert=true.
  • Các thao tác nhập sẽ trả về lỗi 400 nếu định dạng không được hỗ trợ.
  • Người đọc và người nhận xét không thể xem quyền.
  • Bí danh me cho các quyền sẽ bị xoá.
  • Một số chức năng có trong tài nguyên yêu cầu nhưng thay vào đó, lại có dưới dạng một tham số yêu cầu. Ví dụ:
    • Trong phiên bản 2, bạn có thể dùng children.delete để xoá một tệp con khỏi thư mục mẹ.
    • Trong phiên bản 3, bạn sử dụng files.update trên trẻ em có ?removeParents=parent_id trong URL.

Các điểm khác biệt khác

Tên trường và tên tham số khác nhau trong phiên bản 3. Một số ví dụ bao gồm:

  • Thuộc tính name thay thế title trong tài nguyên files.
  • Time là hậu tố cho tất cả các trường ngày và giờ thay vì Date.
  • Các thao tác liệt kê không dùng trường items để chứa tập kết quả. Loại tài nguyên cung cấp một trường cho kết quả (chẳng hạn như files hoặc changes).