REST Resource: schemas

リソース: スキーマ

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。

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

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

string

フィールドのタイプ。

有効な値は次のとおりです。

  • BOOL: ブール値。
  • DATE: ISO-8601 形式の日付。
  • DOUBLE: 倍精度浮動小数点値。
  • EMAIL: メールアドレス。
  • INT64: 64 ビット整数値。
  • PHONE: 電話番号。
  • STRING: 文字列値。
multiValued

boolean

複数値を持つフィールドかどうかを指定するブール値。デフォルト
kind

string

リソースの種類。スキーマ フィールドの場合、これは常に admin#directory#schema#fieldspec です。
etag

string

フィールドの ETag。
indexed

boolean

フィールドがインデックスに登録されるかどうかを指定するブール値。デフォルト
displayName

string

フィールドの表示名。
readAccessType

string

このフィールドの値を表示できるユーザーを指定します。詳細については、管理者以外のユーザーを取得するをご覧ください。

注: このフィールドの変更が反映されるまでに、最長で 24 時間かかることがあります。

有効な値は次のとおりです。

  • ADMINS_AND_SELF: 管理者と関連付けられたユーザーのみが値を表示できます。
  • ALL_DOMAIN_USERS: ドメイン内のすべてのユーザーが値を閲覧できます。
numericIndexingSpec

object

数値フィールドのインデックス登録の仕様。デフォルトでは、数値フィールドでは完全一致クエリのみがサポートされます。numericIndexingSpec を設定すると、範囲クエリをサポートできます。
numericIndexingSpec.minValue

number

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

number

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

Methods

delete

 スキーマを削除します。

get

 スキーマを取得します。

insert

 スキーマを作成します。

list

 顧客のすべてのスキーマを取得します。

patch

 スキーマにパッチを適用します。

update

 スキーマを更新します。