Method: files.list

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

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

คำขอ HTTP

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

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

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

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

string

เนื้อหาของรายการ (ไฟล์/เอกสาร) ที่ใช้การค้นหา เอนทิตีที่รองรับคือ default, domain, drive และ allDrives แนะนำให้ใช้ default หรือ drive กับ allDrives เพื่อประสิทธิภาพ

corpus
(deprecated)

enum (Corpus)

เลิกใช้งานแล้ว: ส่วนเนื้อหาของรายการ (ไฟล์/เอกสาร) ที่ใช้การค้นหา โปรดใช้ corpora แทน

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

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

maxResults

integer

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

orderBy

string

รายการคีย์จัดเรียงที่คั่นด้วยคอมมา คีย์ที่ถูกต้องคือ createdDate, folder, lastViewedByMeDate, modifiedByMeDate, modifiedDate, quotaBytesUsed, recency, sharedWithMeDate, starred, title และ title_natural แต่ละคีย์จะจัดเรียงจากน้อยไปมากโดยค่าเริ่มต้น แต่อาจกลับค่ากันได้เมื่อใช้ตัวแก้ไข desc ตัวอย่างการใช้งาน: ?orderBy=folder,modifiedDate desc,title โปรดทราบว่าปัจจุบันมีข้อจำกัดสำหรับผู้ใช้ที่มีไฟล์ประมาณ 1 ล้านไฟล์ ซึ่งระบบไม่สนใจลำดับการจัดเรียงที่ขอ

pageToken

string

โทเค็นหน้าสำหรับไฟล์

projection
(deprecated)

enum (Projection)

เลิกใช้งานแล้ว: พารามิเตอร์นี้ไม่มีฟังก์ชัน

q

string

สตริงการค้นหาสําหรับการค้นหาไฟล์

spaces

string

รายการพื้นที่ทำงานที่จะค้นหาซึ่งคั่นด้วยคอมมา ค่าที่รองรับคือ drive และ appDataFolder

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

ระบุสิทธิ์ของข้อมูลพร็อพเพอร์ตี้เพิ่มเติมที่จะรวมไว้ในการตอบกลับ รองรับ published เท่านั้น

includeLabels

string

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

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

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

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

รายการไฟล์

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

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

string

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

kind

string

นี่คือ drive#fileList เสมอ

etag

string

ETag ของรายการ

items[]

object (File)

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

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

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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
DEFAULT รายการที่ผู้ใช้เข้าถึง
DOMAIN รายการที่แชร์กับโดเมนของผู้ใช้