REST Resource: schemas

{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}

string

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

string

結構定義的名稱。

客戶中的每個 schemaName 都不得重複。重複使用名稱會導致 409: Entity already exists 錯誤。

object (SchemaFieldSpec)

結構定義中的欄位清單。

string

結構定義的顯示名稱。

string

此為資源種類。

string

資源的 ETag。

{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}

string

欄位名稱。

string

欄位的專屬 ID (唯讀)

string

欄位的類型，

可接受的值為：

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

boolean

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

string

此為資源種類。如果是結構定義欄位，一律為 admin#directory#schema#fieldspec。

string

欄位的 ETag。

boolean

布林值，用於指定該欄位是否編入索引。預設值：true。

string

欄位的顯示名稱。

string

指定誰可以查看這個欄位的值。詳情請參閱「以非管理員的身分擷取使用者」一文。

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

可接受的值為：

• ADMINS_AND_SELF：只有管理員和相關聯的使用者才能查看值。
• ALL_DOMAIN_USERS：網域中所有使用者都能查看值。

object

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

number

這個欄位的最小值。這麼做是為了指示使用者而非強制實行，系統還是會為超出這個範圍的值建立索引，但搜尋成效可能不彰。

number

這個欄位的最大值。這麼做是為了指示使用者而非強制實行，系統還是會為超出這個範圍的值建立索引，但搜尋成效可能不彰。