ユーザー属性を設定
呼び出しアドレス
POST /v1/user/property
呼び出し認証
EngageLab REST API は HTTP Basic Authentication を使用して認証を行います。HTTP Header に Authorization を追加してください:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
このコードブロックはフローティングウィンドウ内に表示されます
上記の base64_auth_string の生成アルゴリズムは次の通りです:base64(api_key:api_secret)
- ヘッダー名は "Authorization" で、値は base64 で変換された "username:password" ペア(コロンで区切る)です。
- MA API のシナリオでは、username は APIKey、password は APISecret です。データソースに API タイプのデータソースを追加して APIKey と APISecret を取得してください。
リクエスト例
リクエストヘッダー
> POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
このコードブロックはフローティングウィンドウ内に表示されます
リクエストボディ
{
"euid": 10362473,
"type": "set",
"properties": {
"user_number_once": 46.2, // ユーザー属性名と属性値
"user_string_once": "refef",
"user_datetime_once": "2023-12-12 00:56:23"
}
}
{
"euid": 10362473,
"type": "set",
"properties": {
"user_number_once": 46.2, // ユーザー属性名と属性値
"user_string_once": "refef",
"user_datetime_once": "2023-12-12 00:56:23"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
リクエストパラメータ
フィールド | タイプ | 必須 | 説明 |
---|---|---|---|
euid | Long | はい | EngageLab MA の一意のユーザー ID |
type | String | はい | 属性を更新する操作タイプ |
properties | JSON | はい | ユーザー属性リスト。key は属性名、value は属性値 |
レスポンスパラメータ
フィールド | タイプ | 必須 | 説明 |
---|---|---|---|
code | Int | はい | インターフェース呼び出しの成功を示します。0 は成功または部分成功を意味し、それ以外の値は失敗を意味します |
message | String | はい | インターフェース呼び出し結果の説明、戻り値コードの説明 |
全て成功
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
このコードブロックはフローティングウィンドウ内に表示されます
全て失敗
{
"code": 55102,
"message": "Invalid user attributes exist"
}
{
"code": 55102,
"message": "Invalid user attributes exist"
}
このコードブロックはフローティングウィンドウ内に表示されます
エラーコード
エラーコード | 説明 | 詳細説明 |
---|---|---|
40050 | インターフェース認証失敗。 | プロジェクト ID とプロジェクトキーが正しいか確認してください。 |
40007 | EUID が空です。 | EUID の値を確認してください。 |
50031 | プロジェクト ID が無効です。 | APIKey と APISecret が正しいか確認してください。 |
50034 | プロジェクト ID が存在しません。 | APIKey と APISecret が正しいか確認し、プロジェクトが削除されていないか確認してください。 |
50074 | API データソースが存在しません。 | APIKey と APISecret が正しいか確認し、API データソースが削除されていないか確認してください。 |
55004 | ビジネスパラメータが無効です。 | リクエストパラメータのフィールドが正しいか確認してください。 |
55101 | ユーザー識別子の数が制限を超えています。 | ユーザー識別子の値の数が 100 を超えていないか確認してください。 |
55102 | 無効なユーザー属性名が存在します。 | 属性名が命名要件を満たしているか、空でないか、予約文字を使用していないか、長さ制限を超えていないか確認してください。 |
55103 | ユーザー属性値が空です。 | リクエストボディ内のユーザー属性値が空でないか確認してください。 |
55105 | ユーザー識別子の値が 256 文字を超えています。 | ユーザー識別子の値が 256 文字を超えていないか確認してください。 |
55106 | ユーザー識別子の名前がサポート範囲外です。 | ユーザー識別子の名前が user_id、anonymous_id または registration_id であるか確認してください。 |
55107 | ユーザー識別子の値が空です。 | リクエストボディ内のユーザー識別子の値が空でないか確認してください。 |
55108 | EUID が無効です。 | EUID の値を確認してください。 |
-1 | サーバー内部エラー。 | EngageLab の技術サポートに連絡してください。 |