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

enum (Corpus)

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

string

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

boolean

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

boolean

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

string

รายการคีย์จัดเรียงที่คั่นด้วยคอมมา คีย์ที่ถูกต้อง ได้แก่ "generateTime", "โฟลเดอร์", "modifiedByMeTime", "modifiedTime", "name", "name_natural", "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.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 ไฟล์ที่แชร์กับโดเมนของผู้ใช้