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

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