Method: files.list

แสดงไฟล์ของผู้ใช้

เมธอดนี้จะยอมรับพารามิเตอร์ q ซึ่งเป็นคำค้นหาที่รวมข้อความค้นหาตั้งแต่ 1 ข้อความขึ้นไป สำหรับข้อมูลเพิ่มเติม โปรดดูที่ส่วนค้นหาไฟล์และ โฟลเดอร์

คำขอ HTTP

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

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

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

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

string

เนื้อความของรายการ (ไฟล์/เอกสาร) ที่ใช้การค้นหา เนื้อหาที่รองรับ ได้แก่ "user", "domain", "drive" และ "allDrives" เลือก "ผู้ใช้" หรือ "ไดรฟ์" ไปยัง "allDrives" เพื่อประสิทธิผล โดยค่าเริ่มต้น ระบบจะตั้งค่า Corpus เป็น "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: เวลาล่าสุดที่ผู้ใช้ดูไฟล์

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

pageSize

integer

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

pageToken

string

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

q

string

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

spaces

string

รายการเว้นวรรคที่คั่นด้วยคอมมาเพื่อค้นหาภายในคอร์ปัส ค่าที่รองรับคือ "drive" และ "appDataFolder"

supportsAllDrives

boolean

แอปพลิเคชันที่ส่งคำขอรองรับทั้งไดรฟ์ของฉันและไดรฟ์ที่แชร์หรือไม่

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

ระบุสิทธิ์ของมุมมองเพิ่มเติมที่จะรวมไว้ในคำตอบ เฉพาะ "เผยแพร่" เท่านั้น ได้

includeLabels

string

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

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

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

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

รายการไฟล์

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

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

string

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

kind

string

ระบุว่าทรัพยากรนี้เป็นประเภทใด ค่า: สตริงคงที่ "drive#fileList"

files[]

object (File)

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

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

ต้องใช้ขอบเขต 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 ไฟล์ที่แชร์ไปยังโดเมนของผู้ใช้