REST Resource: schemas

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

资源:Schema

API 资源类型。对于架构资源,此字段始终为 admin#directory#schema

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

string

架构的唯一标识符(只读)

schemaName

string

架构的名称。

每个 schemaName 在客户中必须是唯一的。重复使用名称会导致 409: Entity already exists 错误。

fields[]

object (SchemaFieldSpec)

架构中的字段列表。

displayName

string

架构的显示名。

kind

string

此资源的种类。

etag

string

资源的 ETag。

架构字段规范

您可以使用架构向用户个人资料添加自定义字段。您可以使用这些字段来存储信息,例如用户所处理的项目、用户的实际位置、聘用日期或满足业务需求的任何其他信息。如需了解详情,请参阅自定义用户字段

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

字段的唯一标识符(只读)

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

更新架构。