REST Resource: users.labels

संसाधन: लेबल

लेबल का इस्तेमाल, उपयोगकर्ता के मेलबॉक्स में मैसेज और थ्रेड को अलग-अलग कैटगरी में बांटने के लिए किया जाता है. उपयोगकर्ता के मेलबॉक्स में ज़्यादा से ज़्यादा 10,000 लेबल जोड़े जा सकते हैं.

जेएसओएन के काेड में दिखाना 
{
  "id": string,
  "name": string,
  "messageListVisibility": enum (MessageListVisibility),
  "labelListVisibility": enum (LabelListVisibility),
  "type": enum (Type),
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    object (Color)
  }
}
फ़ील्ड
id

string

लेबल का नहीं बदला जा सकने वाला आईडी.
name

string

लेबल का डिसप्ले नेम.
messageListVisibility

enum (MessageListVisibility)

Gmail वेब इंटरफ़ेस में मैसेज सूची में इस लेबल वाले मैसेज के दिखने की जानकारी.
labelListVisibility

enum (LabelListVisibility)

Gmail वेब इंटरफ़ेस में लेबल सूची में लेबल की दृश्यता.
type

enum (Type)

लेबल के लिए मालिक का टाइप. उपयोगकर्ता लेबल, उपयोगकर्ता बनाता है. उपयोगकर्ता इनमें बदलाव कर सकता है और उसे मिटा सकता है. साथ ही, उसे किसी भी मैसेज या थ्रेड पर लागू किया जा सकता है. सिस्टम लेबल अंदरूनी तौर पर बनाए जाते हैं. इन्हें जोड़ा, बदला या मिटाया नहीं जा सकता. कुछ मामलों में, सिस्टम लेबल को मैसेज और थ्रेड पर लागू किया जा सकता है या उनसे हटाया जा सकता है. हालांकि, इसकी कोई गारंटी नहीं है. उदाहरण के लिए, उपयोगकर्ता, मैसेज और थ्रेड से INBOX और UNREAD लेबल को लागू कर सकते हैं और हटा सकते हैं. हालांकि, वे मैसेज या थ्रेड से DRAFTS या SENT लेबल को लागू नहीं कर सकते और न ही उन्हें हटा सकते हैं.
messagesTotal

integer

लेबल वाले मैसेज की कुल संख्या.
messagesUnread

integer

लेबल वाले 'नहीं पढ़े गए' मैसेज की संख्या.
threadsTotal

integer

लेबल वाले थ्रेड की कुल संख्या.
threadsUnread

integer

लेबल वाली 'नहीं पढ़ी गई थ्रेड' की संख्या.
color

object (Color)

लेबल को असाइन किया जाने वाला रंग. रंग सिर्फ़ उन लेबल के लिए उपलब्ध होता है जिनके type को user पर सेट किया गया हो.

MessageListVisibility

Enums
show मैसेज सूची में लेबल दिखाएं.
hide मैसेज सूची में लेबल न दिखाएं.

LabelListVisibility

Enums
labelShow लेबल सूची में लेबल दिखाएं.
labelShowIfUnread अगर उस लेबल वाले 'नहीं पढ़े गए मैसेज' हैं, तो उस लेबल को दिखाएं.
labelHide लेबल सूची में लेबल न दिखाएं.

Type

Enums
system Gmail के बनाए गए लेबल.
user उपयोगकर्ता या ऐप्लिकेशन के बनाए गए कस्टम लेबल.

रंग

जेएसओएन के काेड में दिखाना 
{
  "textColor": string,
  "backgroundColor": string
}
फ़ील्ड
textColor

string

लेबल का टेक्स्ट कलर, जिसे हेक्स स्ट्रिंग के तौर पर दिखाया जाता है. लेबल का रंग सेट करने के लिए यह फ़ील्ड ज़रूरी है. #434343, #0000000, #434343, #6666666, #434312, #434,32, #434,32, #434,32, #4343, #43,23,22, जिनसे कोई भी
backgroundColor

string

बैकग्राउंड का रंग, हेक्स स्ट्रिंग #RRGGBB (उदाहरण #000000) के तौर पर दिखाया जाता है. लेबल का रंग सेट करने के लिए यह फ़ील्ड ज़रूरी है. #434343, #0000000, #434343, #6666666, #434312, #434,32, #434,32, #434,32, #4343, #43,23,22, जिनसे कोई भी

तरीके

create

 एक नया लेबल बनाता है.

delete

 बताए गए लेबल को तुरंत और हमेशा के लिए मिटा देता है. साथ ही, इसे उन सभी मैसेज और थ्रेड से हटा देता है जिन पर यह लागू होता है.

get

 बताए गए लेबल को दिखाता है.

list

 उपयोगकर्ता के मेलबॉक्स के सभी लेबल की सूची बनाता है.

patch

 चुने गए लेबल को पैच करें.

update

 बताए गए लेबल को अपडेट करता है.