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
}
Các trường
schemaId

string

Giá trị nhận dạng duy nhất của giản đồ (Chỉ đọ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ị cho giản đồ.
kind

string

Đây là một loại tài nguyên.
etag

string

Thẻ ETag của tài nguyên.

SchemaFieldSpec

Bạn có thể dùng giản đồ để thêm các 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ư những dự án mà người dùng thực hiện, vị trí thực tế, ngày thuê của họ hoặc bất cứ 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 người dùng tuỳ chỉnh.

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
  }
}
Các 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)
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 có nhiều giá trị hay không. Mặc định: false.
kind

string

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

string

Thẻ ETag của trường.
indexed

boolean

Boolean chỉ định liệu 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 người có thể xem các giá trị của trường này. Hãy xem phần Truy xuất người dùng với tư cách không phải quản trị viên để biết thêm thông tin.

Lưu ý: Có thể mất đến 24 giờ để hệ thống cập nhật những thay đổi đối với trường này.

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ể thấy các giá trị.
  • ALL_DOMAIN_USERS: Bất kỳ người dùng nào 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 một 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ợ các truy vấn phạm vi.
numericIndexingSpec.minValue

number

Giá trị nhỏ nhất của trường này. Điều này nhằm mục đích tham khảo thay vì 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 hoạt động tìm kiếm có thể không hiệu quả.
numericIndexingSpec.maxValue

number

Giá trị tối đa của trường này. Điều này nhằm mục đích tham khảo thay vì 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 hoạt động tìm kiếm có thể không hiệu quả.

Phương thức

delete

 Xoá giản đồ.

get

 Truy xuất một giản đồ.

insert

 Tạo một 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 một giản đồ.