このページは Cloud Translation API によって翻訳されました。

カスタムユーザーフィールドの管理

ドメインのユーザーにカスタムフィールドを定義するには、ドメインにカスタムユーザースキーマを追加します。これらのフィールドには、ユーザーが取り組んでいるプロジェクト、ユーザーの所在地、雇用日など、ビジネスニーズに合った情報を格納できます。

まず、1 つ以上のスキーマを作成して、ドメインに適したカスタムフィールドを定義します。フィールドの名前、型（文字列、ブール値、整数など）、値が単一か複数か、その値をドメイン内のすべてのユーザーが表示できるようにするか、管理者と関連するユーザーのみが表示できるようにするかなど、複数の属性を指定できます。

スキーマを定義すると、カスタムフィールドは標準フィールドと同様に動作します。これらは、ドメインのユーザーを更新するときに設定できます。また、users.get と users.list で取得することもできます。また、カスタムフィールドを検索することもできます。

ユーザープロフィールのカスタムフィールドを設定する

スキーマを更新または作成するには、customSchemas プロパティを作成してユーザーリソースに追加します。customSchemas プロパティ内では、カスタムフィールドは標準 JSON 形式でスキーマごとにグループ化されます。

"customSchemas": {
  "schema1": {
    "field1": "value1",
    "field2": [
      { "value": "value2a" },
      { "value": "value2b" },
      ...
    ],
    ...
  },
  "schema2": {
    "field3": "value3",
    ...
  },
  ...
}

単一値のカスタムフィールドは、"field1": "value1" のような単純な Key-Value ペアとして設定されます。複数の値を持つカスタムフィールドは、API の標準の複数値フィールド（addresses や phones など）と同様に、オブジェクトの配列として設定されます。これらの値オブジェクトは、次のキーをサポートします。

キー
`value`	格納される値（必須）。
`type`	値の型（省略可）。有効な値は次のとおりです。 `custom` `home` `other` `work`
`customType`	値のカスタムタイプ（省略可）。`type` が `custom` に設定されている場合に使用する必要があります。

更新時にスキーマ内のカスタムフィールドが指定されていない場合、変更されません。更新時に customFields でスキーマ自体が指定されていない場合、そのスキーマ内のすべてのカスタムフィールドは変更されません。プロファイルからカスタムフィールドまたはカスタムスキーマを削除するには、明示的に null に設定する必要があります。

"schema1": {
  "field1": null // deletes field1 from this profile.
}

JSON リクエスト

次の例の呼び出しでは、ユーザーを更新し、employmentData カスタムスキーマの値を設定します。

PATCH https://admin.googleapis.com/admin/directory/v1/users/liz@example.com

{
  "customSchemas": {
    "employmentData": {
      "employeeNumber": "123456789",
      "jobFamily": "Engineering"
      "location": "Atlanta",
      "jobLevel": 8,
      "projects": [
        { "value": "GeneGnome" },
        { "value": "Panopticon", "type": "work" },
        { "value": "MegaGene", "type": "custom", "customType": "secret" }
      ]
    }
  }
}

ユーザープロフィールのカスタムフィールドを読み取る

ユーザープロフィールのカスタムフィールドを取得するには、users.get リクエストまたは users.list リクエストの projection パラメータを custom または full に設定します。

ユーザープロフィールのカスタムフィールドを検索する

users.list リクエストに query パラメータを使用すると、カスタムフィールド内を検索できます。カスタムフィールドは schemaName.fieldName 構文でリクエストします。次に例を示します。

employmentData.projects:"GeneGnome"

はプロジェクト GeneGnome に従事するすべての従業員を返します。クエリ

employmentData.location="Atlanta" employmentData.jobLevel>=7

ジョブレベル 7 を超えるアトランタのすべての従業員を返します。詳細については、ユーザーを検索するをご覧ください。

カスタムユーザースキーマを作成する

カスタムユーザースキーマは、Google Workspace アカウントのすべてのドメインに追加できます。ドメインにカスタムユーザースキーマを作成するには、次の POST リクエストを使用し、リクエストを承認するで説明されている承認を含めます。リクエストのクエリ文字列のプロパティについては、API リファレンスをご覧ください。

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/schemas

すべての作成リクエストで、リクエストの処理に必要な情報を送信する必要があります。クライアントライブラリを使用している場合は、選択した言語のデータオブジェクトが JSON データ形式のオブジェクトに変換されます。

JSON リクエスト

次のサンプルは、カスタムスキーマを作成するリクエストを示しています。リクエストとレスポンスのプロパティの全一覧については、API リファレンスをご覧ください。

{
  "schemaName": "employmentData",
  "fields": [
    {
      "fieldName": "EmployeeNumber",
      "fieldType": "STRING",
      "multiValued": "false"
    },
    {
      "fieldName": "JobFamily",
      "fieldType": "STRING",
      "multiValued": "false"
    }
  ]
}

成功すると、HTTP 201 ステータスコードと新しいカスタムスキーマのプロパティが返されます。

カスタムスキーマの上限

1 つのアカウントで許容されるカスタムスキーマの最大数は 100 です。
1 つのアカウントで指定できるカスタムフィールドの最大数は 100 です。
単一値のカスタムフィールドの string フィールドに指定できる最大文字数は 500 です。複数の値を持つカスタムフィールドの場合、使用できる要素の数は、割り当てられた値のサイズによって異なります。たとえば、それぞれ 100 文字の値を 150 個、またはそれぞれ 500 文字の値を 50 個追加できます。
カスタムスキーマとフィールド名に使用できる文字は、英数字、アンダースコア（_）、ハイフン（-）です。
フィールドのタイプは変更できません。
単一値のフィールドを複数の値にできますが、その逆の操作は許可されません。
カスタムスキーマまたはカスタムフィールドの名前は変更できません。

