entity-lookup

エンティティ検索

目的

ID フィールドで個々のユーザープロファイルを検索します。すべてのフィールド、セグメントへの所属状況、メタデータを含む完全なプロファイルを返します。

環境

認証済みの API アクセスが必要です。認証情報の解決については、../references/auth.md を参照してください。

API エンドポイント

V2 ID 検索

curl -s "${LYTICS_API_URL:-https://api.lytics.io}/v2/identity/${TABLE}/${FIELD}/${VALUE}" \
  -H "Authorization: ${LYTICS_API_TOKEN}"

例：GET /v2/identity/user/email/[email protected]

Data API エンティティ検索

curl -s "${LYTICS_API_URL:-https://api.lytics.io}/api/entity/${TABLE}/${FIELD}/${VALUE}" \
  -H "Authorization: ${LYTICS_API_TOKEN}"

値のみでエンティティ検索

curl -s "${LYTICS_API_URL:-https://api.lytics.io}/api/entity/${TABLE}/${VALUE}" \
  -H "Authorization: ${LYTICS_API_TOKEN}"

すべての ID フィールドを対象に検索します。

エンティティのセグメント所属状況

curl -s "${LYTICS_API_URL:-https://api.lytics.io}/api/entity/${TABLE}/segments/${FIELD}/${VALUE}" \
  -H "Authorization: ${LYTICS_API_TOKEN}"

ID 検索（POST）

curl -s -X POST "${LYTICS_API_URL:-https://api.lytics.io}/v2/identity/lookup" \
  -H "Authorization: ${LYTICS_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"field": "email", "value": "[email protected]", "table": "user"}'

エンティティの削除

# Hard delete
curl -s -X DELETE "${LYTICS_API_URL:-https://api.lytics.io}/api/entity/${TABLE}/${FIELD}/${VALUE}" \
  -H "Authorization: ${LYTICS_API_TOKEN}"

# Soft delete
curl -s -X DELETE "${LYTICS_API_URL:-https://api.lytics.io}/api/entity/softdelete/${TABLE}/${FIELD}/${VALUE}" \
  -H "Authorization: ${LYTICS_API_TOKEN}"

一般的な ID フィールド

• email -- メールアドレス
• _uid -- Lytics のユーザー ID
• user_id -- 外部ユーザー ID
• アカウント固有の ID フィールドを確認するには、GET /v2/schema/{table}/idconfig を確認してください。

動作

検索の場合（読み取り）

直ちに実行します。プロファイルを次の構造化形式で表示します。

1. ID：すべての ID フィールドと値
2. 主要な属性：価値の高いプロファイルフィールド（名前、所在地、エンゲージメントスコア）
3. セグメントへの所属状況：このユーザーが所属するセグメント
4. 最近のアクティビティ：最新のイベントのタイムスタンプ

削除の場合（書き込み）

確認ゲートのパターンを使用します。次の点に注意を促してください。

• 完全削除は取り消せません
• ソフト削除は元に戻せますが、データ処理に影響します

エラー処理

• プロファイルが見つからない（404）：別の ID フィールドを試すか、スペルを確認するよう提案します。
• URL エンコード：値に特殊文字（メールアドレスの @ など）が含まれる場合は、値を URL エンコードします。
• 複数の一致：複数のプロファイルが一致した場合は、すべて表示してユーザーに選択を求めます。

依存関係

• 使用するもの：../references/auth.md、../references/api-client.md、../references/confirmation-gate.md（削除の場合のみ）