EUIDを照会 | Marketing Automation REST API 日本語

この API は、プロジェクトに設定されているユーザー識別子を使用して、既存ユーザーの EUID を照会します。既存データの読み取りだけを行い、一致するユーザーがない場合もユーザーや新しい EUID を作成しません。この API にはプロジェクト単位で毎分 1,000 リクエストのレート制限があり、上限を超えると HTTP 429 とエラーコード 55110 を返します。

呼び出しアドレス

POST /v1/user/euid

呼び出し認証

EngageLab REST API は HTTP 基本認証を使用します。

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

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

base64_auth_string は base64(api_key:api_secret) で生成します。

リクエスト例

{ "identity_name": "user_id", "identity_values": ["user-1", "user-2"] }

              
              {
    "identity_name": "user_id",
    "identity_values": ["user-1", "user-2"]
}

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

リクエストパラメータ

フィールド	型	必須	説明
identity_name	String	はい	プロジェクトに設定されたユーザー識別子の名前。
identity_values	Array	はい	識別子の値。1～100 個、各値は最大 256 文字。

レスポンスパラメータ

フィールド	型	説明
code	Int	0 は成功を示します。未一致の値が含まれる場合も 0 です。
message	String	結果の説明。
data	Array	リクエストと同じ順序の結果。
identity_value	String	リクエストされた識別子の値。
euid	Long	既存 EUID。ユーザーが見つからない場合は `null`。
error_code	Int	正常な照会は 0。未一致の場合も 0。

レスポンス例

{ "code": 0, "message": "success", "data": [ {"identity_value": "user-1", "euid": 10362473, "error_code": 0}, {"identity_value": "user-not-found", "euid": null, "error_code": 0} ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {"identity_value": "user-1", "euid": 10362473, "error_code": 0},
        {"identity_value": "user-not-found", "euid": null, "error_code": 0}
    ]
}

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

エラーコード

コード	説明
40050	インターフェース認証に失敗しました。
55004	ビジネスパラメータが不正です。
55101	識別子の数が 100 を超えています。
55105	識別子の値が 256 文字を超えています。
55106	識別子がプロジェクトに設定されていません。
55107	識別子名または値が空です。
55110	リクエスト頻度が上限を超えました（プロジェクト単位で毎分最大 1,000 リクエスト）。