REST Resource: labels

संसाधन: लेबल

लेबल से, डेटा की अलग-अलग कैटगरी तय की जाती हैं. इन कैटगरी को Drive में मौजूद आइटम पर लागू करके, उन्हें व्यवस्थित किया जा सकता है और खोजा जा सकता है. लेबल, आसान स्ट्रिंग हो सकते हैं या उनमें ऐसे फ़ील्ड हो सकते हैं जिनमें अतिरिक्त मेटाडेटा की जानकारी होती है. इस मेटाडेटा का इस्तेमाल, Drive के आइटम व्यवस्थित करने और उन्हें खोजने के लिए किया जा सकता है.

JSON के काेड में दिखाना
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. लेबल का संसाधन का नाम. यह अनुरोध के आधार पर, labels/{id} या labels/{id}@{revisionId} में से किसी एक फ़ॉर्मैट में होगा. id और revisionId यहां देखें.

id

string

सिर्फ़ आउटपुट के लिए. इस लेबल का दुनिया भर में इस्तेमाल होने वाला यूनीक आइडेंटिफ़ायर. आईडी, लेबल name का हिस्सा होता है. हालांकि, name के उलट, आईडी में बदलाव नहीं होता. रेगुलर एक्सप्रेशन से मैच करता है: ([a-zA-Z0-9])+

revisionId

string

सिर्फ़ आउटपुट के लिए. लेबल का बदलाव आईडी. किए गए अनुरोध के आधार पर, रिविज़न आईडी, लेबल name का हिस्सा हो सकता है. जब भी किसी लेबल की बदली गई प्रॉपर्टी में बदलाव किया जाता है, तो एक नया रीविज़न बन जाता है. रेगुलर एक्सप्रेशन से मैच करता है: ([a-zA-Z0-9])+

labelType

enum (LabelType)

ज़रूरी है. लेबल का टाइप.

creator

object (UserInfo)

सिर्फ़ आउटपुट के लिए. इस लेबल को बनाने वाला उपयोगकर्ता.

createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस लेबल को बनाने का समय.

revisionCreator

object (UserInfo)

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने लेबल में यह बदलाव किया है.

revisionCreateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस लेबल में बदलाव करने का समय.

publisher

object (UserInfo)

सिर्फ़ आउटपुट के लिए. इस लेबल को पब्लिश करने वाला उपयोगकर्ता. अगर लेबल पब्लिश नहीं किया गया है, तो इस वैल्यू का कोई मतलब नहीं है.

publishTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस लेबल को पब्लिश करने का समय. अगर लेबल पब्लिश नहीं किया गया है, तो इस वैल्यू का कोई मतलब नहीं है.

disabler

object (UserInfo)

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने इस लेबल को बंद किया है. अगर लेबल बंद नहीं है, तो इस वैल्यू का कोई मतलब नहीं है.

disableTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस लेबल को बंद करने का समय. अगर लेबल बंद नहीं है, तो इस वैल्यू का कोई मतलब नहीं है.

customer

string

सिर्फ़ आउटपुट के लिए. वह ग्राहक जिससे यह लेबल जुड़ा है. उदाहरण के लिए: "customers/123abc789."

properties

object (Properties)

ज़रूरी है. लेबल की बुनियादी प्रॉपर्टी.

lifecycle

object (Lifecycle)

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

displayHints

object (DisplayHints)

सिर्फ़ आउटपुट के लिए. लेबल को रेंडर करने के लिए, यूज़र इंटरफ़ेस (यूआई) में सलाह दिखती हैं.

appliedCapabilities

object (AppliedCapabilities)

सिर्फ़ आउटपुट के लिए. लागू किए गए मेटाडेटा पर इस लेबल से जुड़ी सुविधाएं.

schemaCapabilities

object (SchemaCapabilities)

सिर्फ़ आउटपुट के लिए. इस लेबल पर उपयोगकर्ता के पास कौनसी सुविधाएं हैं.

appliedLabelPolicy

object (AppliedLabelPolicy)

सिर्फ़ आउटपुट के लिए. Drive में मौजूद आइटम पर लागू होने पर, इस लेबल का व्यवहार.

fields[]

object (Field)

प्राथमिकता के घटते क्रम में फ़ील्ड की सूची.

learnMoreUri

string

उपयोगकर्ताओं को दिखाने के लिए कस्टम यूआरएल, ताकि वे इस लेबल और इसका इस्तेमाल करने के तरीके के बारे में ज़्यादा जान सकें.

lockStatus

object (LockStatus)

सिर्फ़ आउटपुट के लिए. इस लेबल का LockStatus.

enabledAppSettings

object (EnabledAppSettings)

ज़रूरी नहीं. इस लेबल के लिए EnabledAppSettings.

LabelType

इस लेबल का टाइप.

