Method: files.list

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

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

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

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

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

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

पैरामीटर
corpora

string

आइटम (फ़ाइलें या दस्तावेज़) जिन पर क्वेरी लागू होती है. default, domain, drive, और allDrives का इस्तेमाल किया जा सकता है. बेहतर परफ़ॉर्मेंस के लिए, allDrives के लिए default या drive को प्राथमिकता दें.

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=फ़ोल्डर,modifiedDate Description,title. कृपया ध्यान दें कि ऐसे उपयोगकर्ताओं पर मौजूदा सीमा लागू होती है जिनके पास करीब 10 लाख फ़ाइलें हैं. ऐसे उपयोगकर्ताओं के लिए, क्रम से लगाने के अनुरोध को अनदेखा किया जाता है.

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 हिस्से में शामिल करने के लिए, लेबल के आईडी की कॉमा-सेपरेटेड लिस्ट.

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

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "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)

फ़ाइलों की सूची. अगर NextPageToken को पॉप्युलेट किया जाता है, तो यह सूची अधूरी हो सकती है. साथ ही, नतीजों का एक और पेज फ़ेच किया जाना चाहिए.

अनुमति देने के दायरे

इनमें से कोई एक 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

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

कॉर्पस

Enums
DEFAULT वे आइटम जिन्हें उपयोगकर्ता ने ऐक्सेस किया है.
DOMAIN उपयोगकर्ता के डोमेन में शेयर किए गए आइटम.