REST Resource: schemas

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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