Method: files.list

แสดงรายการไฟล์ของผู้ใช้ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อค้นหาไฟล์และโฟลเดอร์

เมธอดนี้ยอมรับพารามิเตอร์ q ซึ่งเป็นคําค้นหาที่รวมข้อความค้นหาอย่างน้อย 1 รายการ

โดยค่าเริ่มต้น เมธอดนี้จะแสดงไฟล์ ทั้งหมด รวมถึงไฟล์ที่อยู่ในถังขยะ หากไม่ต้องการให้ไฟล์ที่อยู่ในถังขยะปรากฏในรายการ ให้ใช้พารามิเตอร์การค้นหา trashed=false เพื่อนำไฟล์ที่อยู่ในถังขยะออกจากผลการค้นหา

คำขอ HTTP

GET https://www.googleapis.com/drive/v3/files

URL ใช้ ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
corpora

string

ระบุคอลเล็กชันของรายการ (ไฟล์หรือเอกสาร) ที่คําค้นหามีผล รายการที่รองรับ ได้แก่

  • user
  • domain
  • drive
  • allDrives

ควรใช้ user หรือ drive แทน allDrives เพื่อประสิทธิภาพ โดยค่าเริ่มต้น ระบบจะตั้งค่า corpora เป็น user อย่างไรก็ตาม ค่านี้อาจเปลี่ยนแปลงไปตามตัวกรองที่ตั้งค่าผ่านพารามิเตอร์ q ดูข้อมูลเพิ่มเติมได้ที่หัวข้อ การจัดระเบียบไฟล์
corpus
(deprecated)

enum (Corpus)

เลิกใช้งานแล้ว: แหล่งที่มาของไฟล์ที่จะแสดง ให้ใช้ corpora แทน
driveId

string

รหัสของไดรฟ์ที่แชร์ที่จะค้นหา
includeItemsFromAllDrives

boolean

ระบุว่าจะรวมทั้งรายการในไดรฟ์ของฉันและไดรฟ์ที่แชร์ไว้ในผลการค้นหาหรือไม่
includeTeamDriveItems
(deprecated)

boolean

เลิกใช้งานแล้ว: ให้ใช้ includeItemsFromAllDrives แทน
orderBy

string

รายการคีย์การจัดเรียงที่คั่นด้วยคอมมา คีย์ที่ใช้ได้มีดังนี้

  • createdTime: เวลาที่สร้างไฟล์ หลีกเลี่ยงการใช้คีย์นี้สําหรับคําค้นหาในคอลเล็กชันรายการขนาดใหญ่ เนื่องจากอาจทําให้เกิดการหมดเวลาหรือปัญหาอื่นๆ สําหรับการจัดเรียงที่เกี่ยวข้องกับเวลาในคอลเล็กชันรายการขนาดใหญ่ ให้ใช้ modifiedTime desc แทน
  • folder: รหัสโฟลเดอร์ ช่องนี้จะจัดเรียงตามลําดับตัวอักษร
  • modifiedByMeTime: เวลาล่าสุดที่ผู้ใช้แก้ไขไฟล์
  • modifiedTime: เวลาล่าสุดที่มีผู้แก้ไขไฟล์
  • name: ชื่อไฟล์ ช่องนี้จะจัดเรียงตามลําดับตัวอักษร เช่น 1, 12, 2, 22
  • name_natural: ชื่อไฟล์ ช่องนี้จะจัดเรียงตามลําดับการจัดเรียงตามธรรมชาติ เช่น 1, 2, 12, 22
  • quotaBytesUsed: จํานวนโควต้าพื้นที่เก็บข้อมูลที่ใช้ในหน่วยไบต์ของไฟล์
  • recency: การประทับเวลาล่าสุดจากช่องวันที่และเวลาของไฟล์
  • sharedWithMeTime: เวลาที่แชร์ไฟล์กับผู้ใช้ (หากมี)
  • starred: ระบุว่าผู้ใช้ติดดาวไฟล์หรือไม่
  • viewedByMeTime: เวลาล่าสุดที่ผู้ใช้ดูไฟล์

