REST Resource: schemas

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

string

スキーマの一意の識別子（読み取り専用）

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

フィールドの一意の識別子（読み取り専用）

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

このフィールドの最大値。これは強制ではなく、あくまでも目安です。この範囲外の値はインデックスに登録されますが、検索のパフォーマンスは低下する可能性があります。