เอกสารนี้ครอบคลุมถึงข้อควรพิจารณาที่สำคัญสำหรับการตั้งชื่อไฟล์และการทำงานกับข้อมูลเมตา เช่น ข้อความและภาพขนาดย่อที่จัดทำดัชนีได้ หากต้องการแทรกและเรียกข้อมูลไฟล์ โปรดดูทรัพยากร files
ระบุชื่อและนามสกุลไฟล์
แอปควรระบุนามสกุลไฟล์ในพร็อพเพอร์ตี้ชื่อเมื่อแทรกไฟล์ด้วย Google Drive API เช่น การดำเนินการเพื่อแทรกไฟล์ JPEG ควรระบุข้อมูลอย่างเช่น "name": "cat.jpg" ในข้อมูลเมตา
การตอบกลับ GET ที่ตามมาอาจมีพร็อพเพอร์ตี้ fileExtension แบบอ่านอย่างเดียวซึ่งสร้างขึ้นด้วยส่วนขยายที่ระบุไว้ในพร็อพเพอร์ตี้ name เดิม เมื่อผู้ใช้ Google ไดรฟ์ส่งคำขอดาวน์โหลดไฟล์ หรือเมื่อมีการดาวน์โหลดไฟล์ผ่านไคลเอ็นต์การซิงค์ ไดรฟ์จะสร้างชื่อไฟล์แบบเต็ม (พร้อมนามสกุล) โดยอิงตามชื่อ ในกรณีที่ไม่มีนามสกุลอยู่ ทางไดรฟ์จะพยายามระบุนามสกุลตามประเภท MIME ของไฟล์
บันทึกข้อความที่จัดทําดัชนีได้
ไดรฟ์จะจัดทำดัชนีเอกสารสำหรับการค้นหาโดยอัตโนมัติเมื่อตรวจพบประเภทไฟล์ ได้แก่ เอกสารข้อความ, PDF, รูปภาพที่มีข้อความ และประเภททั่วไปอื่นๆ หากแอปบันทึกไฟล์ประเภทอื่นๆ (เช่น ภาพวาด วิดีโอ และทางลัด) คุณสามารถปรับปรุงการค้นพบได้โดยระบุข้อความที่จัดทําดัชนีได้ในช่อง contentHints.indexableText ของไฟล์
ระบบจะจัดทําดัชนีข้อความที่จัดทําดัชนีได้ในรูปแบบ HTML หากคุณบันทึกสตริงข้อความที่จัดทําดัชนีได้ <section attribute="value1">Here's some text</section> ระบบจะจัดทําดัชนี "นี่คือตัวอย่างข้อความ" แต่จะไม่จัดทําดัชนี "value1" ด้วยเหตุนี้ การบันทึก XML เป็นข้อความที่จัดทำดัชนีได้จึงไม่มีประโยชน์เท่าการบันทึก HTML
เมื่อระบุ indexableText โปรดคำนึงถึงสิ่งต่อไปนี้ด้วย
contentHints.indexableTextต้องมีขนาดไม่เกิน 128 KB- ระบุคําและแนวคิดหลักที่คุณคาดว่าผู้ใช้จะค้นหา
- อย่าพยายามจัดเรียงข้อความตามลําดับความสําคัญ เนื่องจากเครื่องมือจัดทำดัชนีจะจัดเรียงให้คุณอย่างมีประสิทธิภาพ
- แอปพลิเคชันควรอัปเดตข้อความที่จัดทําดัชนีได้ทุกครั้งที่มีการบันทึก
- ตรวจสอบว่าข้อความเกี่ยวข้องกับเนื้อหาหรือข้อมูลเมตาของไฟล์
ประเด็นสุดท้ายนี้อาจดูชัดเจนอยู่แล้ว แต่สำคัญมาก คุณไม่ควรเพิ่มข้อความค้นหาที่พบบ่อยเพื่อบังคับให้ไฟล์ปรากฏในผลการค้นหา ซึ่งอาจทำให้ผู้ใช้ไม่พอใจและอาจทำให้ผู้ใช้ลบไฟล์ด้วย
อัปโหลดภาพปก
ไดรฟ์จะสร้างภาพขนาดย่อโดยอัตโนมัติสำหรับไฟล์ประเภทต่างๆ ทั่วไป เช่น Google เอกสาร, ชีต และสไลด์ ภาพปกช่วยให้ผู้ใช้ระบุไฟล์ในไดรฟ์ได้ดียิ่งขึ้น
สำหรับประเภทไฟล์ที่ไดรฟ์ไม่สามารถสร้างภาพขนาดย่อมาตรฐานได้ คุณสามารถระบุภาพขนาดย่อที่แอปพลิเคชันสร้างขึ้นได้ ในระหว่างการสร้างหรืออัปเดตไฟล์ ให้อัปโหลดภาพขนาดย่อโดยตั้งค่าช่อง contentHints.thumbnail ในทรัพยากร files
กล่าวอย่างเจาะจงคือ
- ตั้งค่าช่อง
contentHints.thumbnail.imageเป็น URL และชื่อไฟล์ที่ปลอดภัยซึ่งเข้ารหัส Base64 (ดูส่วน 5 ของ RFC 4648) - ตั้งค่าช่อง
contentHints.thumbnail.mimeTypeเป็นประเภท MIME ที่เหมาะสมสำหรับภาพขนาดย่อ
หากไดรฟ์สร้างภาพขนาดย่อจากไฟล์ได้ ก็จะใช้ภาพขนาดย่อที่สร้างขึ้นโดยอัตโนมัติและจะไม่สนใจภาพขนาดย่อที่คุณอาจอัปโหลด หากสร้างภาพปกไม่ได้ ระบบจะใช้ภาพปกที่คุณให้ไว้
ภาพปกต้องเป็นไปตามกฎต่อไปนี้
- อัปโหลดได้ในรูปแบบ PNG, GIF หรือ JPG
- ความกว้างที่แนะนำคือ 1,600 พิกเซล
- ความกว้างต่ำสุดคือ 220 พิกเซล
- ขนาดไฟล์สูงสุดคือ 2 MB
- แอปพลิเคชันควรอัปเดตข้อมูลดังกล่าวทุกครั้งที่บันทึก
ดูข้อมูลเพิ่มเติมได้ที่แหล่งข้อมูล files
ดึงข้อมูลภาพขนาดย่อ
คุณสามารถเรียกข้อมูลเมตา รวมถึงภาพขนาดย่อของไฟล์ในไดรฟ์ได้
ข้อมูลภาพปกจะอยู่ในช่อง thumbnailLink ของทรัพยากร files
แสดงภาพขนาดย่อเฉพาะ
ตัวอย่างโค้ดต่อไปนี้แสดงคำขอเมธอด files.get ที่มีช่องหลายช่องเป็นพารามิเตอร์การค้นหาเพื่อแสดงข้อมูลเมตา thumbnailLink สำหรับไฟล์ที่เฉพาะเจาะจง ดูข้อมูลเพิ่มเติมได้ที่แสดงฟิลด์ที่เฉพาะเจาะจงสำหรับไฟล์
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,mimeType,thumbnailLink
แทนที่ FILE_ID ด้วย fileId ของไฟล์ที่ต้องการค้นหา
คำขอจะแสดง URL ที่มีอายุสั้นไปยังภาพปกของไฟล์ (หากมี)
โดยทั่วไปแล้ว ลิงก์จะใช้งานได้หลายชั่วโมง ระบบจะใส่ข้อมูลในช่องนี้ต่อเมื่อแอปที่ส่งคำขอเข้าถึงเนื้อหาของไฟล์ได้ หากไฟล์ไม่ได้แชร์แบบสาธารณะ จะต้องดึงข้อมูล URL ที่แสดงใน thumbnailLink โดยใช้คำขอที่มีข้อมูลเข้าสู่ระบบ
แสดงรายการภาพปก
ตัวอย่างโค้ดต่อไปนี้แสดงคําขอเมธอด files.list ที่มีช่องหลายช่องเป็นพารามิเตอร์การค้นหาเพื่อแสดงข้อมูลเมตา thumbnailLink สําหรับรายการไฟล์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อค้นหาไฟล์และโฟลเดอร์
GET https://www.googleapis.com/drive/v3/files/?fields=files(id,name,mimeType,thumbnailLink)
หากต้องการจำกัดผลการค้นหาให้เป็นไฟล์บางประเภทเท่านั้น ให้ใช้สตริงการค้นหาเพื่อตั้งค่าประเภท MIME ตัวอย่างเช่น ตัวอย่างโค้ดต่อไปนี้แสดงวิธีจำกัดรายการให้แสดงเฉพาะไฟล์ Google ชีต ดูข้อมูลเพิ่มเติมเกี่ยวกับประเภท MIME ได้ที่ ประเภท MIME ที่ Google Workspace และ Google ไดรฟ์รองรับ
GET https://www.googleapis.com/drive/v3/files/q=mimeType='application/vnd.google-apps.spreadsheet'&fields=files(id,name,mimeType,thumbnailLink)