REST Resource: schemas

Kaynak: Şema

API kaynağının türü. Şema kaynakları için bu her zaman admin#directory#schema olur.

JSON gösterimi 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Alanlar
schemaId

string

Şemanın benzersiz tanımlayıcısı (Salt okunur)
schemaName

string

Şemanın adı.

Her schemaName, müşteri içinde benzersiz olmalıdır. Bir adın yeniden kullanılması 409: Entity already exists hatasına neden olur.
fields[]

object (SchemaFieldSpec)

Şemadaki alanların listesi.
displayName

string

Şemanın görünen adı.
kind

string

Bu, bir tür kaynak.
etag

string

Kaynağın ETag'idir.

SchemaFieldSpec

Kullanıcı profillerine özel alanlar eklemek için şemaları kullanabilirsiniz. Bu alanları, kullanıcılarınızın üzerinde çalıştığı projeler, fiziksel konumları, işe alma tarihleri veya işletmenizin ihtiyaçlarına uygun herhangi bir şey gibi bilgileri depolamak için kullanabilirsiniz. Daha fazla bilgi için Özel Kullanıcı Alanları bölümüne bakın.

JSON gösterimi 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
Alanlar
fieldName

string

Alanın adı.
fieldId

string

Alanın benzersiz tanımlayıcısı (Salt okunur)
fieldType

string

Alanın türü.

Kabul edilebilir değerler şunlardır:

  • BOOL: Boole değerleri.
  • DATE: ISO-8601 biçimindeki tarihler.
  • DOUBLE: Çift duyarlıklı kayan nokta değerleri.
  • EMAIL: E-posta adresleri.
  • INT64: 64 bit tam sayı değerleri.
  • PHONE: Telefon numaraları.
  • STRING: Dize değerleri.
multiValued

boolean

Bunun birden çok değerli bir alan olup olmadığını belirten boole değeri. Varsayılan: false.
kind

string

Bunun kaynak türü. Şema alanları için her zaman admin#directory#schema#fieldspec değeri kullanılır.
etag

string

Alanın ETag.
indexed

boolean

Alanın dizine eklenip eklenmediğini belirten boole değeri. Varsayılan: true.
displayName

string

Alanın Görünen Adı.
readAccessType

string

Bu alanın değerlerini kimlerin görüntüleyebileceğini belirtir. Daha fazla bilgi için Kullanıcıları yönetici olmayan kullanıcı olarak alma başlıklı makaleyi inceleyin.

Not: Bu alanda yapılan değişikliklerin yansıtılması 24 saati bulabilir.

Kabul edilebilir değerler şunlardır:

  • ADMINS_AND_SELF: Değerleri yalnızca yöneticiler ve ilişkili kullanıcı görebilir.
  • ALL_DOMAIN_USERS: Alanınızdaki tüm kullanıcılar değerleri görebilir.
numericIndexingSpec

object

Sayısal alan için dizine ekleme spesifikasyonu. Varsayılan olarak sayısal alanlar için yalnızca tam eşleme sorguları desteklenir. numericIndexingSpec ayarlamak, aralık sorgularının desteklenmesine olanak tanır.
numericIndexingSpec.minValue

number

Bu alanın minimum değeri. Bu, yaptırımdan ziyade gösterge niteliğindedir. Bu aralığın dışındaki değerler dizine eklenmeye devam eder ancak arama o kadar etkili olmayabilir.
numericIndexingSpec.maxValue

number

Bu alanın maksimum değeri. Bu, yaptırımdan ziyade gösterge niteliğindedir. Bu aralığın dışındaki değerler dizine eklenmeye devam eder ancak arama o kadar etkili olmayabilir.

Yöntemler

delete

 Bir şemayı siler.

get

 Bir şema alır.

insert

 Şema oluşturur.

list

 Bir müşterinin tüm şemalarını alır.

patch

 Şemaya yama uygular.

update

 Bir şemayı günceller.