Enums
LABEL_TYPE_UNSPECIFIED लेबल का टाइप अज्ञात है.
SHARED शेयर किए गए लेबल को उपयोगकर्ताओं के साथ शेयर किया जा सकता है, ताकि वे उन्हें Drive के आइटम पर लागू कर सकें.
ADMIN एडमिन के मालिकाना हक वाला लेबल. सिर्फ़ एडमिन ही इसे बना सकते हैं और इसमें बदलाव कर सकते हैं. इसमें सिर्फ़ एडमिन के लिए उपलब्ध कुछ अन्य सुविधाएं भी काम करती हैं.
GOOGLE_APP ऐसा लेबल जिसका मालिकाना हक, ग्राहक के बजाय Google के किसी इंटरनल ऐप्लिकेशन के पास हो. इन लेबल को सिर्फ़ पढ़ा जा सकता है.

UserInfo

उपयोगकर्ता के बारे में जानकारी.

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

string

इस उपयोगकर्ता का आइडेंटिफ़ायर, जिसका इस्तेमाल ज़्यादा जानकारी पाने के लिए, People API के साथ किया जा सकता है. उदाहरण के लिए, people/12345678.

प्रॉपर्टी

लेबल की बुनियादी प्रॉपर्टी.

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

string

ज़रूरी है. लेबल का टाइटल.

description

string

लेबल की जानकारी.

जीवनचक्र

किसी ऑब्जेक्ट का लाइफ़साइकल स्टेटस, जैसे कि लेबल, फ़ील्ड या विकल्प. लाइफ़ साइकल, इन ट्रांज़िशन को लागू करता है:

  • UNPUBLISHED_DRAFT (शुरुआती स्थिति)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (मिटाया गया)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (मिटाया गया)

पब्लिश किए गए और बंद किए गए स्टेटस में कुछ अलग-अलग विशेषताएं होती हैं:

  • पब्लिश किया गया—इस स्थिति में किसी ऑब्जेक्ट में कुछ तरह के बदलाव किए जा सकते हैं. ऐसे में, hasUnpublishedChanges की वैल्यू 'सही' होगी. साथ ही, कुछ तरह के बदलाव करने की अनुमति नहीं है. आम तौर पर, ऐसा कोई भी बदलाव अस्वीकार कर दिया जाता है जिससे लेबल से जुड़े मौजूदा मेटाडेटा को अमान्य कर दिया जाए या उस पर नई पाबंदियां लगाई जाएं.
  • बंद है—बंद होने पर, कॉन्फ़िगर किया गया DisabledPolicy लागू हो जाता है.
JSON के काेड में दिखाना
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
फ़ील्ड
state

enum (State)

सिर्फ़ आउटपुट के लिए. इस लाइफ़साइकल से जुड़े ऑब्जेक्ट की स्थिति.

hasUnpublishedChanges

boolean

सिर्फ़ आउटपुट के लिए. इस लाइफ़साइकल से जुड़े ऑब्जेक्ट में ऐसे बदलाव हैं जिन्हें पब्लिश नहीं किया गया है.

disabledPolicy

object (DisabledPolicy)

यह नीति, बंद किए गए लेबल, फ़ील्ड या चुनने के विकल्प को दिखाने के तरीके को कंट्रोल करती है.

स्थिति

इस लाइफ़साइकल से जुड़े ऑब्जेक्ट की स्थिति.

Enums
STATE_UNSPECIFIED स्थिति की जानकारी मौजूद नहीं है.
UNPUBLISHED_DRAFT किसी ऑब्जेक्ट की शुरुआती स्थिति. पब्लिश होने के बाद, ऑब्जेक्ट को कभी भी इस स्थिति में नहीं लाया जा सकता. किसी ऑब्जेक्ट को पब्लिश करने के बाद, उसमें कुछ खास तरह के बदलाव नहीं किए जा सकते.
PUBLISHED ऑब्जेक्ट पब्लिश हो गया है. ऑब्जेक्ट में ऐसे बदलाव हो सकते हैं जिन्हें पब्लिश नहीं किया गया है. इन बदलावों के बारे में hasUnpublishedChanges से पता चलता है.
DISABLED ऑब्जेक्ट को पब्लिश कर दिया गया है और उसके बाद से उसे बंद कर दिया गया है. ऑब्जेक्ट में ऐसे बदलाव हो सकते हैं जिन्हें पब्लिश नहीं किया गया है. इन बदलावों के बारे में hasUnpublishedChanges से पता चलता है.
DELETED ऑब्जेक्ट मिटा दिया गया है.

DisabledPolicy

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

JSON के काेड में दिखाना
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
फ़ील्ड
showInApply

boolean

Drive के आइटम पर, लागू करें मेन्यू में इस बंद किए गए आइटम को दिखाना है या नहीं.

  • true के 'बंद है' होने पर, ऑब्जेक्ट आम तौर पर यूज़र इंटरफ़ेस (यूआई) में बंद के तौर पर दिखता है और उसे चुना नहीं जा सकता.
  • false होने पर, ऑब्जेक्ट आम तौर पर यूज़र इंटरफ़ेस (यूआई) में छिपा होता है.

