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

รายการคีย์จัดเรียงที่คั่นด้วยคอมมา คีย์ที่ถูกต้องคือ "createdTime", "folder", "modifiedByMeTime", "modifiedTime", "name", "name_natural", "quotaBytesUsed", "recency", "sharedWithMeTime", "starred" และ "viewedByMeTime" แต่ละคีย์จะจัดเรียงจากน้อยไปมากโดยค่าเริ่มต้น แต่สามารถย้อนกลับได้ด้วยแป้นกดร่วม "มากไปน้อย" ตัวอย่างการใช้: ?orderBy=โฟลเดอร์,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 ไฟล์ที่แชร์กับโดเมนของผู้ใช้