Tài liệu này trình bày những lưu ý quan trọng khi đặt tên tệp và làm việc với
siêu dữ liệu như văn bản có thể lập chỉ mục và hình thu nhỏ. Để chèn và truy xuất tệp, hãy xem
tài nguyên files
.
Chỉ định tên và phần mở rộng của tệp
Ứng dụng phải chỉ định đuôi tệp trong thuộc tính tiêu đề khi chèn tệp
bằng API Google Drive. Ví dụ: thao tác chèn tệp JPEG phải
chỉ định "name": "cat.jpg"
trong siêu dữ liệu.
Các phản hồi GET
tiếp theo có thể bao gồm thuộc tính fileExtension
chỉ đọc
được điền sẵn bằng phần mở rộng được chỉ định ban đầu trong thuộc tính name
. Khi một
Người dùng Google Drive yêu cầu tải tệp xuống hoặc thời điểm tải tệp xuống
thông qua ứng dụng đồng bộ hoá, Drive sẽ tạo tên tệp đầy đủ (với
tiện ích) dựa trên tiêu đề. Trong trường hợp thiếu tiện ích,
Drive cố gắng xác định đuôi tệp dựa trên
Loại MIME.
Lưu văn bản có thể lập chỉ mục
Drive tự động lập chỉ mục tài liệu để tìm kiếm khi
nhận dạng loại tệp, bao gồm tài liệu văn bản, PDF, hình ảnh có văn bản và
các loại phổ biến khác. Nếu ứng dụng của bạn lưu các loại tệp khác (chẳng hạn như bản vẽ,
và lối tắt), bạn có thể cải thiện khả năng được phát hiện bằng cách cung cấp
văn bản có thể lập chỉ mục trong trường contentHints.indexableText
của tệp.
Văn bản có thể lập chỉ mục được lập chỉ mục dưới dạng HTML. Nếu bạn lưu chuỗi văn bản có thể lập chỉ mục
<section attribute="value1">Here's some text</section>
, sau đó là "Sau đây là một số
văn bản" được lập chỉ mục, còn "value1" thì không. Do đó, việc lưu XML dưới dạng có thể lập chỉ mục
văn bản sẽ không hữu ích như lưu HTML.
Khi chỉ định indexableText
, bạn cũng cần lưu ý:
- Giới hạn kích thước đối với
contentHints.indexableText
là 128 KB. - Nắm bắt các từ khoá và khái niệm chính mà bạn muốn người dùng tìm kiếm.
- Đừng cố sắp xếp văn bản theo thứ tự mức độ quan trọng vì trình lập chỉ mục sẽ thực hiện việc này một cách hiệu quả cho bạn.
- Ứng dụng của bạn phải cập nhật văn bản có thể lập chỉ mục sau mỗi lần lưu.
- Đảm bảo văn bản có liên quan đến nội dung hoặc siêu dữ liệu của tệp.
Điểm cuối cùng này có vẻ hiển nhiên, nhưng rất quan trọng. Không nên thêm các cụm từ thường được tìm kiếm để buộc một tệp xuất hiện trong kết quả tìm kiếm. Chiến dịch này có thể gây khó chịu cho người dùng và thậm chí có thể thúc đẩy họ xóa tệp.
Tải hình thu nhỏ lên
Drive tự động tạo hình thu nhỏ cho nhiều tệp phổ biến chẳng hạn như Google Tài liệu, Trang tính và Trang trình bày. Hình thu nhỏ giúp người dùng xác định tệp trên Drive một cách dễ dàng hơn.
Đối với các loại tệp mà Drive không thể tạo hình thu nhỏ chuẩn
bạn có thể cung cấp một hình thu nhỏ do ứng dụng của bạn tạo ra. Trong
tạo tệp hoặc cập nhật tệp, tải hình thu nhỏ lên bằng cách đặt
Trường contentHints.thumbnail
trên tài nguyên files
.
Cụ thể:
- Đặt trường
contentHints.thumbnail.image
thành URL và tên tệp an toàn hình ảnh được mã hoá base64 (xem phần RFC 4648 5). - Đặt trường
contentHints.thumbnail.mimeType
thành loại MIME thích hợp cho hình thu nhỏ.
Nếu có thể tạo hình thu nhỏ từ tệp, Drive sẽ sử dụng được tạo tự động và bỏ qua mọi tệp mà bạn có thể đã tải lên. Nếu không thể tạo hình thu nhỏ, thì hình thu nhỏ sẽ sử dụng hình thu nhỏ mà bạn cung cấp.
Hình thu nhỏ phải tuân thủ các quy tắc sau:
- Có thể tải lên ở định dạng PNG, GIF hoặc JPG.
- Chiều rộng đề xuất là 1600 pixel.
- Chiều rộng tối thiểu là 220 pixel.
- Kích thước tệp tối đa là 2 MB.
- Các chỉ số này nên được ứng dụng của bạn cập nhật sau mỗi lần lưu.
Để biết thêm thông tin, hãy xem tài nguyên files
.
Truy xuất hình thu nhỏ
Bạn có thể truy xuất siêu dữ liệu, bao gồm cả hình thu nhỏ, cho tệp trên Drive.
Thông tin hình thu nhỏ nằm trong trường thumbnailLink
của
Tài nguyên files
.
Trả về một hình thu nhỏ cụ thể
Mã mẫu sau đây cho thấy
Yêu cầu phương thức files.get
bằng
nhiều trường dưới dạng tham số truy vấn để trả về siêu dữ liệu thumbnailLink
cho
một tệp cụ thể. Để biết thêm thông tin, hãy xem phần Trả về các trường cụ thể cho
tệp.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,mimeType,thumbnailLink
Thay thế FILE_ID bằng fileId
của tệp mà bạn muốn
tìm kiếm.
Yêu cầu sẽ trả về một URL ngắn hạn cho hình thu nhỏ của tệp (nếu có).
Thông thường, liên kết sẽ tồn tại trong vài giờ. Trường này chỉ được điền khi
ứng dụng yêu cầu có thể truy cập vào nội dung của tệp. Nếu tệp không được chia sẻ
công khai, URL được trả về trong thumbnailLink
phải được tìm nạp bằng cách sử dụng
yêu cầu được xác thực.
Trả về danh sách hình thu nhỏ
Mã mẫu sau đây cho thấy
Yêu cầu phương thức files.list
bằng
nhiều trường dưới dạng tham số truy vấn để trả về siêu dữ liệu thumbnailLink
cho
danh sách tệp. Để biết thêm thông tin, hãy xem phần Tìm kiếm tệp và
các thư mục.
GET https://www.googleapis.com/drive/v3/files/?fields=files(id,name,mimeType,thumbnailLink)
Để giới hạn kết quả tìm kiếm ở một loại tệp cụ thể, hãy áp dụng chuỗi truy vấn cho đặt loại MIME. Ví dụ: mã mẫu sau đây cho biết cách giới hạn vào tệp Google Trang tính. Để biết thêm thông tin về loại MIME, hãy xem MIME hỗ trợ Google Workspace và Google Drive .
GET https://www.googleapis.com/drive/v3/files/q=mimeType='application/vnd.google-apps.spreadsheet'&fields=files(id,name,mimeType,thumbnailLink)