DisplayHints

लेबल को रेंडर करने के लिए, यूज़र इंटरफ़ेस (यूआई) में सलाह दिखती हैं.

JSON के काेड में दिखाना
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
फ़ील्ड
disabled

boolean

क्या लेबल को यूज़र इंटरफ़ेस (यूआई) में 'बंद है' के तौर पर दिखाया जाना चाहिए.

shownInApply

boolean

Drive आइटम में वैल्यू लागू करते समय, यह लेबल 'लागू करें' मेन्यू में दिखना चाहिए.

priority

string (int64 format)

सूची में लेबल दिखाने का क्रम.

AppliedCapabilities

इस लेबल के लागू किए गए मेटाडेटा पर, उपयोगकर्ता के पास कौनसी सुविधाएं हैं.

JSON के काेड में दिखाना
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
फ़ील्ड
canRead

boolean

उपयोगकर्ता, इस लेबल से जुड़ा लागू मेटाडेटा पढ़ सकता है या नहीं.

canApply

boolean

उपयोगकर्ता, आइटम पर यह लेबल लागू कर सकता है या नहीं.

canRemove

boolean

उपयोगकर्ता, आइटम से इस लेबल को हटा सकता है या नहीं.

SchemaCapabilities

लेबल में बदलाव करते समय, इस लेबल से जुड़ी सुविधाएं.

JSON के काेड में दिखाना
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
फ़ील्ड
canUpdate

boolean

उपयोगकर्ता इस लेबल को बदल सकता है या नहीं.

canDelete

boolean

उपयोगकर्ता के पास इस लेबल को मिटाने का विकल्प है या नहीं. उपयोगकर्ता के पास अनुमति होनी चाहिए और लेबल बंद होना चाहिए.

canDisable

boolean

उपयोगकर्ता इस लेबल को बंद कर सकता है या नहीं. उपयोगकर्ता के पास अनुमति होनी चाहिए और यह लेबल पहले से बंद न होना चाहिए.

canEnable

boolean

उपयोगकर्ता इस लेबल को चालू कर सकता है या नहीं. उपयोगकर्ता के पास अनुमति होनी चाहिए और यह लेबल बंद होना चाहिए.

AppliedLabelPolicy

Drive में मौजूद आइटम पर लागू होने पर, इस लेबल का व्यवहार.

JSON के काेड में दिखाना
{
  "copyMode": enum (CopyMode)
}
फ़ील्ड
copyMode

enum (CopyMode)

इससे पता चलता है कि Drive के किसी आइटम को कॉपी करते समय, लागू किए गए लेबल और फ़ील्ड वैल्यू को कैसे कॉपी किया जाना चाहिए.

CopyMode

इससे पता चलता है कि Drive के किसी आइटम को कॉपी करते समय, लागू किए गए लेबल और फ़ील्ड की वैल्यू को कैसे कॉपी किया जाना चाहिए.

Enums
COPY_MODE_UNSPECIFIED कॉपी मोड की जानकारी नहीं दी गई है.
DO_NOT_COPY Drive के जिस आइटम पर लेबल और फ़ील्ड की वैल्यू लागू की गई है उसे कॉपी करने पर, डिफ़ॉल्ट रूप से लेबल और फ़ील्ड की वैल्यू कॉपी नहीं होतीं.
ALWAYS_COPY जिस Drive आइटम पर लेबल लागू किया गया है उसे कॉपी करने पर, लागू किए गए लेबल और फ़ील्ड की वैल्यू हमेशा कॉपी की जाती हैं. सिर्फ़ एडमिन इस मोड का इस्तेमाल कर सकते हैं.
COPY_APPLIABLE अगर कॉपी करने वाले उपयोगकर्ता के पास लेबल लागू करने का ऐक्सेस है, तो लागू किए गए लेबल और फ़ील्ड वैल्यू कॉपी की जाती हैं.

फ़ील्ड

ऐसे फ़ील्ड के बारे में बताता है जिसमें डिसप्ले नेम, डेटा टाइप, और कॉन्फ़िगरेशन के अन्य विकल्प होते हैं. इस फ़ील्ड से यह तय होता है कि Drive के किसी आइटम पर किस तरह का मेटाडेटा सेट किया जा सकता है.

JSON के काेड में दिखाना
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
फ़ील्ड
id

string

सिर्फ़ आउटपुट के लिए. किसी फ़ील्ड की कुंजी, जो किसी लेबल या लाइब्रेरी में यूनीक होती है.

यह वैल्यू अपने-आप जनरेट होती है. रेगुलर एक्सप्रेशन से मैच करता है: ([a-zA-Z0-9])+

queryKey

string

