クリックカウント・開封確認の詳細ログ取得APIとなります。
接続方法
| 項目 | データ |
| URL | https:// *******/click/get_click_log.php |
| メソッド | POST |
| Content-Type | application/x-www-form-urlencoded |
基本パラメータ
| パラメータ | |||
| 1 | site_id | 管理画面 サイト ID | 対象とする 管理画面 のサイト ID |
| 2 | user_id | clicklog | サイトへのアクセス権限、データ入出力権限を有した管理画面 ユーザ ID |
| 3 | password | ********* | 管理画面 パスワード |
| 4 | deliver_id | 取得する配信 ID | 指定された一つの配信 ID から、関連するクリックカウントデータを取得する場合に使用します。 |
| 5 | term_from | 期間指定の開始日時 | 該当する期間を配信予定時刻とする配信IDを検索し、各配信 ID に関連するクリックカウントデータを取得する場合に使用します。term_to と必ずセットで指定します。 YYYY-MM-DD HH:MI |
| 6 | term_to | 期間指定の終了日時 | term_from と必ずセットで指定します。 ※範囲指定が、term_from < term_to でない場合は、エラーコード”0201″を返します。 YYYY-MM-DD HH:MI |
| 7 | mode | 取得モード | 出力するデータの種類を選択する。 0/未設定 ：クリックデータのみ 1 ：クリックデータ＋開封データ 2 ：開封データのみ |
- 配信 ID の指定(deliver_id)もしくは、期間指定(term_from と term_to)は、いずれかが必須となります。
- 配信 ID の指定(deliver_id)と、期間指定(term_from と term_to)両方を指定された場合は、配信 ID の指定(deliver_id)を優先します。
ご注意
集計結果は標準設定の場合、AM07:00 に反映されます。
集計結果は標準設定の場合、AM07:00 に反映されます。
レスポンス
レスポンスは以下となります。
| 項目 | データ | 備考 |
| Content-Type | application/octet-stream | |
| ファイル名 | <配信 ID>-YYYYMMDD-HHMISS.<拡張子> | <拡張子>はファイル形式による。 CSV 形式（csv） |
| ファイル形式 | CSV（デフォルト） ※TSV（Tab Separated Values）の選択可 |
CSV 形式の場合、各データを[“]にて囲み出力。 |
| 文字コード | UTF-8 | |
| 行末コード | CR+LF(0x0d+0x0a) | |
| ヘッダ行 | あり |
| フォーマット |
見出し文言 | ||
| 1 | クリック日時 | YYYY-MM-DD HH:MI:SS | ClickDate |
| 2 | 目的ページ URL | URL | |
| 3 | URL ID | クリック URL ID [a-zA-Z0-9]5 桁 | URL ID |
| 4 | キャリアコード | 0:PC or Others 0:PC or Others 1:docomo 2:Softbank 3:au 4: Disney 5:WILLCOM 6: EMOBILE 7:i.softbank.jp(SoftBank) 8:wcm.ne.jp(WILLCOM) ※キャリアコードは、メールアドレスのドメインから判別しています。 |
Carrier Code |
| 5 | デバイスコード | 0:設定なし 1:PC 2:フィーチャーフォン 3:iPhone 4:Android スマートフォン 5:WindowsPhone ※デバイスコードは、アクセス時のユーザエージェントから判別しています。 |
Device Code |
| 6 | メールアドレス | クリックしたメールアドレス | Mail Address |
| 7 | ユーザエージェント | ユーザエージェント文字列 | User Agent |
| 9 | 付加情報 | 取得したい個別情報（事前設定が必要） | AddInfo |
| 10 | 配信 ID | 対象の配信 ID | Deliver ID |
| 11 | 開封フラグ | 該当データが開封結果である事を示します。 1:開封結果 0:クリックデータ |
OpenFlag |
リクエスト例
リクエスト例は以下となります。
1.配信ID(deliver_id)指定
サイトID = 1,ユーザID = ‘aaaa’, パスワード = ‘bbbbbb’, 配信ID = ‘cccc’
＜Query文字列＞
site_id=1&user_id=aaaa&password=bbbbbb&deliver_id=cccc2.期間(term_from、term_to)指定
サイトID = 5,ユーザID = ‘xxxx’, パスワード = ‘yyyyyy’, 検索開始期間 = ‘2021/09/11 00:00’, 検索終了期間 = ‘2021/09/12 23:59’
＜Query文字列＞
site_id=1&user_id=aaaa&password=bbbbbb&term_from=2021-09-11 00:00&term_to2021-09-12 23:59レスポンス例
レスポンス例は以下となります。
