REST Resource: users.labels

संसाधन: लेबल

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

JSON के काेड में दिखाना 
{
  "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 लेबल को लेबल की सूची में न दिखाएं.

टाइप

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

रंग

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

string

लेबल के टेक्स्ट का रंग, जिसे हेक्स स्ट्रिंग के तौर पर दिखाया जाता है. किसी लेबल का रंग सेट करने के लिए, यह फ़ील्ड ज़रूरी है. रंग की वैल्यू के लिए, पहले से तय किए गए सिर्फ़ इन सेट का इस्तेमाल किया जा सकता है:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
backgroundColor

string

बैकग्राउंड के रंग को हेक्स स्ट्रिंग #RRGGBB (जैसे, #000000) के तौर पर दिखाया जाता है. किसी लेबल का रंग सेट करने के लिए, यह फ़ील्ड ज़रूरी है. रंग की वैल्यू के लिए, पहले से तय किए गए सिर्फ़ इन सेट का इस्तेमाल किया जा सकता है:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

तरीके

create

 इससे नया लेबल बनता है.

delete

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

get

 यह फ़ंक्शन, तय किया गया लेबल दिखाता है.

list

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

patch

 इस तरीके का इस्तेमाल करके, किसी लेबल में बदलाव किया जा सकता है.

update

 इससे चुने गए लेबल को अपडेट किया जाता है.