Method: files.list

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

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

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

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

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

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

पैरामीटर
corpora

string

उन आइटम (फ़ाइलें/दस्तावेज़) के निकाय जिन पर क्वेरी लागू होती है. 'user', 'domain', 'drive', और 'allDrives' बॉडी इस्तेमाल किए जा सकते हैं. 'उपयोगकर्ता' को प्राथमिकता दें या 'drive' 'allDrives' पर इस्तेमाल किया जा सकता है. डिफ़ॉल्ट रूप से, कॉर्पोरा 'उपयोगकर्ता' पर सेट होता है. हालांकि, '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: उपयोगकर्ता ने पिछली बार फ़ाइल कब देखी थी.

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

pageSize

integer

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

pageToken

string

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

q

string

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

spaces

string

कॉर्पोरा में क्वेरी करने के लिए स्पेस की कॉमा-सेपरेटेड लिस्ट. इस्तेमाल की जा सकने वाली वैल्यू 'drive' हैं और 'appData Folder' में मिलेगा.

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

इससे पता चलता है कि रिस्पॉन्स में किस अतिरिक्त व्यू की अनुमतियां शामिल करनी हैं. सिर्फ़ 'पब्लिश किया गया' समर्थित है.

includeLabels

string

जवाब के labelInfo हिस्से में शामिल करने के लिए, लेबल के आईडी की कॉमा-सेपरेटेड लिस्ट.

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

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

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

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

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

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

string

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

kind

string

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

files[]

object (File)

फ़ाइलों की सूची. अगर 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

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

कॉर्पस

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