Method: files.list

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

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

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

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

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

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

पैरामीटर
corpora

string

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

corpus
(deprecated)

enum (Corpus)

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

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

अब काम नहीं करता: इसके बजाय, includeItemsFromAllDrives का इस्तेमाल करें.

orderBy

string

क्रम से लगाने वाली कुंजियों की कॉमा-सेपरेटेड लिस्ट. मान्य बटन ये हैं: 'createdTime', 'फ़ोल्डर', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'reence', 'sharedWithMeTime', 'starred', और 'viewedByMeTime'. हर कुंजी डिफ़ॉल्ट रूप से बढ़ते क्रम में लगी होती है, लेकिन 'ब्यौरा' मॉडिफ़ायर की मदद से इसे उलटा जा सकता है. इस्तेमाल का उदाहरण: ?orderBy=Folder,modifiedTime desc,name.

pageSize

integer

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

pageToken

string

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

q

string

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

spaces

string

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

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

अब काम नहीं करता: इसके बजाय, supportsAllDrives का इस्तेमाल करें.

teamDriveId
(deprecated)

string

अब काम नहीं करता: इसके बजाय, driveId का इस्तेमाल करें.

includePermissionsForView

string

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

includeLabels

string

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "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 उपयोगकर्ता के डोमेन में शेयर की गई फ़ाइलें.