सिर्फ़ आउटपुट के लिए. Drive में फ़ाइलें खोजने के लिए क्वेरी बनाते समय इस्तेमाल की जाने वाली कुंजी. इसकी मदद से, फ़ाइलों में इस फ़ील्ड के लिए तय की गई वैल्यू के आधार पर फ़ाइलें खोजी जा सकती हैं. उदाहरण के लिए, "{queryKey} > 01-01-2001".

properties

object (Properties)

फ़ील्ड की बुनियादी प्रॉपर्टी.

lifecycle

object (Lifecycle)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड का लाइफ़साइकल.

displayHints

object (DisplayHints)

सिर्फ़ आउटपुट के लिए. यूज़र इंटरफ़ेस (यूआई), किसी फ़ील्ड को रेंडर करने के लिए सलाह दिखाता है.

schemaCapabilities

object (SchemaCapabilities)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड में बदलाव करते समय, इस उपयोगकर्ता के पास कौनसी अनुमतियां होती हैं.

appliedCapabilities

object (AppliedCapabilities)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड पर उपयोगकर्ता के पास कौनसी अनुमतियां हैं और Drive के आइटम पर लेबल लागू होने पर इसकी वैल्यू क्या होगी.

creator

object (UserInfo)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड को बनाने वाला उपयोगकर्ता.

createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड को बनाने का समय.

updater

object (UserInfo)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड में बदलाव करने वाला उपयोगकर्ता.

updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड को अपडेट करने का समय.

publisher

object (UserInfo)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड को पब्लिश करने वाला उपयोगकर्ता. अगर फ़ील्ड पब्लिश नहीं किया गया है, तो इस वैल्यू का कोई मतलब नहीं है.

disabler

object (UserInfo)

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

disableTime

string (Timestamp format)

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

lockStatus

object (LockStatus)

सिर्फ़ आउटपुट के लिए. इस फ़ील्ड का LockStatus.

यूनियन फ़ील्ड type. इस फ़ील्ड का डेटा टाइप और विकल्प. पब्लिश होने के बाद, डेटा टाइप नहीं बदला जा सकता. type इनमें से कोई एक हो सकता है:
textOptions

object (TextOptions)

टेक्स्ट फ़ील्ड के विकल्प.

integerOptions

object (IntegerOptions)

इंटेजर फ़ील्ड के विकल्प.

dateOptions

object (DateOptions)

तारीख वाले फ़ील्ड के विकल्प.

selectionOptions

object (SelectionOptions)

चुनने के लिए फ़ील्ड के विकल्प.

userOptions

object (UserOptions)

उपयोगकर्ता फ़ील्ड के विकल्प.

TextOptions

टेक्स्ट फ़ील्ड टाइप के विकल्प.

JSON के काेड में दिखाना
{
  "minLength": integer,
  "maxLength": integer
}
फ़ील्ड
minLength

integer

सिर्फ़ आउटपुट के लिए. टेक्स्ट फ़ील्ड के लिए वैल्यू की कम से कम मान्य लंबाई.

maxLength

integer

सिर्फ़ आउटपुट के लिए. टेक्स्ट फ़ील्ड के लिए वैल्यू की ज़्यादा से ज़्यादा मान्य लंबाई.

IntegerOptions

इंटिजर फ़ील्ड टाइप के विकल्प.

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

string (int64 format)

सिर्फ़ आउटपुट के लिए. इंटीजर फ़ील्ड के लिए मान्य कम से कम वैल्यू.

maxValue

string (int64 format)

सिर्फ़ आउटपुट के लिए. इंटीजर फ़ील्ड के लिए, ज़्यादा से ज़्यादा मान्य वैल्यू.

DateOptions

तारीख वाले फ़ील्ड के टाइप के विकल्प.

JSON के काेड में दिखाना
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
फ़ील्ड
dateFormatType

enum (DateFormat)

तारीख को स्थानीय भाषा में फ़ॉर्मैट करने का विकल्प. फ़ील्ड की वैल्यू, उनकी स्थानीय भाषा के हिसाब से इस फ़ॉर्मैट में रेंडर की जाती हैं.

dateFormat

string

सिर्फ़ आउटपुट के लिए. ICU तारीख फ़ॉर्मैट.

minValue

object (Date)

सिर्फ़ आउटपुट के लिए. साल, महीना, और दिन की कम से कम मान्य वैल्यू.

maxValue

object (Date)

सिर्फ़ आउटपुट के लिए. ज़्यादा से ज़्यादा मान्य वैल्यू (साल, महीना, दिन).

DateFormat

स्थानीय भाषा के हिसाब से तारीख के फ़ॉर्मैट के विकल्प.

Enums
DATE_FORMAT_UNSPECIFIED तारीख का फ़ॉर्मैट नहीं बताया गया है.
LONG_DATE इसमें महीने का पूरा नाम शामिल होता है. उदाहरण के लिए, 12 जनवरी, 1999 (MMMM d, y)
SHORT_DATE छोटा, अंकों वाला, रिप्रज़ेंटेशन. उदाहरण के लिए, 13/12/99 (M/d/yy)

