REST Resource: schemas

Kaynak: Şema

API kaynağının türü. Şema kaynakları için bu değer 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ı yeniden kullanmak 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 kaynağın türü.
etag

string

Kaynağın ETag'ı.

SchemaFieldSpec

Şemaları kullanarak kullanıcı profillerine özel alanlar ekleyebilirsiniz. Bu alanları, kullanıcılarınızın üzerinde çalıştığı projeler, fiziksel konumları, işe alınma tarihleri veya işletmenizin ihtiyaçlarına uygun diğer bilgileri depolamak için kullanabilirsiniz. Daha fazla bilgi için Özel Kullanıcı Alanları başlıklı makaleyi inceleyin.

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 edilen değerler şunlardır:

  • BOOL: Boole değerleri.
  • DATE: ISO-8601 biçimindeki tarihler.
  • DOUBLE: Çift hassasiyetli 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 çok değerli bir alan olup olmadığını belirten bir boole değeri. Varsayılan: false.
kind

string

Bu kaynağın türü. Şema alanları için bu her zaman admin#directory#schema#fieldspec olur.
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 Yönetici olmayan kullanıcıları alma başlıklı makaleyi inceleyin.

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

Kabul edilen değerler şunlardır:

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

object

Sayısal bir alan için dizine ekleme spesifikasyonu. Varsayılan olarak, sayısal alanlar için yalnızca tam eşleme sorguları desteklenir. numericIndexingSpec ayarlandığında aralık sorguları desteklenir.
numericIndexingSpec.minValue

number

Bu alanın minimum değeri. Bu, zorunluluk yerine fikir verici bir amaç taşır. Bu aralık dışındaki değerler yine dizine eklenir ancak arama performansı aynı olmayabilir.
numericIndexingSpec.maxValue

number

Bu alanın maksimum değeri. Bu, zorunluluk yerine fikir verici bir amaç taşır. Bu aralık dışındaki değerler yine dizine eklenir ancak arama performansı aynı olmayabilir.

Yöntemler

delete

 Şemayı siler.

get

 Bir şema alır.

insert

 Şema oluşturur.

list

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

patch

 Bir şemaya yama uygular.

update

 Bir şemayı günceller.