Method: files.list

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

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

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

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

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

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

पैरामीटर
corpora

string

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

इससे पता चलता है कि जवाब में कौनसे अतिरिक्त व्यू की अनुमतियां शामिल करनी हैं. सिर्फ़ 'पब्लिश किया गया' का इस्तेमाल किया जा सकता है.
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 उपयोगकर्ता के डोमेन में शेयर की गई फ़ाइलें.