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

लेबल के टेक्स्ट का रंग, जिसे हेक्स स्ट्रिंग के तौर पर दिखाया जाता है. लेबल का रंग सेट करने के लिए यह फ़ील्ड ज़रूरी है.

backgroundColor

string

बैकग्राउंड का रंग, हेक्स स्ट्रिंग #RRGGBB (उदाहरण के लिए #000000) के तौर पर दिखाया जाता है. लेबल का रंग सेट करने के लिए यह फ़ील्ड ज़रूरी है.

तरीके

create

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

delete

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

get

तय किया गया लेबल मिलता है.

list

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

patch

बताए गए लेबल को पैच करें.

update

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