Method: files.list

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

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์ gRPC Transcoding

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

พารามิเตอร์
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 และ title_natural คีย์แต่ละคีย์จัดเรียงจากน้อยไปหามากโดยค่าเริ่มต้น แต่อาจย้อนกลับด้วยคีย์ตัวปรับแต่ง desc ตัวอย่างการใช้: ?orderBy=folder,modifiedDate desc,title โปรดทราบว่าปัจจุบันมีข้อจํากัดสําหรับผู้ใช้ซึ่งมีไฟล์ประมาณหนึ่งล้านไฟล์ที่ถูกละเว้นตามลําดับการจัดเรียงที่ระบุ
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)

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

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

ต้องการขอบเขต 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.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 รายการที่แชร์กับโดเมนของผู้ใช้