Method: files.list

उपयोगकर्ता की फ़ाइलों की सूची दिखाता है.

यह तरीका, q पैरामीटर को स्वीकार करता है. यह एक खोज क्वेरी है, जिसमें खोज के लिए इस्तेमाल हुए एक या उससे ज़्यादा शब्द शामिल होते हैं. ज़्यादा जानकारी के लिए, फ़ाइलें और फ़ोल्डर खोजना गाइड देखें.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
corpora

string

क्वेरी से जुड़ी फ़ाइलें/दस्तावेज़. 'user', 'domain', 'drive', और 'allDrives' के लिए, इस सुविधा का इस्तेमाल किया जा सकता है. बेहतर परफ़ॉर्मेंस के लिए, 'allDrives' के बजाय 'user' या 'drive' का इस्तेमाल करें. डिफ़ॉल्ट रूप से, कॉर्पस को 'user' पर सेट किया जाता है. हालांकि, 'q' पैरामीटर के ज़रिए सेट किए गए फ़िल्टर के हिसाब से, यह बदल सकता है.
corpus
(deprecated)

enum (Corpus)

अब इस्तेमाल नहीं किया जा सकता: सूची में शामिल करने के लिए फ़ाइलों का सोर्स. इसके बजाय, 'corpora' का इस्तेमाल करें.
driveId

string

खोज के लिए शेयर की गई ड्राइव का आईडी.
includeItemsFromAllDrives

boolean

नतीजों में, 'मेरी ड्राइव' और शेयर की गई ड्राइव, दोनों के आइटम शामिल होने चाहिए या नहीं.
includeTeamDriveItems
(deprecated)

boolean

इस्तेमाल बंद कर दिया गया है: इसके बजाय, includeItemsFromAllDrives का इस्तेमाल करें.
orderBy

string

सॉर्ट करने के लिए इस्तेमाल की जाने वाली कुंजियों की कॉमा लगाकर अलग की गई सूची. मान्य कुंजियां ये हैं:

  • createdTime: फ़ाइल कब बनाई गई थी.
  • folder: फ़ोल्डर का आईडी. इस फ़ील्ड को वर्णमाला के क्रम में लगाया जाता है.
  • modifiedByMeTime: उपयोगकर्ता ने फ़ाइल में आखिरी बार कब बदलाव किया था.
  • modifiedTime: फ़ाइल में पिछली बार किसी व्यक्ति ने कब बदलाव किया था.
  • name: फ़ाइल का नाम. इस फ़ील्ड को वर्णमाला के क्रम में लगाया गया है. इसलिए, 1, 12, 2, 22.
  • name_natural: फ़ाइल का नाम. इस फ़ील्ड को नैचुरल सॉर्ट ऑर्डरिंग का इस्तेमाल करके क्रम से लगाया जाता है. इसलिए, 1, 2, 12, 22.
  • quotaBytesUsed: फ़ाइल के लिए इस्तेमाल किए गए स्टोरेज कोटा बाइट की संख्या.
  • recency: फ़ाइल के तारीख और समय वाले फ़ील्ड का सबसे नया टाइमस्टैंप.
  • sharedWithMeTime: अगर लागू हो, तो यह जानकारी कि फ़ाइल को उपयोगकर्ता के साथ कब शेयर किया गया था.
  • starred: इससे पता चलता है कि उपयोगकर्ता ने फ़ाइल को स्टार किया है या नहीं.
  • viewedByMeTime: उपयोगकर्ता ने पिछली बार फ़ाइल कब देखी थी.

डिफ़ॉल्ट रूप से, हर कुंजी को बढ़ते क्रम में लगाया जाता है. हालांकि, 'desc' मॉडिफ़ायर का इस्तेमाल करके, इसे उलट-पलट किया जा सकता है. इस्तेमाल का उदाहरण: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

हर पेज पर ज़्यादा से ज़्यादा कितनी फ़ाइलें दिखानी हैं. फ़ाइलों की सूची के खत्म होने से पहले भी, नतीजे वाले पेज पर कुछ नतीजे दिख सकते हैं या कोई नतीजा नहीं दिख सकता.
pageToken

string

यह टोकन, अगले पेज पर पिछली सूची के अनुरोध को जारी रखने के लिए होता है. इसे पिछले जवाब के 'nextPageToken' की वैल्यू पर सेट किया जाना चाहिए.
q

string

फ़ाइल के नतीजों को फ़िल्टर करने के लिए क्वेरी. इस्तेमाल किए जा सकने वाले सिंटैक्स के बारे में जानने के लिए, "फ़ाइलें और फ़ोल्डर ढूंढना" गाइड देखें.
spaces

string

कॉर्पस में क्वेरी करने के लिए, कॉमा लगाकर अलग किए गए स्पेस की सूची. 'drive' और 'appDataFolder' को वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
supportsAllDrives

boolean

अनुरोध करने वाला ऐप्लिकेशन, 'मेरी ड्राइव' और शेयर की गई ड्राइव, दोनों के साथ काम करता है या नहीं.
supportsTeamDrives
(deprecated)

boolean

इस्तेमाल बंद कर दिया गया है: इसके बजाय, supportsAllDrives का इस्तेमाल करें.
teamDriveId
(deprecated)

string

इस्तेमाल बंद कर दिया गया है: इसके बजाय, driveId का इस्तेमाल करें.
includePermissionsForView

string

इससे यह तय होता है कि जवाब में किस अतिरिक्त व्यू की अनुमतियां शामिल करनी हैं. सिर्फ़ 'published' का इस्तेमाल किया जा सकता है.
includeLabels

string

labelInfo के तौर पर जवाब में शामिल किए जाने वाले लेबल के आईडी की कॉमा लगाकर अलग की गई सूची.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

फ़ाइलों की सूची.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
फ़ील्ड
files[]

object (File)

फ़ाइलों की सूची. अगर nextPageToken भरा गया है, तो हो सकता है कि यह सूची पूरी न हो. ऐसे में, नतीजों का एक और पेज फ़ेच किया जाना चाहिए.
nextPageToken

string

फ़ाइलों के अगले पेज के लिए पेज टोकन. अगर फ़ाइलों की सूची खत्म हो गई है, तो यह मौजूद नहीं होगा. अगर किसी वजह से टोकन अस्वीकार कर दिया जाता है, तो उसे खारिज कर देना चाहिए. साथ ही, पेज नंबर के हिसाब से नतीजे दिखाने की सुविधा को, नतीजों के पहले पेज से फिर से शुरू करना चाहिए. पेज टोकन आम तौर पर कई घंटों तक मान्य होता है. हालांकि, नए आइटम जोड़ने या हटाने पर, आपको मिलने वाले नतीजे अलग-अलग हो सकते हैं.
kind

string

इससे पता चलता है कि यह किस तरह का संसाधन है. वैल्यू: तय की गई स्ट्रिंग "drive#fileList".

अनुमति के स्कोप

इसके लिए, इनमें से किसी एक 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

कुछ स्कोप पर पाबंदी है. इसलिए, आपके ऐप्लिकेशन को इनका इस्तेमाल करने से पहले सुरक्षा का आकलन करना होगा. ज़्यादा जानकारी के लिए, अनुमति पाने से जुड़ी गाइड देखें.

कॉर्पस

Enums
user ऐसी फ़ाइलें जिन पर उपयोगकर्ता का मालिकाना हक है या जिन्हें उसके साथ शेयर किया गया है.
domain उपयोगकर्ता के डोमेन के साथ शेयर की गई फ़ाइलें.