Web Tracking Visits API リファレンス

説明

Web Tracking Visits APIを利用してビジット（訪問データ）を送信することで、ユーザーのアクセス開始、継続（更新）、アクセス終了を記録（トラッキング）できるようになります。

認証

Web Tracking Visits APIはパブリックAPIであり、認証ヘッダは必要ありません。

エンドポイント

ビジットの登録

エンドポイント: HTTP POST https://beacon.digima.com/v2/locate

リクエストボディのContent-Typeはapplication/jsonで送信する必要があります。

ボディパラメータ

ボディパラメータ	要/不要	型	要件	例	説明
tracking_codes	要	配列型 (array型)	文字列の配列。提供される tracking_codes は以下の形式に従う必要があります。 {account_code}-{web_tracking_domain_code}	["AAAAAAAAAA-AAAAAAAAAAAAAAAAAAAA"]	ハイフン前の10文字は、アカウント設定に表示されるアカウントコードです。ハイフン後の20文字は、Web Tracking Domainsに掲載されているドメインのトラッキングコードです。
visit_code	要/不要	文字列型 (string型)	イベントが update または end の場合に必須です。		更新（update）または終了（end）を要求する対象のビジットコード。
duration	要/不要	整数型 (int型)	イベントが update または end の場合に必須です。
event	要	文字列型 (string型)	'start', 'update', 'end' のいずれかを指定する必要があります。	"start"	要求するイベントの種類。
url	要	文字列型 (string型)	最大 300 文字		顧客が実際に訪問しているページのURL。
title	要	文字列型 (string型)	最大 300 文字		顧客が訪問しているページのタイトル。
referrer_url	不要	文字列型 (string型)	最大 300 文字	"https://google.com"	検索エンジンなど、どこから遷移してきたかを示すリファラURL。
cookie_code	不要	文字列型 (string型)	最大100文字の文字列	"7RUsHLS3jsWkJCHmcsYvl3taLk0nf7AWO3Z7RSfQ"	顧客情報とウェブトラッキングを紐付けるために使用する、ランダムな文字列（Cookie）。
previous_cookie_code	不要	文字列型 (string型)	最大100文字の文字列	"AWVchWS3jsWkJCHmcsYvl3taLk0nf7AWO3Z7RSfQ"	Cookieが変更された際に、以前のCookie情報が残っている場合に使用する文字列。ドメイン間でCookieの有効期限が切れた場合の紐付けなどに使用可能です。
user_agent	不要	文字列型 (string型)	最大1000文字		ブラウザのユーザーエージェント情報。
meta	不要	オブジェクト		{}
meta.browser_lang	不要	文字列型 (string型)		"ja"	ブラウザの言語設定。
meta.browser_platform	不要	文字列型 (string型)		"MacOS"	実行プラットフォーム（OSなど）。
meta.screen_height	不要	整数型 (int型)		768	デバイスの画面解像度（高さ）。
meta.screen_width	不要	整数型 (int型)		1024	デバイスの画面解像度（幅）。
meta.window_height	不要	整数型 (int型)		640	ブラウザのウィンドウサイズ（高さ）。
meta.window_width	不要	整数型 (int型)		480	ブラウザのウィンドウサイズ（幅）。

ペイロード例

{
"tracking_codes": ["AAAAAAAAAA-AAAAAAAAAAAAAAAAAAAA"],
"cookie_code": null,
"previous_cookie_code": null,
"event": "start",
"url": "https://google.com",
"title": "foobar",
"referrer_url": "https://google.com",
"meta": {
    "browser_lang": "en",
    "browser_platform": "MacOS",
    "screen_height": 1024,
    "screen_width": 768,
    "window_height": 640,
    "window_width": 480
 }
}

Visitの更新（Update）

パラメータは「ビジットの登録」と同様ですが、eventに update を指定して送信します。

ペイロード例

{
"tracking_codes": ["AAAAAAAAAA-AAAAAAAAAAAAAAAAAAAA"],
"cookie_code": "MI4KubOg71gLTctMT1BjeREjTcYhkVqiLkiCgN9",
"visit_code": "p5lX5jclopRaFafkaXVsOuxBzEWNqLxLtpe82Hk0",
"event": "update",
"duration": 20
}

Visitの終了（End）

「ビジットの登録」と同様ですが、eventに end を指定して送信します。

ペイロード例

{
"tracking_codes": ["AAAAAAAAAA-AAAAAAAAAAAAAAAAAAAA"],
"cookie_code": "MI4KubOg71gLTctMT1BjeREjTcYhkVqiLkiCgN9",
"visit_code": "p5lX5jclopRaFafkaXVsOuxBzEWNqLxLtpe82Hk0",
"event": "end",
"duration": 20
}