REST Resource: schemas

संसाधन: स्कीमा

एपीआई रिसॉर्स का टाइप. स्कीमा संसाधनों के लिए, यह हमेशा admin#directory#schema होता है.

JSON के काेड में दिखाना 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
फ़ील्ड
schemaId

string

स्कीमा का यूनीक आइडेंटिफ़ायर (सिर्फ़ पढ़ने के लिए)
schemaName

string

स्कीमा का नाम.

किसी ग्राहक के लिए, हर schemaName अलग होना चाहिए. किसी नाम का दोबारा इस्तेमाल करने से 409: Entity already exists गड़बड़ी होती है.
fields[]

object (SchemaFieldSpec)

स्कीमा में फ़ील्ड की सूची.
displayName

string

स्कीमा के लिए डिसप्ले नेम.
kind

string

यह एक तरह का संसाधन है.
etag

string

संसाधन का ETag.

SchemaFieldSpec

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

JSON के काेड में दिखाना 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
फ़ील्ड
fieldName

string

फ़ील्ड का नाम.
fieldId

string

फ़ील्ड का यूनीक आइडेंटिफ़ायर (सिर्फ़ पढ़ने के लिए)
fieldType

string

फ़ील्ड का टाइप.

ये वैल्यू स्वीकार की जाती हैं:

  • BOOL: बूलियन वैल्यू.
  • DATE: ISO-8601 फ़ॉर्मैट में तारीख.
  • DOUBLE: डबल-प्रीसिज़न फ़्लोटिंग-पॉइंट वैल्यू.
  • EMAIL: ईमेल पते.
  • INT64: 64-बिट पूर्णांक वैल्यू.
  • PHONE: फ़ोन नंबर.
  • STRING: स्ट्रिंग की वैल्यू.
multiValued

boolean

यह एक बूलियन है, जिससे यह पता चलता है कि यह कई वैल्यू वाला फ़ील्ड है या नहीं. डिफ़ॉल्ट: false.
kind

string

यह किस तरह का संसाधन है. स्कीमा फ़ील्ड के लिए, यह हमेशा admin#directory#schema#fieldspec होता है.
etag

string

फ़ील्ड का ETag.
indexed

boolean

बूलियन, जिससे यह पता चलता है कि फ़ील्ड को इंडेक्स किया गया है या नहीं. डिफ़ॉल्ट: true.
displayName

string

फ़ील्ड का डिसप्ले नेम.
readAccessType

string

इससे पता चलता है कि इस फ़ील्ड की वैल्यू कौन देख सकता है. ज़्यादा जानकारी के लिए, उपयोगकर्ताओं को गैर-एडमिन के तौर पर वापस लाना देखें.

ध्यान दें: इस फ़ील्ड में किए गए बदलाव दिखने में 24 घंटे लग सकते हैं.

ये वैल्यू स्वीकार की जाती हैं:

  • ADMINS_AND_SELF: सिर्फ़ एडमिन और उससे जुड़े उपयोगकर्ता ही वैल्यू देख सकते हैं.
  • ALL_DOMAIN_USERS: आपके डोमेन में मौजूद कोई भी उपयोगकर्ता, वैल्यू देख सकता है.
numericIndexingSpec

object

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

number

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

number

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

तरीके

delete

 स्कीमा मिटाता है.

get

 स्कीमा हासिल करता है.

insert

 स्कीमा बनाता है.

list

 किसी ग्राहक के लिए सभी स्कीमा हासिल करता है.

patch

 स्कीमा को पैच करता है.

update

 स्कीमा को अपडेट करता है.