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

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

string

รายการคีย์การจัดเรียงที่คั่นด้วยคอมมา คีย์ที่ใช้ได้มีดังนี้

  • createdDate: วันที่สร้างไฟล์
  • folder: รหัสโฟลเดอร์ ช่องนี้จัดเรียงตามลําดับตัวอักษร
  • lastViewedByMeDate: เวลาล่าสุดที่ผู้ใช้ดูไฟล์
  • modifiedByMeDate: เวลาล่าสุดที่ผู้ใช้แก้ไขไฟล์
  • modifiedDate: ครั้งล่าสุดที่มีผู้แก้ไขไฟล์
  • quotaBytesUsed: จำนวนโควต้าพื้นที่เก็บข้อมูลที่ใช้ในหน่วยไบต์ของไฟล์
  • recency: การประทับเวลาล่าสุดจากช่องวันที่และเวลาของไฟล์
  • sharedWithMeDate: วันที่แชร์ไฟล์กับผู้ใช้ หากมี
  • starred: ผู้ใช้ติดดาวไฟล์หรือไม่
  • title: ชื่อไฟล์ ช่องนี้จัดเรียงตามลําดับตัวอักษร เช่น 1, 12, 2, 22
  • title_natural: ชื่อไฟล์ ช่องนี้จัดเรียงโดยใช้การจัดเรียงตามลำดับตามธรรมชาติ เช่น 1, 2, 12, 22

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