カスタムユーザースキーマを更新する

カスタムスキーマを更新するには、次の PUT リクエストを使用し、リクエストを承認するで説明されている承認を含めます。schemaKey には、スキーマ名または一意のスキーマ id を指定できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/schemas/schemaKey

JSON リクエスト

以下の例では、最初に作成されたときにスキーマ employmentData に JobFamily フィールドが含まれていました。このリクエストは、EmployeeNumber フィールドのみを含むように employmentData を更新します。

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/schemas/employmentData

{
  "kind": "admin#directory#schema",
  "schemaId": "dKaYmUwmSZy5lreXyh75hQ==",
  "etag": "\"St7vIdePbbDsQUvvrssynd-6JLg/PKg63GvWb7bnVSNRomd_O-Vi66w\"",
  "schemaName": "employmentData",
  "fields": [
    {
      "kind": "admin#directory#schema#fieldspec",
      "fieldId": "21_B4iQIRY-dIFGFgAX-Og==",
      "etag": "\"St7vIdePbbDsQUvvrssynd-6JLg/LZxiGaz6_N4R40OpKbDhOcy2qiE\"",
      "fieldType": "STRING",
      "fieldName": "EmployeeNumber",
      "multiValued": "false"
    }
  ]
}

すべての更新リクエストでは、そのリクエストを満たすために必要な情報を送信する必要があります。

成功すると、HTTP 200 ステータスコードと更新されたスキーマリソースが返されます。

カスタムユーザースキーマを取得する

カスタムスキーマを取得するには、次の GET リクエストを使用し、リクエストを承認するで説明されている承認を含めます。schemaKey には、スキーマ名または一意のスキーマ id を指定できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/schemas/schemaKey

成功すると、HTTP 200 ステータスコードとカスタムスキーマのプロパティが返されます。

{
  "kind": "admin#directory#schema",
  "schemaId": "dKaYmUwmSZy5lreXyh75hQ==",
  "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/PKg63GvWb7bnVSNRomd_O-Vi66w\"",
  "schemaName": "employmentData",
  "fields": [
    {
      "kind": "admin#directory#schema#fieldspec",
      "fieldId": "21_B4iQIRY-dIFGFgAX-Og==",
      "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/LZxiGaz6_N4R40OpKbDhOcy2qiE\"",
      "fieldType": "STRING",
      "fieldName": "EmployeeNumber"
    },
    {
      "kind": "admin#directory#schema#fieldspec",
      "fieldId": "ZKy0QtoMRy2QlM-4sAsPtQ==",
      "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/jEULI-ZiqywQIHXgc8evEcTE4Cc\"",
      "fieldType": "STRING",
      "fieldName": "JobFamily"
    }
  ]
}

すべてのカスタムユーザースキーマを取得する

同じアカウント内のカスタムスキーマをすべて取得するには、次の GET リクエストを使用し、その際にはリクエストの承認で説明されている承認を含めます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/schemas

成功すると、HTTP 200 ステータスコードとアカウントのカスタムスキーマが返されます。

{
  "kind": "admin#directory#schemas",
  "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/iJ1eWn5AKuR-xTdwH_2IBlvSSKo\"",
  "schemas": [
    {
      "kind": "admin#directory#schema",
      "schemaId": "dKaYmUwmSZy5lreXyh75hQ==",
      "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/PKg63GvWb7bnVSNRomd_O-Vi66w\"",
      "schemaName": "employmentData",
      "fields": [
        {
          "kind": "admin#directory#schema#fieldspec",
          "fieldId": "21_B4iQIRY-dIFGFgAX-Og==",
          "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/LZxiGaz6_N4R40OpKbDhOcy2qiE\"",
          "fieldType": "STRING",
          "fieldName": "EmployeeNumber"
        },
        {
          "kind": "admin#directory#schema#fieldspec",
          "fieldId": "ZKy0QtoMRy2QlM-4sAsPtQ==",
          "etag": "\"KYnPjBPqr8knK6v7rpxly9BhNeY/jEULI-ZiqywQIHXgc8evEcTE4Cc\"",
          "fieldType": "STRING",
          "fieldName": "JobFamily"
        }
      ]
    }
  ]
}

カスタム ユーザー フィールドの管理

ユーザー プロフィールのカスタム フィールドを設定する

JSON リクエスト

ユーザー プロフィールのカスタム フィールドを読み取る

ユーザー プロフィールのカスタム フィールドを検索する

カスタム ユーザー スキーマを作成する

JSON リクエスト

カスタム スキーマの上限

カスタム ユーザー スキーマを更新する

JSON リクエスト

カスタム ユーザー スキーマを取得する

すべてのカスタム ユーザー スキーマを取得する

カスタムユーザーフィールドの管理

ユーザープロフィールのカスタムフィールドを設定する

ユーザープロフィールのカスタムフィールドを読み取る

ユーザープロフィールのカスタムフィールドを検索する

カスタムユーザースキーマを作成する

カスタムスキーマの上限

カスタムユーザースキーマを更新する

カスタムユーザースキーマを取得する

すべてのカスタムユーザースキーマを取得する