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 เพื่อประสิทธิภาพ โดยค่าเริ่มต้น ระบบจะตั้งค่าคลังข้อความเป็น user แต่ค่านี้อาจเปลี่ยนแปลงได้ขึ้นอยู่กับตัวกรองที่ตั้งค่าผ่านพารามิเตอร์ q ดูข้อมูลเพิ่มเติมได้ที่การจัดระเบียบไฟล์
corpus
(deprecated)

enum (Corpus)

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

string

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

boolean

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

boolean

เลิกใช้งานแล้ว: โปรดใช้ includeItemsFromAllDrives แทน
orderBy

string

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

  • createdTime: วันที่สร้างไฟล์
  • 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

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

string

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

string

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

string

รายการพื้นที่ที่คั่นด้วยคอมมาเพื่อค้นหาภายในคลังข้อความ ค่าที่รองรับคือ 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 ไฟล์ที่แชร์ไปยังโดเมนของผู้ใช้