LINE WORKSでは、2025年7月にメンバーで、2025年11月には外部連絡先で、それぞれカスタム項目が利用可能になりました。
カスタム項目とは
カスタム項目は、メンバーや外部連絡先情報に、管理者が定義した項目を追加のフィールドとして定義する機能です。カスタム項目は、LINE WORKS有償版で利用できます。
これまで、メンバー情報については、APIを通してのみ項目の管理・設定可能な「カスタムフィールド」機能がありましたが、7月に、サービス画面からも管理・設定が可能な「カスタム項目」としてリニューアルされました。
以前に設定していたカスタムフィールドは、「カスタム項目」として移行されており、指定していた値も含めてそのまま利用できます。
また、外部連絡先には既定の項目に情報を登録することはできましたが、管理者が項目を追加して情報を登録することはできず、既定の項目にない情報は、メモ欄に記載する等の工夫が必要でした。今後は、「カスタム項目」として、メンバー情報と同様に項目の管理・設定が可能です。
どちらも「カスタム項目」という名称で、追加項目の定義ができる点では同じですが、メンバーと外部連絡先のカスタム項目には、機能に若干の違いがあります。
| 機能 | メンバーの カスタム項目 |
外部連絡先の カスタム項目 |
|---|---|---|
| データ型 | - テキスト - リンク - 整数 - 日付 |
- テキスト - リンク |
| 複数値の入力 | ◯ | ◯ |
| プルダウンリスト | ◯ (テキストのみ) | - |
| 必須設定 | ◯ | - |
| サービス画面への表示設定 | ◯ | - |
| 修正権限の設定 | ◯ | - |
| 代表値の指定 | - | ◯ |
使ってみる
API によるカスタム項目の作成や、メンバーまたは外部連絡先でのカスタム項目の設定はよく似ています。
ここでは、メンバーに対してカスタム項目を作成し、実際に値を指定してみます。
1. カスタム項目を作ってみる
まずは、複数値の入力が可能な文字列型の 趣味 項目を作ります。
$addUserCustomPropertyAPI = "https://www.worksapis.com/v1.0/directory/users/custom-properties"
[HashTable]$CustomProp1 = @{
domainId = 123456
propertyName = "Hobby"
displayName = "趣味"
propertyType = "STRING"
multiValued = $true
}
$response =Invoke-RestMethod -Method POST -Uri $addUserCustomPropertyAPI -Headers $Header -body (ConvertTo-Json $CustomProp1)
次は、プルダウンリストを利用できる 勤務地 項目を作ります。プルダウンリストは、メンバーのテキスト型のカスタム項目でのみ利用できます。
[HashTable]$CustomProp2 = @{
domainId = 123456
propertyName = "primary_worklocation"
displayName = "勤務地"
propertyType = "STRING"
options = @(
@{
optionName = "tokyo_hq"
displayName = "東京本社"
},
@{
optionName = "moon_surface_2ndbase"
displayName = "月面第二基地"
}
)
}
$response =Invoke-RestMethod -Method POST -Uri $addUserCustomPropertyAPI -Headers $Header -body (ConvertTo-Json $CustomProp2)
2. カスタム項目に値を指定してみる
カスタム項目は、メンバーや連絡先の作成、更新、または部分更新 API で指定します。
ここでは、既存のメンバーに対して、部分更新 API を作ってカスタム項目に値を指定します。
$patchUserAPI = "https://www.worksapis.com/v1.0/users/moon@mydomainname"
[HashTable]$patchCustomProp = @{
customProperties = @{
Hobby = @(
"宇宙遊泳",
"エクストリーム出社"
)
"primary_worklocation" = "moon_surface_2ndbase"
}
}
$response =Invoke-RestMethod -Method PATCH -Uri $patchUserAPI -Headers $Header -body (ConvertTo-Json $patchCustomProp)
サービス画面で表示してみる
というわけで、指定したカスタム項目は、サービス上では以下のように表示されます。
カスタム項目を利用することで、これまでは別のシステムで管理したり、表示名やメモ欄などにも持たせていた追加情報を、LINE WORKSサービス上に、よりわかりやすく表示できるようになりました。
LINE WORKSのより一層の活用にお役立てください。