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

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