เอกสารนี้ครอบคลุมข้อควรพิจารณาที่สำคัญในการตั้งชื่อไฟล์และการทำงานกับข้อมูลเมตา เช่น ข้อความและภาพขนาดย่อที่จัดทำดัชนีได้ หากต้องการแทรกและเรียกข้อมูลไฟล์ โปรดดูแหล่งข้อมูล files
ระบุชื่อไฟล์และนามสกุลไฟล์
แอปควรระบุนามสกุลไฟล์ในพร็อพเพอร์ตี้ชื่อเมื่อแทรกไฟล์ด้วย API ของ Google ไดรฟ์ เช่น การดำเนินการเพื่อแทรกไฟล์ 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 4648 ของ RFC) - ตั้งค่าช่อง
contentHints.thumbnail.mimeTypeเป็นประเภท MIME ที่เหมาะสมสำหรับภาพขนาดย่อ
หากไดรฟ์สร้างภาพขนาดย่อจากไฟล์ได้ ไดรฟ์จะใช้ภาพปกที่สร้างขึ้นโดยอัตโนมัติและละเว้นรูปภาพที่คุณอัปโหลด หากสร้างภาพขนาดย่อไม่ได้ ก็จะใช้ภาพที่คุณให้ไว้
ภาพปกต้องเป็นไปตามกฎต่อไปนี้
- อัปโหลดได้ในรูปแบบ PNG, GIF หรือ JPG
- ความกว้างที่แนะนำคือ 1600 พิกเซล
- ความกว้างต่ำสุดคือ 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 ได้ที่ Google Workspace และ Google ไดรฟ์ประเภท MIME ที่รองรับ
GET https://www.googleapis.com/drive/v3/files/q=mimeType='application/vnd.google-apps.spreadsheet'&fields=files(id,name,mimeType,thumbnailLink)