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 होती है.

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

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

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

लिस्टिंग के लेबल के लिए जवाब.

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

जेएसओएन के काेड में दिखाना
{
  "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

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