Method: files.list

उपयोगकर्ता की फ़ाइलों की सूची दिखाता है. ज़्यादा जानकारी के लिए, फ़ाइलें और फ़ोल्डर खोजना लेख पढ़ें.

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

यह तरीका डिफ़ॉल्ट रूप से, ट्रैश की गई फ़ाइलों के साथ-साथ सभी फ़ाइलों को दिखाता है. अगर आपको ट्रैश की गई फ़ाइलों को सूची में नहीं दिखाना है, तो trashed=false क्वेरी पैरामीटर का इस्तेमाल करके, ट्रैश की गई फ़ाइलों को नतीजों से हटाएं.

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

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.

हर कुंजी को डिफ़ॉल्ट रूप से बढ़ते क्रम में लगाया जाता है. हालांकि, 'desc' मॉडिफ़ायर का इस्तेमाल करके, इसे उलट-पलट किया जा सकता है. इस्तेमाल का उदाहरण: ?orderBy=folder,modifiedDate desc,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 के तौर पर जवाब में शामिल किए जाने वाले लेबल के आईडी की कॉमा लगाकर अलग की गई सूची.

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

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
फ़ील्ड
items[]

object (File)

फ़ाइलों की सूची. अगर nextPageToken भरा गया है, तो हो सकता है कि यह सूची पूरी न हो. ऐसे में, नतीजों का एक और पेज फ़ेच किया जाना चाहिए.
nextPageToken

string

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

string

यह हमेशा drive#fileList होता है.
etag

string

सूची का ETag.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक 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 उपयोगकर्ता के डोमेन के साथ शेयर किए गए आइटम.