REST Resource: schemas

資源：結構定義

API 資源的類型。對於結構定義資源，這個項目一律為 admin#directory#schema。

JSON 表示法 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
欄位
schemaId

string

結構定義的專屬 ID (唯讀)
schemaName

string

結構定義的名稱。

同一個客戶中的每個 schemaName 皆不得重複。重複使用名稱會導致 409: Entity already exists 錯誤。
fields[]

object (SchemaFieldSpec)

結構定義中的欄位清單。
displayName

string

結構定義的顯示名稱。
kind

string

資源種類。
etag

string

資源的 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

string

欄位名稱。
fieldId

string

欄位的專屬 ID (唯讀)
fieldType

string

欄位類型。

可接受的值為：

  • BOOL：布林值。
  • DATE：採用 ISO-8601 格式的日期。
  • DOUBLE：雙精度浮點值。
  • EMAIL：電子郵件地址。
  • INT64：64 位元整數值。
  • PHONE：電話號碼。
  • STRING：字串值。
multiValued

boolean

指定是否為多值欄位的布林值。預設值：false。
kind

string

資源的種類。在結構定義欄位中，這項屬性一律為 admin#directory#schema#fieldspec。
etag

string

欄位的 ETag。
indexed

boolean

指定該欄位是否編入索引的布林值。預設值：true。
displayName

string

欄位的顯示名稱。
readAccessType

string

指定哪些使用者可以查看這個欄位的值。詳情請參閱擷取使用者為非管理員一文。

注意：這個欄位的變更最多可能需要 24 小時才會生效。

可接受的值為：

  • ADMINS_AND_SELF：只有管理員和相關的使用者可以查看值。
  • ALL_DOMAIN_USERS：網域中的所有使用者皆可查看值。
numericIndexingSpec

object

數值欄位的索引規格。根據預設，數值欄位僅支援完全比對查詢。設定 numericIndexingSpec 即可支援範圍查詢。
numericIndexingSpec.minValue

number

這個欄位的最小值。僅供參考，而非強制執行。系統仍會為超出範圍的值建立索引，但搜尋成效可能不如預期。
numericIndexingSpec.maxValue

number

這個欄位的最大值。僅供參考，而非強制執行。系統仍會為超出範圍的值建立索引，但搜尋成效可能不如預期。

方法

delete

 刪除結構定義。

get

 擷取結構定義。

insert

 建立結構定義。

list

 擷取客戶的所有結構定義。

patch

 修補結構定義。

update

 更新結構定義。