資源:結構定義
API 資源的類型。對結構定義資源而言,這個項目一律為 admin#directory#schema
。
JSON 表示法 |
---|
{
"schemaId": string,
"schemaName": string,
"fields": [
{
object ( |
欄位 | |
---|---|
schemaId |
結構定義的專屬 ID (唯讀) |
schemaName |
結構定義的名稱。 每個 |
fields[] |
結構定義中的欄位清單。 |
displayName |
結構定義的顯示名稱。 |
kind |
資源類型。 |
etag |
資源的 ETag。 |
SchemaFieldSpec
您可以使用結構定義,在使用者設定檔中新增自訂欄位。您可以用這些欄位儲存資訊,例如使用者處理的專案、實際位置、聘僱日期,或是符合業務需求的任何資訊。詳情請參閱「自訂使用者欄位」。
JSON 表示法 |
---|
{ "fieldName": string, "fieldId": string, "fieldType": string, "multiValued": boolean, "kind": string, "etag": string, "indexed": boolean, "displayName": string, "readAccessType": string, "numericIndexingSpec": { "minValue": number, "maxValue": number } } |
欄位 | |
---|---|
fieldName |
欄位名稱。 |
fieldId |
欄位的專屬 ID (唯讀) |
fieldType |
欄位的類型。 可接受的值為:
|
multiValued |
布林值,指定此欄位是否為多值欄位。預設值: |
kind |
這個項目的資源類型。對結構定義欄位而言,這個項目一律為 |
etag |
欄位的 ETag。 |
indexed |
指定該欄位是否編入索引的布林值。預設值: |
displayName |
欄位的顯示名稱。 |
readAccessType |
指定哪些使用者可以查看這個欄位的值。詳情請參閱「以非管理員身分擷取使用者資料」。 注意:這個欄位的變更最多可能需要 24 小時才會生效。 可接受的值如下:
|
numericIndexingSpec |
數值欄位的索引規格。根據預設,數值欄位僅支援完全比對查詢。設定 |
numericIndexingSpec.minValue |
這個欄位的最小值。這項規定僅供參考,並非強制規定。系統仍會為超出範圍的值建立索引,但搜尋成效可能不如預期。 |
numericIndexingSpec.maxValue |
這個欄位的最大值。這項規定僅供參考,並非強制規定。系統仍會為超出這個範圍的值建立索引,但搜尋功能的效能可能會降低。 |
方法 |
|
---|---|
|
刪除結構定義。 |
|
擷取結構定義。 |
|
建立結構定義。 |
|
擷取客戶的所有結構定義。 |
|
修補結構定義。 |
|
更新結構定義。 |