EUIDを取得

EUID は EngageLab MA プラットフォームの一意のユーザー ID です。以下の API を使用して、ユーザー識別子に基づいて EUID を取得できます。

呼び出しアドレス

POST /v1/user/register

呼び出し認証

EngageLab REST API は HTTP 基本認証 の認証方法を使用します:Authorization を HTTP ヘッダーに追加します:

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/register > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
              
              > POST /v1/user/register
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            
このコードブロックはフローティングウィンドウ内に表示されます

リクエストボディ

{ "identity_name":"user_id", // ユーザー識別子名 "identity_values": [ "18012345678", // ユーザー識別子値 "18012345678" ] }
              
              {
    "identity_name":"user_id", // ユーザー識別子名
    "identity_values": [
        "18012345678",    // ユーザー識別子値
        "18012345678"
        ]
}

            
このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

フィールド タイプ 必須 説明
identity_name String はい ユーザー識別子名、user_id、anonymous_id、registration_id などの値を渡すことができます
identity_values list はい ユーザー識別子の値、最大 100 個の値をサポートし、各値は 256 文字を超えない必要があります

レスポンスパラメータ

フィールド タイプ 必須 説明
code Int はい API 呼び出しが成功したかどうかを示します。0 は成功または部分的成功を示し、それ以外の値は失敗を示します
message String はい API 呼び出し結果の説明、返却コードの説明
data Array いいえ ユーザー識別子に対応する EUID リストを返します
identity_value String はい ユーザー識別子の値
euid Long はい EngageLab MA に対応する一意のユーザー ID
error_code Int はい EUID の取得が成功したかどうかを示します。0 は成功を示し、それ以外の値は失敗を示します

全て成功

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", // ユーザー識別子値 "euid": 10362473, // 生成された EUID、取得失敗時は null "error_code": 0 // 対応するエラーコード、0 は成功、非空は失敗(例:40006) }, { "identity_value": "18012340000", "euid": 10362474, "error_code": 0 } ] }
              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",   // ユーザー識別子値
            "euid": 10362473, // 生成された EUID、取得失敗時は null
            "error_code": 0   // 対応するエラーコード、0 は成功、非空は失敗(例:40006)
        },
        {
            "identity_value": "18012340000",
            "euid": 10362474,
            "error_code": 0
        }
    ]
}

            
このコードブロックはフローティングウィンドウ内に表示されます

全て失敗

{ "code": 55101, "message": "ユーザー識別子数の制限を超えました" }
              
              {
    "code": 55101,
    "message": "ユーザー識別子数の制限を超えました"
}

            
このコードブロックはフローティングウィンドウ内に表示されます

部分成功

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", // ユーザー識別子値 "euid": null, // 失敗時は null "error_code": -1 // 対応するエラーコード、0 は成功、非空は失敗 }, { "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000", "euid": null, "error_code": 55105 } ] }
              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",   // ユーザー識別子値
            "euid": null, // 失敗時は null
            "error_code": -1     // 対応するエラーコード、0 は成功、非空は失敗
        },
        {
            "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
            "euid": null,
            "error_code": 55105
        }
    ]
}

            
このコードブロックはフローティングウィンドウ内に表示されます

エラーコード

|コード| 説明| 詳細説明 | | ----- | -------- | ----------------------- | -------------------------- | | 40050 | API 認証失敗。| プロジェクト 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 技術サポートに連絡してください。|

icon
お問い合わせ