तारीख

कैलेंडर की पूरी या कुछ तारीख दिखाता है, जैसे कि जन्मदिन. दिन का समय और टाइम ज़ोन, कहीं और बताया गया है या यह जानकारी ज़रूरी नहीं है. तारीख, ग्रेगोरियन कैलेंडर के हिसाब से होती है. यह इनमें से किसी एक को दिखा सकता है:

  • साल, महीने, और दिन की वैल्यू शून्य से ज़्यादा होनी चाहिए.
  • साल के तौर पर शून्य के साथ महीना और दिन (उदाहरण के लिए, सालगिरह).
  • साल, जिसमें महीना और दिन शून्य है.
  • साल और महीना, जिसमें दिन की वैल्यू शून्य हो. उदाहरण के लिए, क्रेडिट कार्ड के खत्म होने की तारीख.

मिलते-जुलते टाइप:

JSON के काेड में दिखाना
{
  "year": integer,
  "month": integer,
  "day": integer
}
फ़ील्ड
year

integer

तारीख का साल. यह संख्या 1 से 9999 के बीच होनी चाहिए. अगर साल के बिना तारीख बतानी है, तो 0 डालें.

month

integer

साल का महीना. यह 1 से 12 के बीच की कोई संख्या होनी चाहिए. इसके अलावा, महीने और दिन के बिना साल बताने के लिए, 0 डाला जा सकता है.

day

integer

महीने का दिन. यह वैल्यू 1 से 31 के बीच की होनी चाहिए. साथ ही, यह साल और महीने के लिए मान्य होनी चाहिए. इसके अलावा, साल या साल और महीने के लिए 0 भी डाला जा सकता है, जहां दिन की वैल्यू का कोई मतलब नहीं है.

SelectionOptions

चुनने के लिए उपलब्ध फ़ील्ड टाइप के विकल्प.

JSON के काेड में दिखाना
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
फ़ील्ड
listOptions

object (ListOptions)

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

choices[]

object (Choice)

इस फ़ील्ड में चुने जाने वाले विकल्प. सूची का क्रम एक जैसा रहता है और insertBeforeChoice की मदद से उसमें बदलाव किया जा सकता है.

ListOptions

किसी फ़ील्ड टाइप के कई वैल्यू वाले वैरिएंट के विकल्प.

JSON के काेड में दिखाना
{
  "maxEntries": integer
}
फ़ील्ड
maxEntries

integer

ज़्यादा से ज़्यादा इतनी एंट्री की अनुमति है.

विकल्प

चुनने के लिए फ़ील्ड का विकल्प.

JSON के काेड में दिखाना
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
फ़ील्ड
id

string

चुने गए विकल्प की यूनीक वैल्यू. यह आईडी अपने-आप जनरेट होता है. रेगुलर एक्सप्रेशन से मैच करता है: ([a-zA-Z0-9_])+.

properties

object (Properties)

चुनी गई प्रॉपर्टी की बुनियादी जानकारी.

lifecycle

object (Lifecycle)

सिर्फ़ आउटपुट के लिए. चुने गए विकल्प का लाइफ़साइकल.

displayHints

object (DisplayHints)

सिर्फ़ आउटपुट के लिए. यूज़र इंटरफ़ेस (यूआई) की इमेज, जिसमें किसी विकल्प को रेंडर करने के लिए दिए गए संकेत दिख रहे हैं.

schemaCapabilities

object (SchemaCapabilities)

सिर्फ़ आउटपुट के लिए. विकल्प में बदलाव करते समय, इस विकल्प से जुड़ी सुविधाएं.

appliedCapabilities

object (AppliedCapabilities)

सिर्फ़ आउटपुट के लिए. लागू किए गए मेटाडेटा पर इस विकल्प से जुड़ी सुविधाएं.

creator

object (UserInfo)

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने यह विकल्प बनाया है.

createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. यह विकल्प कब बनाया गया था.

updater

object (UserInfo)

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने इस विकल्प को आखिरी बार अपडेट किया था.

updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस विकल्प को पिछली बार अपडेट किए जाने का समय.

publisher

object (UserInfo)

सिर्फ़ आउटपुट के लिए. जिस उपयोगकर्ता ने यह विकल्प पब्लिश किया है. अगर विकल्प पब्लिश नहीं किया गया है, तो इस वैल्यू का कोई मतलब नहीं है.

publishTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. यह विकल्प पब्लिश होने का समय. अगर विकल्प पब्लिश नहीं किया गया है, तो इस वैल्यू का कोई मतलब नहीं है.

disabler

object (UserInfo)

सिर्फ़ आउटपुट के लिए. इस विकल्प को बंद करने वाला उपयोगकर्ता. अगर यह विकल्प बंद नहीं है, तो इस वैल्यू का कोई मतलब नहीं है.

disableTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस विकल्प को बंद करने का समय. अगर विकल्प बंद नहीं है, तो इस वैल्यू का कोई मतलब नहीं है.

lockStatus

object (LockStatus)

सिर्फ़ आउटपुट के लिए. इस विकल्प का LockStatus.

प्रॉपर्टी

चुनी गई प्रॉपर्टी की बुनियादी जानकारी.

JSON के काेड में दिखाना
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
फ़ील्ड
displayName

string

ज़रूरी है. इस फ़ील्ड की पहचान करने वाले यूज़र इंटरफ़ेस (यूआई) में दिखाने के लिए डिसप्ले टेक्स्ट.

description

string

इस लेबल की जानकारी.

badgeConfig

object (BadgeConfig)

इस विकल्प के लिए बैज का कॉन्फ़िगरेशन. सेट होने पर, इस विकल्प का मालिकाना हक रखने वाले लेबल को "बैज वाला लेबल" माना जाता है.

insertBeforeChoice

string

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

BadgeConfig

लेबल का बैज स्टेटस.

JSON के काेड में दिखाना
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
फ़ील्ड
color

object (Color)

बैज का रंग. अगर इसकी वैल्यू नहीं दी गई है, तो कोई बैज रेंडर नहीं किया जाता. यहां सेट किए गए बैकग्राउंड, फ़ोरग्राउंड, और सोलो (लाइट और डार्क मोड) के रंग, Drive के यूज़र इंटरफ़ेस (यूआई) में, सुझाए गए मिलते-जुलते रंग में बदल जाते हैं.

priorityOverride

string (int64 format)

इस बैज की डिफ़ॉल्ट ग्लोबल प्राथमिकता को बदलें. 0 पर सेट होने पर, प्राथमिकता के लिए डिफ़ॉल्ट हेयुरिस्टिक्स का इस्तेमाल किया जाता है.

रंग

RGBA कलर स्पेस में किसी रंग को दिखाता है. इस डेटा को इस तरह से डिज़ाइन किया गया है कि इसे अलग-अलग भाषाओं में आसानी से रंग के तौर पर दिखाया जा सके. उदाहरण के लिए, इस रिप्रज़ेंटेशन के फ़ील्ड को Java में java.awt.Color के कन्स्ट्रक्टर को आसानी से दिया जा सकता है. साथ ही, इसे iOS में UIColor के +colorWithRed:green:blue:alpha तरीके को भी आसानी से दिया जा सकता है. इसके अलावा, थोड़े से काम से इसे JavaScript में सीएसएस rgba() स्ट्रिंग में आसानी से फ़ॉर्मैट किया जा सकता है.

इस रेफ़रंस पेज पर, उस कलर स्पेस के बारे में जानकारी नहीं है जिसका इस्तेमाल आरजीबी वैल्यू को समझने के लिए किया जाना चाहिए. उदाहरण के लिए, sRGB, Adobe RGB, DCI-P3, और BT.2020. डिफ़ॉल्ट रूप से, ऐप्लिकेशन को sRGB कलर स्पेस का इस्तेमाल करना चाहिए.

जब यह तय करना हो कि दो रंग एक जैसे हैं या नहीं, तो दो रंगों को एक जैसे माना जाता है. ऐसा तब किया जाता है, जब उनके लाल, हरे, नीले, और अल्फा रंग की वैल्यू में ज़्यादा से ज़्यादा 1e-5 का अंतर हो. हालांकि, ऐसा तब ही किया जाता है, जब इसके लिए कोई अन्य दस्तावेज़ उपलब्ध न हो.

