REST Resource: schemas

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

string

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

string

スキーマ名。

各 schemaName は 1 つの顧客内で一意である必要があります。名前を再利用すると、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

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