Method: files.list

แสดงรายการไฟล์ของผู้ใช้

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

คำขอ HTTP

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

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

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

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

string

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

คีย์แต่ละรายการจะจัดเรียงจากน้อยไปมากโดยค่าเริ่มต้น แต่สามารถกลับลำดับได้ด้วยตัวแก้ไข "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

ระบุสิทธิ์ของมุมมองเพิ่มเติมที่จะรวมไว้ในคำตอบ รองรับเฉพาะ "เผยแพร่แล้ว"
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 ไฟล์ที่แชร์ไปยังโดเมนของผู้ใช้