REST Resource: schemas

Tài nguyên: Giản đồ

Loại tài nguyên API. Đối với tài nguyên Giản đồ, giá trị này luôn là admin#directory#schema.

Biểu diễn dưới dạng JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Trường
schemaId

string

Giá trị nhận dạng duy nhất của giản đồ (Chỉ có thể đọc)
schemaName

string

Tên của giản đồ.

Mỗi schemaName phải là duy nhất trong một khách hàng. Việc sử dụng lại tên sẽ dẫn đến lỗi 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Danh sách các trường trong giản đồ.
displayName

string

Tên hiển thị của giản đồ.
kind

string

Loại tài nguyên này.
etag

string

ETag của tài nguyên.

SchemaFieldSpec

Bạn có thể sử dụng giản đồ để thêm trường tuỳ chỉnh vào hồ sơ người dùng. Bạn có thể sử dụng các trường này để lưu trữ thông tin, chẳng hạn như dự án mà người dùng làm việc, vị trí thực tế, ngày thuê của họ hoặc bất kỳ thông tin nào khác phù hợp với nhu cầu kinh doanh của bạn. Để biết thêm thông tin, hãy xem bài viết Trường tuỳ chỉnh của người dùng.

Biểu diễn dưới dạng JSON 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
Trường
fieldName

string

Tên của trường.
fieldId

string

Giá trị nhận dạng duy nhất của trường (Chỉ có thể đọc)
fieldType

string

Loại trường.

Các giá trị được chấp nhận là:

  • BOOL: Giá trị boolean.
  • DATE: Ngày ở định dạng ISO-8601.
  • DOUBLE: Giá trị dấu phẩy động có độ chính xác gấp đôi.
  • EMAIL: Địa chỉ email.
  • INT64: Giá trị số nguyên 64 bit.
  • PHONE: Số điện thoại.
  • STRING: Giá trị chuỗi.
multiValued

boolean

Giá trị boolean chỉ định liệu đây có phải là trường nhiều giá trị hay không. Mặc định: false.
kind

string

Loại tài nguyên này. Đối với các trường giản đồ, loại này luôn là admin#directory#schema#fieldspec.
etag

string

ETag của trường.
indexed

boolean

Giá trị Boolean chỉ định xem trường có được lập chỉ mục hay không. Mặc định: true.
displayName

string

Tên hiển thị của trường.
readAccessType

string

Chỉ định những người có thể xem giá trị của trường này. Hãy xem bài viết Truy xuất người dùng khi không phải là quản trị viên để biết thêm thông tin.

Lưu ý: Có thể mất đến 24 giờ thì các thay đổi đối với trường này mới được thể hiện.

Các giá trị được chấp nhận là:

  • ADMINS_AND_SELF: Chỉ quản trị viên và người dùng được liên kết mới có thể xem giá trị.
  • ALL_DOMAIN_USERS: Mọi người dùng trong miền của bạn đều có thể xem các giá trị.
numericIndexingSpec

object

Thông số lập chỉ mục cho trường số. Theo mặc định, chỉ các truy vấn khớp chính xác mới được hỗ trợ cho các trường số. Việc đặt numericIndexingSpec cho phép hỗ trợ truy vấn phạm vi.
numericIndexingSpec.minValue

number

Giá trị tối thiểu của trường này. Quy định này nhằm mục đích cung cấp thông tin chứ không phải để thực thi. Các giá trị nằm ngoài phạm vi này vẫn sẽ được lập chỉ mục, nhưng tính năng tìm kiếm có thể không hoạt động hiệu quả.
numericIndexingSpec.maxValue

number

Giá trị tối đa của trường này. Đây là thông tin tham khảo chứ không phải quy định bắt buộc. Các giá trị nằm ngoài phạm vi này vẫn sẽ được lập chỉ mục, nhưng tính năng tìm kiếm có thể không hoạt động hiệu quả.

Phương thức

delete

 Xoá giản đồ.

get

 Truy xuất giản đồ.

insert

 Tạo giản đồ.

list

 Truy xuất tất cả giản đồ cho một khách hàng.

patch

 Vá một giản đồ.

update

 Cập nhật giản đồ.