- คำขอ HTTP
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- คอร์ปัส
- ลองใช้งาน
แสดงไฟล์ของผู้ใช้
เมธอดนี้จะยอมรับพารามิเตอร์ q
ซึ่งเป็นคําค้นหาที่รวมข้อความค้นหาอย่างน้อย 1 รายการ โปรดดูข้อมูลเพิ่มเติมที่คู่มือค้นหาไฟล์และโฟลเดอร์
คำขอ HTTP
GET https://www.googleapis.com/drive/v3/files
URL ใช้ไวยากรณ์ gRPC Transcoding
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
corpora |
เนื้อหาของรายการ (ไฟล์/เอกสาร) ที่การค้นหามีผล ส่วนเนื้อหาที่รองรับได้แก่ "ผู้ใช้" "โดเมน" "ไดรฟ์" และ "ไดรฟ์ทั้งหมด" ควรใช้ "ผู้ใช้" หรือ "ไดรฟ์" กับ "allDrives" เพื่อประสิทธิภาพ โดยค่าเริ่มต้น คลังข้อมูลจะตั้งค่าเป็น "ผู้ใช้" อย่างไรก็ตาม ค่านี้อาจเปลี่ยนแปลงได้ตามตัวกรองที่ตั้งค่าผ่านพารามิเตอร์ "q" |
corpus |
เลิกใช้งานแล้ว: แหล่งที่มาของไฟล์ที่จะแสดงรายการ ใช้ "corpora" แทน |
driveId |
รหัสของไดรฟ์ที่แชร์ที่จะค้นหา |
includeItemsFromAllDrives |
ระบุว่าทั้งรายการไดรฟ์ของฉันและไดรฟ์ที่แชร์ควรรวมอยู่ในผลลัพธ์หรือไม่ |
includeTeamDriveItems |
เลิกใช้งานแล้ว: ใช้ |
orderBy |
รายการคีย์จัดเรียงที่คั่นด้วยจุลภาค คีย์ที่ถูกต้องคือ "generateTime", "โฟลเดอร์", "modifiedByMeTime", "modifiedTime", "name", "name_natural", "quotaBytesUsed", "recency", "sharedWithMeTime", "starred" และ "viewedByMeTime" แต่ละคีย์จัดเรียงจากน้อยไปมากโดยค่าเริ่มต้น แต่สามารถเปลี่ยนกลับได้ด้วยตัวปรับแต่ง "คําอธิบาย" ตัวอย่างการใช้: ?orderBy=folder,modifiedTime desc,name |
pageSize |
จํานวนไฟล์สูงสุดที่จะส่งคืนได้ในหนึ่งหน้า สามารถดูหน้าผลการค้นหาบางส่วนหรือหน้าว่างก่อนที่จะถึงช่วงท้ายของรายการไฟล์ |
pageToken |
โทเค็นสําหรับดําเนินการกับคําขอรายการก่อนหน้าในหน้าถัดไป ควรกําหนดค่าของ "nextPageToken" จากการตอบกลับก่อนหน้านี้ |
q |
คําค้นหาสําหรับกรองผลลัพธ์ไฟล์ โปรดดูคู่มือ "ค้นหาไฟล์และโฟลเดอร์" สําหรับไวยากรณ์ที่สนับสนุน |
spaces |
รายการพื้นที่ทํางานสําหรับคําค้นหาภายในจุลภาค ได้แก่ ค่าที่รองรับคือ "drive" และ "appDataFolder" |
supportsAllDrives |
แอปพลิเคชันที่ขอรองรับทั้งไดรฟ์ของฉันและไดรฟ์ที่แชร์หรือไม่ |
supportsTeamDrives |
เลิกใช้งานแล้ว: ใช้ |
teamDriveId |
เลิกใช้งานแล้ว: ใช้ |
includePermissionsForView |
ระบุสิทธิ์การดูเพิ่มเติมที่จะรวมไว้ในคําตอบ รองรับเฉพาะ "เผยแพร่" เท่านั้น |
includeLabels |
รายการรหัสของป้ายกํากับที่คั่นด้วยจุลภาคที่จะรวมในส่วน |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
รายการไฟล์
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
ช่อง | |
---|---|
nextPageToken |
โทเค็นหน้าเว็บสําหรับไฟล์ถัดไป ข้อมูลนี้จะหายไปหากมาถึงรายการสุดท้ายของไฟล์แล้ว หากโทเค็นถูกปฏิเสธไม่ว่าด้วยเหตุผลใด ควรทิ้งโทเค็น และควรมีการใส่เลขหน้าใหม่จากผลการค้นหาหน้าแรก โดยทั่วไปโทเค็นของหน้าจะใช้ได้เป็นเวลาหลายชั่วโมง อย่างไรก็ตาม หากมีการเพิ่มหรือนํารายการใหม่ออก ผลลัพธ์ที่คาดไว้อาจต่างออกไป |
kind |
ระบุประเภทของทรัพยากรนี้ ค่า: สตริงคงที่ |
incompleteSearch |
กระบวนการค้นหาไม่สมบูรณ์หรือไม่ หากจริง ผลการค้นหาบางรายการอาจหายไป เนื่องจากไม่ได้ค้นหาเอกสารทั้งหมด เหตุการณ์นี้อาจเกิดขึ้นได้เมื่อค้นหาไดรฟ์หลายไดรฟ์ที่มีคลัง "allDrives" แต่ระบบค้นหาคลังเนื้อหาทั้งหมดไม่ได้ เมื่อเกิดเหตุการณ์นี้ขึ้น ลูกค้าควรจํากัดข้อความค้นหาให้แคบลงโดยเลือกคลังข้อมูลอื่น เช่น 'ผู้ใช้' หรือ 'ไดรฟ์' |
files[] |
รายการไฟล์ หากเติมข้อมูล pagePageToken แล้ว รายการนี้อาจไม่สมบูรณ์และจะดึงหน้าผลการค้นหาเพิ่มเติม |
ขอบเขตการให้สิทธิ์
ต้องการขอบเขต 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 |
ไฟล์ที่แชร์กับโดเมนของผู้ใช้ |