REST Resource: schemas

Resource: Schema

Jenis resource API. Untuk resource Schema, nilainya selalu admin#directory#schema.

Representasi JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Kolom
schemaId

string

ID unik skema (Hanya baca)
schemaName

string

Nama skema.

Setiap schemaName harus unik dalam satu pelanggan. Menggunakan kembali nama akan menghasilkan error 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Daftar kolom dalam skema.
displayName

string

Nama tampilan untuk skema.
kind

string

Jenis resource ini.
etag

string

ETag resource.

SchemaFieldSpec

Anda dapat menggunakan skema untuk menambahkan kolom kustom ke profil pengguna. Anda dapat menggunakan kolom ini untuk menyimpan informasi seperti project yang dikerjakan pengguna, lokasi fisik mereka, tanggal mereka dipekerjakan, atau apa pun yang sesuai dengan kebutuhan bisnis Anda. Untuk informasi selengkapnya, lihat Kolom Pengguna Kustom.

Representasi JSON 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
Kolom
fieldName

string

Nama kolom.
fieldId

string

ID unik kolom (Hanya baca)
fieldType

string

Jenis kolom.

Nilai yang dapat diterima adalah:

  • BOOL: Nilai boolean.
  • DATE: Tanggal dalam format ISO-8601.
  • DOUBLE: Nilai floating point presisi ganda.
  • EMAIL: Alamat email.
  • INT64: Nilai bilangan bulat 64-bit.
  • PHONE: Nomor telepon.
  • STRING: Nilai string.
multiValued

boolean

Boolean yang menentukan apakah ini adalah kolom multinilai atau bukan. Default: false.
kind

string

Jenis resource ini. Untuk kolom skema, nilainya selalu admin#directory#schema#fieldspec.
etag

string

ETag kolom.
indexed

boolean

Boolean yang menentukan apakah kolom diindeks atau tidak. Default: true.
displayName

string

Nama Tampilan kolom.
readAccessType

string

Menentukan siapa yang dapat melihat nilai kolom ini. Lihat Mengambil pengguna sebagai non-administrator untuk mengetahui informasi selengkapnya.

Catatan: Mungkin perlu waktu hingga 24 jam agar perubahan pada kolom ini ditampilkan.

Nilai yang dapat diterima adalah:

  • ADMINS_AND_SELF: Hanya administrator dan pengguna terkait yang dapat melihat nilai.
  • ALL_DOMAIN_USERS: Semua pengguna di domain Anda dapat melihat nilai.
numericIndexingSpec

object

Spesifikasi pengindeksan untuk kolom numerik. Secara default, hanya kueri pencocokan persis yang akan didukung untuk kolom numerik. Menetapkan numericIndexingSpec memungkinkan kueri rentang didukung.
numericIndexingSpec.minValue

number

Nilai minimum kolom ini. Hal ini dimaksudkan untuk menjadi indikasi, bukan diterapkan. Nilai di luar rentang ini akan tetap diindeks, tetapi penelusuran mungkin tidak berperforma baik.
numericIndexingSpec.maxValue

number

Nilai maksimum kolom ini. Hal ini dimaksudkan sebagai indikasi, bukan diberlakukan. Nilai di luar rentang ini akan tetap diindeks, tetapi penelusuran mungkin tidak berperforma baik.

Metode

delete

 Menghapus skema.

get

 Mengambil skema.

insert

 Membuat skema.

list

 Mengambil semua skema untuk pelanggan.

patch

 Menerapkan patch ke skema.

update

 Memperbarui skema.