資源:結構定義
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 |
這個欄位的最大值。這麼做是為了指示使用者而非強制實行,系統還是會為超出這個範圍的值建立索引,但搜尋成效可能不彰。 |
方法 |
|
---|---|
|
刪除結構定義。 |
|
擷取結構定義。 |
|
建立結構定義。 |
|
擷取客戶的所有結構定義。 |
|
修補結構定義。 |
|
更新結構定義。 |