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