このガイドでは、ユーザーカードに表示せずにAPI経由でユーザーカスタムフィールドデータを公開する方法を説明します。
必要なユーザーレベル：管理者
このガイドでは、ユーザーカードに表示せずにAPI経由でユーザーカスタムフィールドデータにアクセスできるようにするプロセスを説明します。これは、カスタムユーザーデータを一般的な表示から隠したまま、プログラムでアクセスする必要がある場合に役立ちます。
ユーザーカスタムフィールドの作成
- まず、ユーザーカスタムフィールドを作成します。詳細な手順については、カスタムユーザーフィールドの作成と設定に関するガイドを参照してください。
- カスタムフィールドをセットアップしたら、保存します。
ユーザーカスタムフィールドIDの検索
- ブラウザで
/admin/config/user-fields.jsonに移動します。 - 新しく作成したカスタムフィールドを見つけて、ID番号をメモします。
APIアクセスの設定
- サイトの管理設定に移動します。
public user custom fieldsまたはstaff user custom fieldsのいずれかの設定を見つけます。- すべてのAPIユーザーがデータにアクセスできるようにしたい場合は、
public user custom fieldsを使用します。 - スタッフAPIキーのみにアクセスを制限したい場合は、
staff user custom fieldsを使用します。
- すべてのAPIユーザーがデータにアクセスできるようにしたい場合は、
- カスタムフィールドを
user_field_Xの形式で入力します。ここで、Xは先ほどメモしたID番号です。
たとえば、カスタムフィールドIDが7の場合、user_field_7と入力します。
カスタムフィールドデータへのアクセス
設定が完了すると、カスタムフィールドデータは「User Fields」セクションの /u/[USERNAME].json エンドポイントに含まれます。
カスタムフィールド値によるユーザーの検索
APIを使用してカスタムフィールドの値に基づいてユーザーを検索できます。
- カスタムフィールドの設定で「searchable」オプションがオンになっていることを確認します。
- クエリパラメータを使用して
/directory_items.jsonエンドポイントを使用します。
API呼び出しの例を次に示します。
https://yourdomain.com/directory_items.json?period=weekly&order=likes_received&name=SearchTerm&user_field_ids=1|2
user_field_ids: 検索するカスタムフィールドを指定します（例：カスタムフィールドID 5のみを検索するにはuser_field_ids=5）。name: カスタムフィールド、ユーザー名、および場合によってはフルネームで検索する検索語。
注意：この検索はカスタムフィールド専用ではなく、ユーザー名またはフルネームの一致に基づいて結果を返す可能性もあります。
利用可能なパラメータの詳細については、APIドキュメントを参照してください。