उदाहरण (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

उदाहरण (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

उदाहरण (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
JSON के काेड में दिखाना
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
फ़ील्ड
red

number

रंग में लाल रंग की मात्रा, [0, 1] इंटरवल में वैल्यू के तौर पर.

green

number

रंग में हरे रंग की मात्रा, जो [0, 1] की रेंज में होती है.

blue

number

रंग में नीले रंग की मात्रा, [0, 1] इंटरवल में वैल्यू के तौर पर.

alpha

number

इस रंग का वह हिस्सा जिसे पिक्सल पर लागू करना है. इसका मतलब है कि पिक्सल का आखिरी रंग, इस समीकरण से तय होता है:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

इसका मतलब है कि 1.0 की वैल्यू, किसी एक रंग से मेल खाती है, जबकि 0.0 की वैल्यू, पूरी तरह से पारदर्शी रंग से मेल खाती है. यह सामान्य फ़्लोट स्केलर के बजाय, रैपर मैसेज का इस्तेमाल करता है, ताकि डिफ़ॉल्ट वैल्यू और अनसेट की जा रही वैल्यू के बीच अंतर किया जा सके. अगर इस एट्रिब्यूट की वैल्यू नहीं दी जाती है, तो इस कलर ऑब्जेक्ट को एक ही रंग में रेंडर किया जाता है. ऐसा तब होता है, जब अल्फा वैल्यू को साफ़ तौर पर 1.0 की वैल्यू दी गई हो.

DisplayHints

यूज़र इंटरफ़ेस (यूआई) में, किसी विकल्प को रेंडर करने के लिए सलाह दिखती हैं.

JSON के काेड में दिखाना
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
फ़ील्ड
disabled

boolean

यह विकल्प, यूज़र इंटरफ़ेस (यूआई) में बंद के तौर पर दिखेगा या नहीं.

shownInApply

boolean

Drive के किसी आइटम में वैल्यू लागू करते समय, यह विकल्प 'लागू करें' मेन्यू में दिखना चाहिए.

badgeColors

object (BadgeColors)

बैज के लिए इस्तेमाल किए जाने वाले रंग. चुने गए properties.badge_config.color के आधार पर, Google के मटीरियल कलर में बदला गया.

darkBadgeColors

object (BadgeColors)

बैज के लिए, डार्क मोड में इस्तेमाल किया जाने वाला रंग. चुने गए properties.badge_config.color के आधार पर, Google के मटीरियल कलर में बदला गया.

badgePriority

string (int64 format)

इस बैज की प्राथमिकता. इसका इस्तेमाल, एक से ज़्यादा बैज की तुलना करने और उन्हें क्रम से लगाने के लिए किया जाता है. कम संख्या का मतलब है कि बैज पहले दिखाया जाना चाहिए. अगर बैजिंग कॉन्फ़िगरेशन मौजूद नहीं है, तो यह 0 होगा. अगर ऐसा नहीं किया जाता है, तो यह BadgeConfig.priority_override या डिफ़ॉल्ट अनुमानी तरीके पर सेट हो जाएगा. यह तरीका, लेबल बनाने की तारीख और फ़ील्ड और विकल्प की प्राथमिकता को प्राथमिकता देता है.

BadgeColors

BadgeConfig से मिला रंग, जो काम करने वाले रंग के सुझाव के हिसाब से बदला गया है.

JSON के काेड में दिखाना
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
फ़ील्ड
backgroundColor

object (Color)

सिर्फ़ आउटपुट के लिए. बैज का बैकग्राउंड, जो फ़ोरग्राउंड के साथ मैच करता हो.

foregroundColor

object (Color)

सिर्फ़ आउटपुट के लिए. बैज का फ़ोरग्राउंड, जो बैकग्राउंड के साथ जोड़ा जाता है.

soloColor

object (Color)

सिर्फ़ आउटपुट के लिए. बैकग्राउंड के बिना टेक्स्ट के लिए इस्तेमाल किया जा सकने वाला रंग.

SchemaCapabilities

इस विकल्प में बदलाव करते समय, उससे जुड़ी सुविधाएं.

JSON के काेड में दिखाना
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
फ़ील्ड
canUpdate

boolean

उपयोगकर्ता इस विकल्प को अपडेट कर सकता है या नहीं.

canDelete

boolean

उपयोगकर्ता इस विकल्प को मिटा सकता है या नहीं.

canDisable

boolean

उपयोगकर्ता के पास इस विकल्प को बंद करने का विकल्प है या नहीं.

canEnable

boolean

उपयोगकर्ता इस विकल्प को चालू कर सकता है या नहीं.

AppliedCapabilities

लागू किए गए मेटाडेटा पर इस विकल्प से जुड़ी सुविधाएं.

JSON के काेड में दिखाना
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
फ़ील्ड
canRead

boolean

क्या उपयोगकर्ता, आइटम पर लागू किया गया मिलता-जुलता मेटाडेटा पढ़ सकता है.

canSelect

boolean

उपयोगकर्ता किसी आइटम पर यह विकल्प चुन सकता है या नहीं.

LockStatus

इसमें यह जानकारी होती है कि किसी लेबल कॉम्पोनेंट को लॉक किया जाना चाहिए या नहीं.

JSON के काेड में दिखाना
{
  "locked": boolean
}
फ़ील्ड
locked

boolean

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि यह लेबल कॉम्पोनेंट, LabelLock का (डायरेक्ट) टारगेट है या नहीं. किसी लेबल कॉम्पोनेंट को, लेबल लॉक का सीधा टारगेट न होने पर भी लॉक किया जा सकता है. ऐसे में, यह फ़ील्ड 'गलत' पर सेट होता है.

UserOptions

उपयोगकर्ता फ़ील्ड टाइप के विकल्प.

JSON के काेड में दिखाना
{
  "listOptions": {
    object (ListOptions)
  }
}
फ़ील्ड
listOptions

object (ListOptions)

वैल्यू तय करने पर, यह पता चलता है कि इस फ़ील्ड में वैल्यू की सूची इस्तेमाल की जा सकती है. फ़ील्ड पब्लिश होने के बाद, इसे बदला नहीं जा सकता.

प्रॉपर्टी

फ़ील्ड की बुनियादी प्रॉपर्टी.

JSON के काेड में दिखाना
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
फ़ील्ड
displayName

string

ज़रूरी है. इस फ़ील्ड की पहचान करने वाले यूज़र इंटरफ़ेस (यूआई) में दिखाने के लिए डिसप्ले टेक्स्ट.

required

boolean

फ़ील्ड को 'ज़रूरी है' के तौर पर मार्क करना है या नहीं.

insertBeforeField

string

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

DisplayHints

यूज़र इंटरफ़ेस (यूआई), किसी फ़ील्ड को रेंडर करने के लिए सलाह दिखाता है.

JSON के काेड में दिखाना
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
फ़ील्ड
required

boolean

क्या फ़ील्ड को यूज़र इंटरफ़ेस में 'ज़रूरी है' के तौर पर दिखाया जाना चाहिए.

disabled

boolean

यह तय करने के लिए कि यूज़र इंटरफ़ेस (यूआई) में फ़ील्ड को 'बंद है' के तौर पर दिखाया जाए या नहीं.

shownInApply

boolean

Drive के किसी आइटम में वैल्यू लागू करते समय, यह फ़ील्ड 'लागू करें' मेन्यू में दिखना चाहिए.

SchemaCapabilities

फ़ील्ड में बदलाव करते समय, इस फ़ील्ड से जुड़ी सुविधाएं.

JSON के काेड में दिखाना
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
फ़ील्ड
canUpdate

boolean

उपयोगकर्ता इस फ़ील्ड में बदलाव कर सकता है या नहीं.

canDelete

boolean

उपयोगकर्ता इस फ़ील्ड को मिटा सकता है या नहीं. उपयोगकर्ता के पास अनुमति होनी चाहिए और फ़ील्ड को हटा दिया जाना चाहिए.

canDisable

boolean

उपयोगकर्ता इस फ़ील्ड को बंद कर सकता है या नहीं. उपयोगकर्ता के पास अनुमति होनी चाहिए और यह फ़ील्ड पहले से बंद नहीं होना चाहिए.

canEnable

boolean

उपयोगकर्ता इस फ़ील्ड को चालू कर सकता है या नहीं. उपयोगकर्ता के पास अनुमति होनी चाहिए और यह फ़ील्ड बंद होना चाहिए.

AppliedCapabilities

लागू किए गए मेटाडेटा पर इस फ़ील्ड से जुड़ी सुविधाएं.

JSON के काेड में दिखाना
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
फ़ील्ड
canRead

boolean

क्या उपयोगकर्ता, आइटम पर लागू किया गया मिलता-जुलता मेटाडेटा पढ़ सकता है.

canWrite

boolean

उपयोगकर्ता, Drive के आइटम पर यह फ़ील्ड सेट कर सकता है या नहीं.

EnabledAppSettings

Workspace के उन ऐप्लिकेशन के बारे में जानकारी देता है जिनमें लेबल का इस्तेमाल किया जा सकता है.

JSON के काेड में दिखाना
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
फ़ील्ड
enabledApps[]

object (EnabledApp)

ज़रूरी नहीं. उन ऐप्लिकेशन की सूची जिनमें लेबल का इस्तेमाल किया जा सकता है.

EnabledApp

वह ऐप्लिकेशन जहां लेबल का इस्तेमाल किया जा सकता है.

JSON के काेड में दिखाना
{
  "app": enum (App)
}
फ़ील्ड
app

enum (App)

ज़रूरी नहीं. ऐप्लिकेशन का नाम.

ऐप्लिकेशन

Workspace के उन ऐप्लिकेशन का सेट जिनमें लेबल का इस्तेमाल किया जा सकता है.

Enums
APP_UNSPECIFIED जानकारी उपलब्ध नहीं है
DRIVE Drive.
GMAIL Gmail

तरीके

create

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

delete

Drive के आइटम से लेबल और उससे जुड़ा मेटाडेटा हमेशा के लिए मिटा देता है.

delta

अपडेट के अनुरोधों का एक सेट लागू करके, किसी एक लेबल को अपडेट करता है. इससे ड्राफ़्ट में बदलाव होता है.

disable

पब्लिश किए गए किसी लेबल को बंद करना.

enable

बंद किए गए लेबल को चालू करें और उसे पब्लिश की गई स्थिति में वापस लाएं.

get

संसाधन के नाम के आधार पर लेबल पाएं.

list

लेबल की सूची.

publish

ड्राफ़्ट में किए गए सभी बदलावों को लेबल में पब्लिश करें.

updateLabelCopyMode

किसी लेबल का CopyMode अपडेट करता है.

updateLabelEnabledAppSettings

किसी लेबल की EabledAppSettings को अपडेट करता है.

updatePermissions

लेबल की अनुमतियां अपडेट करता है.