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: फ़ाइल का टाइटल. इस फ़ील्ड को वर्णमाला के क्रम के हिसाब से क्रम में लगाया जाता है, इसलिए 1, 12, 2, 22.
  • title_natural: फ़ाइल का टाइटल. इस फ़ील्ड को नैचुरल क्रम से लगाया गया है, इसलिए 1, 2, 12, 22.

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

ध्यान दें कि जिन उपयोगकर्ताओं के पास करीब एक करोड़ फ़ाइलें हैं उनके लिए, फ़ाइलों को क्रम से लगाने के अनुरोध को अनदेखा कर दिया जाता है.
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 हिस्से में शामिल करने के लिए, लेबल के आईडी की कॉमा-सेपरेटेड लिस्ट.

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "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.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
DEFAULT वे आइटम जिन्हें उपयोगकर्ता ने ऐक्सेस किया है.
DOMAIN उपयोगकर्ता के डोमेन में शेयर किए गए आइटम.