セッショントラッキング導入仕様書
概要
このトラッキング方式は、HTTP リクエストを用いた通知方式です。
エンドポイント
https://iclink.site/api/callback
パラメータ
| パラメータ名 | 詳細 | 型 | 上限値 | 説明 |
|---|---|---|---|---|
| order_id | string | 50 文字以内 | 御社側での注文情報を識別する ID。また、50 文字を超える場合は、50 文字以降が切り捨てられ計上される。 | |
| customer_id | string | 50 文字以内 | 御社側での顧客を識別する ID。また、50 文字を超える場合は、50 文字以降が切り捨てられ計上される。 | |
| items | 商品コード | string | 50 文字以内 | 商品を識別するコード。また 50 文字を超える場合は、50 文字目以降が切り捨てられ成果として計上される。 |
| 商品単価 | Number | 99999999.99 | 商品単価。 | |
| 商品個数 | Number | 9999 | 商品個数。 | |
| total_price | Number | 9999999999 | 注文合計金額。 |
パラメータは全て必須となります。
成果通知フォーマット
https://iclink.site/api/callback?iclink_id={識別パラメータ}&order_id={注文番号}&customer_id={顧客番号}&items={商品1コード}~{商品1単価}~{商品1個数}&items={商品2コード}~{商品2単価}~{商品2個数}&total_price={注文合計金額}
クリック識別子(ICLink パラメータ)について
説明
広告主様ランディングページへリダイレクト時に付与致しますクリック識別子(ICLink パラメータ)は、 エンドユーザを識別する為のパラメータとなります。
仕様
[パラメータ形式]
プログラム URL?(引数名)=(クリック識別子(ICLink パラメータ)) ※パラメータはクリックされる毎にユニーク値で付与致します。
引数名
iclink_id で付与されます。
クリック識別子(ICLink パラメータ)
約 24byte の可変長文字列となります。
設定
- ICLink への成果通知処理の設定(HTTP リクエスト)
- クリック識別子(ICLink パラメータ)の引継ぎ処理
成果通知処理
HTTP リクエスト
HTTP リクエスト(サーバー間通信)で成果データを通知する方式です。
コンバージョンページからのアクションで ICLink まで指定フォーマットで成果データを返します。
通信方式
HTTP リクエスト
SSL 通信必須
通信フォーマット
上記、「エンドポイント」「パラメータ」「成果通知フォーマット」をご確認下さい。
メソッド
GET
sample
https://iclink.site/api/callback?iclink_id=clk7ywger0003zj01cwrxwi10&order_id=1&customer_id=3&items=lashrich~2~3980&total_price=8756
成果送信の実行結果について
成果データが送信された際、text/plain 形式で実行結果が返されます。
実行結果
成果データが送信された際、text/plain 形式で実行結果が返されます。
0: 正常終了
成果データが正しく送信されたとき返されます。
1: 書式エラーまたは識別パラメータの解析エラー
成果データの URL 形式が間違っているとき返されます。 成果データの送信方法に誤りがないかご確認ください。
2 : その他のエラー
このエラーが返された場合には弊社までお問い合わせください。
クリック識別子(ICLink パラメータ)の引継ぎ処理
広告クリック時に ICLink より付与しますクリック識別子(ICLink パラメータ)を サンクスページまで消失しないよう引継ぎ処理をご対応下さい。
設定例
ecforce
ソケット通信機能を設定ください
| 項目 | 値 |
|---|---|
| 成果通知先 URL | https://iclink.site/api/callback?iclink_id={iclink_id}&total_price={total_price}&customer_id={customer_id}&order_id={order_id}&{for:multi_value:order_items:[sku]~[price]~[quantity]:items} |
| 通知方式 | GET |
| 入力パラメータ 1 | iclink_id |
LP 用とショップ用の設定が別々です LP 用:マーケティング管理 > 広告管理 > ソケット通信管理 ショップ用:ショップ管理 > 各種設定 > ソケット通信管理
::: |
ソケット通信機能 設定 も参照してください。