Method: labels.list

लेबल की सूची बनाएं. ज़्यादा जानकारी के लिए, लेबल खोजना लेख पढ़ें.

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

GET https://drivelabels.googleapis.com/v2/labels

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

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

पैरामीटर
publishedOnly

boolean

नतीजों में सिर्फ़ पब्लिश किए गए लेबल शामिल करने हैं या नहीं.

  • true होने पर, सिर्फ़ पब्लिश किए गए लेबल के मौजूदा वर्शन में किए गए बदलाव दिखते हैं. इसमें बंद किए गए लेबल शामिल हैं. लेबल किए गए संसाधन के नाम, पब्लिश किए गए वर्शन (labels/{id}/{revisionId}) का रेफ़रंस देते हैं.
  • false करने पर, लेबल में किए गए मौजूदा बदलावों को वापस लाया जाता है. ऐसा हो सकता है कि ये बदलाव पब्लिश न किए गए हों. लौटाए गए लेबल रिसॉर्स के नाम, किसी खास वर्शन (labels/{id}) का रेफ़रंस नहीं देते हैं.
customer

string

वह ग्राहक जिसके लिए इस सूची के अनुरोध का दायरा तय करना है. उदाहरण के लिए: customers/abcd1234. अगर इसे सेट नहीं किया जाता है, तो मौजूदा ग्राहक के सभी लेबल दिखेंगे.

languageCode

string

स्थानीय भाषा में फ़ील्ड के लेबल का आकलन करने के लिए, BCP-47 भाषा कोड का इस्तेमाल करें. अगर इस एट्रिब्यूट की वैल्यू नहीं दी जाती है, तो कॉन्फ़िगर की गई डिफ़ॉल्ट भाषा में मौजूद वैल्यू का इस्तेमाल किया जाता है.

pageSize

integer

हर पेज पर ज़्यादा से ज़्यादा लेबल दिखाए जा सकते हैं. डिफ़ॉल्ट: 50. ज़्यादा से ज़्यादा: 200.

pageToken

string

वापस जाने के लिए पेज का टोकन.

view

enum (LabelView)

अगर ऐसा किया जाता है, तो सिर्फ़ बताए गए व्यू से जुड़े कुछ फ़ील्ड दिखाए जाते हैं.

यूनियन पैरामीटर access.

access इनमें से सिर्फ़ एक हो सकता है:

useAdminAccess

boolean

उपयोगकर्ता के एडमिन क्रेडेंशियल का इस्तेमाल करने के लिए, इसे true पर सेट करें. इससे ग्राहक के सभी लेबल दिखेंगे.

minimumRole

enum (LabelRole)

इससे पता चलता है कि उपयोगकर्ता के पास, दिखाए गए लेबल का कौनसा ऐक्सेस लेवल होना चाहिए. किसी लेबल पर उपयोगकर्ता के पास कम से कम यह भूमिका होनी चाहिए. डिफ़ॉल्ट रूप से, यह READER पर सेट होती है.

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

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

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

लेबल की सूची बनाने के लिए जवाब.

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

JSON के काेड में दिखाना
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
labels[]

object (Label)

लेबल.

nextPageToken

string

जवाब में मौजूद अगले पेज का टोकन.

अनुमति के स्कोप

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

ज़्यादा जानकारी के लिए, अनुमति पाने से जुड़ी गाइड देखें.