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 ( |
Các trường | |
---|---|
schemaId |
Giá trị nhận dạng duy nhất của giản đồ (Chỉ đọc) |
schemaName |
Tên của giản đồ. Mỗi |
fields[] |
Danh sách các trường trong giản đồ. |
displayName |
Tên hiển thị cho giản đồ. |
kind |
Đây là một loại tài nguyên. |
etag |
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 |
Tên của trường. |
fieldId |
Giá trị nhận dạng duy nhất của trường (Chỉ đọc) |
fieldType |
Loại trường. Các giá trị được chấp nhận là:
|
multiValued |
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: |
kind |
Đâ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à |
etag |
Thẻ ETag của trường. |
indexed |
Boolean chỉ định liệu trường có được lập chỉ mục hay không. Mặc định: |
displayName |
Tên hiển thị của trường. |
readAccessType |
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à:
|
numericIndexingSpec |
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.minValue |
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 |
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 |
|
---|---|
|
Xoá giản đồ. |
|
Truy xuất một giản đồ. |
|
Tạo một giản đồ. |
|
Truy xuất tất cả giản đồ cho một khách hàng. |
|
vá một giản đồ. |
|
Cập nhật một giản đồ. |