แต่ละคีย์จะจัดเรียงจากน้อยไปมากโดยค่าเริ่มต้น แต่สามารถเปลี่ยนเป็นจากมากไปน้อยได้ด้วยตัวแก้ไข desc ตัวอย่างการใช้งาน: ?orderBy=folder,modifiedTime desc,name
pageSize

integer

จํานวนไฟล์สูงสุดที่จะแสดงต่อหน้า หน้าอาจมีข้อมูลบางส่วนหรือไม่มีข้อมูลเลยแม้ว่าจะยังไม่ถึงจุดสิ้นสุดของรายการไฟล์

หากไม่ได้ระบุ ระบบจะแสดงไฟล์สูงสุด 100 ไฟล์สําหรับไดรฟ์ที่แชร์ และแสดงรายการไฟล์ทั้งหมดสําหรับไดรฟ์ที่ไม่แชร์

ค่าสูงสุดคือ 100 หากค่าที่ระบุมากกว่า 100 ระบบจะเปลี่ยนเป็น 100
pageToken

string

โทเค็นสําหรับดําเนินการต่อจากคําขอรายการก่อนหน้าในหน้าถัดไป ควรตั้งค่านี้เป็นค่าของ nextPageToken จากการตอบกลับก่อนหน้า
q

string

คําค้นหาสําหรับกรองผลการค้นหาไฟล์ ดูไวยากรณ์ที่รองรับได้ที่หัวข้อค้นหาไฟล์และโฟลเดอร์
spaces

string

รายการพื้นที่ที่จะค้นหาภายใน corpora ที่คั่นด้วยคอมมา ค่าที่รองรับคือ drive และ appDataFolder ดูข้อมูลเพิ่มเติมได้ที่หัวข้อ การจัดระเบียบไฟล์
supportsAllDrives

boolean

ระบุว่าแอปพลิเคชันที่ส่งคําร้องขอรองรับทั้งไดรฟ์ของฉันและไดรฟ์ที่แชร์หรือไม่
supportsTeamDrives
(deprecated)

boolean

เลิกใช้งานแล้ว: ให้ใช้ supportsAllDrives แทน
teamDriveId
(deprecated)

string

เลิกใช้งานแล้ว: ให้ใช้ driveId แทน
includePermissionsForView

string

ระบุสิทธิ์ของมุมมองเพิ่มเติมที่จะรวมไว้ในการตอบกลับ รองรับเฉพาะ published
includeLabels

string

รายการรหัสของป้ายกํากับที่จะรวมไว้ในส่วน labelInfo ของการตอบกลับที่คั่นด้วยคอมมา

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

รายการไฟล์

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
ช่อง
files[]

object (File)

รายการไฟล์ หากมีการป้อนข้อมูลใน nextPageToken แสดงว่ารายการนี้อาจไม่สมบูรณ์และควรดึงข้อมูลหน้าผลการค้นหาเพิ่มเติม
nextPageToken

string

โทเค็นหน้าสําหรับไฟล์หน้าถัดไป โทเค็นนี้จะไม่ปรากฏหากถึงจุดสิ้นสุดของรายการไฟล์แล้ว หากระบบปฏิเสธโทเค็นไม่ว่าด้วยเหตุผลใดก็ตาม คุณควรทิ้งโทเค็นนั้นและเริ่มการแบ่งหน้าใหม่จากหน้าแรกของผลการค้นหา โดยปกติแล้วโทเค็นหน้าจะมีอายุการใช้งานหลายชั่วโมง อย่างไรก็ตาม หากมีการเพิ่มหรือนํารายการใหม่ออก ผลการค้นหาที่คาดไว้ก็อาจแตกต่างออกไป
kind

string

ระบุประเภทของทรัพยากร ค่า: สตริงคงที่ "drive#fileList"

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

ขอบเขตบางรายการถูกจํากัดและต้องมีการประเมินความปลอดภัยเพื่อให้แอปของคุณใช้งานได้ ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

Corpus

Enum
user ไฟล์ที่ผู้ใช้เป็นเจ้าของหรือที่แชร์กับผู้ใช้
domain ไฟล์ที่แชร์กับโดเมนของผู้ใช้