概要

ユーザータグとは、ユーザーの個人情報をKARTEに送信する際の KARTEタグのことを指します。

ユーザータグはuser_idというフィールドを送信することにより「複数のデバイスをまたいで同一のユーザーとして計測できるようになる」などKARTEをご利用頂く上では非常に重要なタグ・イベントです。

※ ビジター（visitor）の場合はuser_idを送らないでください（ユーザータグ自体をvisitorでは発火しないようにしてください）。
※ 個人情報以外の属性情報を送りたい場合はカスタムイベントタグ（attibuteイベント）を利用してください。

ユーザータグを設置する前に

KARTEの「イベント」そして「ユーザー」の概念についての理解が必要ですので下記のドキュメントをご確認ください。

ユーザータグを設置する場所

ユーザータグを設置するページは ユーザーの個人情報が取得できるすべてのページでの設置を推奨 しています。
ユーザー情報が確実に取得できるかわからない場合は「ページ内でユーザーがログインしている場合のみユーザータグが実行される」ような実装が必要です。

ユーザータグは必ず、計測タグの後に実行されるように設置してください。
計測タグよりも後に設置することでイベントの送信が可能になります。

ユーザータグの設置方法

ユーザータグを、計測タグが設置されたページに対して、計測タグよりも後に実行されるように設置します
ユーザータグが正常に実行されると、KARTEにはidentifyという名前のイベントが発生します

共通したユーザー情報を持つユーザータグがサイトに訪れた複数のユーザーに配信された場合
それらのユーザーがもつユーザー情報（ユーザーID、名前、メールアドレスなど）が同じものとなってしまいます。
ユーザータグは、ユーザー毎に異なる値をタグとして出力する必要があることに注意してください。

サンプルコード
ユーザータグでユーザーIDがxxx123、名前がKARTE太郎, メールアドレスがsample@sample.com、メール許諾フラグがtrueのユーザーの個人情報を送信したい場合は以下のようなコードを実行してください。

<script type="text/javascript">
krt('send', 'identify', {
  user_id: 'xxx123', // 実際は個別のuser_idが入ります
  last_name: 'KARTE',  // 実際は個別の名前が入ります
  first_name: '太郎',  // 実際は個別の名前が入ります
  email: 'sample@sample.com', // 実際は個別のメールアドレスが入ります
  subscription: true // 実際は個別のメール許諾フラグが入ります
})
</script>

同一のユーザー情報を複数のユーザーで実行しないように注意してください。

ユーザータグの標準スキーマ

イベントのフィールドは自由に変更することができますが、KARTE標準イベントスキーマで定められたフィールドを連携することを推奨しています。
KARTEの標準イベントスキーマは、イベントストアにて全て定義されています。
詳細はイベントストアをご参照ください。

下記はイベントストアに定義されているスキーマになります。
下記の例以外にも個人情報に該当する可能性あるフィールドをKARTEに送信したい場合は追加してください。

フィールド名	概要	例	型
user_id	後述する「user_idについて」をご参照ください。	"6ce372a91f0bc11a2414dd10"	文字列
email	メールアドレスです。アクションとしてメールを利用する場合には必須です。	"sato_shigeru@plaid.co.jp"	文字列
subscription	メールマガジン登録の可否です。 falseの場合、アクションでメールを設定しても送信されません。アクションとしてメールを利用する場合には必須です。	true	真偽値
phone	ユーザーの電話番号です。	"080-1234-5678", "08012345678"	文字列
phone_subscribe	SMS配信の可否です。 falseの場合、アクションでSMSを設定しても送信されません。アクションとしてSMSを利用する場合には必須です。	true	真偽値
first_name	名前です。	"茂"	文字列
last_name	名字です。	"佐藤"	文字列
address	住所です。	"品川区西五反田0-0-0"	文字列

user_idについて
ユーザーを識別するユニークなIDです。
連携することで複数ブラウザ、端末間でユーザー間でユーザーを同一なものとして認識できるようになります。
ユーザーIDを意味する値をユーザータグで送信する場合は、必ずuser_idという名称で、システム上でユニークなID（1人のユーザーに対して与えられ、システム上で重複しない）を文字列形式で送信してください。

なお、IDは第三者から推測困難な値であることが望ましいです。
連番など推測できる体系で生成されている場合は、ハッシュ化などをして推測困難な値に変換してから連携することを推奨しています。
※ ブラウザ内のコンソールから任意のuser_idでユーザータグが実行された場合など、想定外の端末でユーザーの判定が行われるリスクがあります

カスタム例:モバイル

フィールド名	概要	例	型
email_mobile	モバイルのメールアドレス	"sato_shigeru@plaid.co.jp"	文字列
phone_mobile	モバイルの番号	"000-0000-0000"	文字列

よくある間違い・注意事項

以下の様なケースではタグ設置方法に間違いがある可能性があります。

誤って複数のユーザーで同一のuser_idを送信してしまった

複数のユーザーが1人のメンバーに紐ついてしまうため、ユーザーを正常に識別できなくなります
非ログインユーザーやユーザーデータが正常に参照出来ない場合等で発生しやすいため、実装時には十分に注意してください。
visitorの場合はuser_idを送らないでください。（ユーザータグ自体をvisitorでは発火しないようにしてください）
仮に発生してしまった場合は実装を修正した上で、適宜サポート担当までお問い合わせください。

非ログイン状態のユーザーの計測のためにユーザータグを設置してしまった

計測タグの設置が完了していれば非ログイン状態のユーザーは計測できるため、非ログイン状態のユーザーの計測のためだけにユーザータグを新たに設置する必要はありません。

文字列で送るデータを数値で送ってしまった

ユーザーIDなどの文字列で送るデータは"1234"のようにダブルクォートで囲む必要があります。数値ではなく文字列で送る必要がありますのでご注意ください。

文字列で送る場合："1234"
数値で送る場合：1234

各種カートシステムでユーザータグを設置する

ECサイトで、下記のカートシステムをご利用の場合は各カートで取得できる情報が決まっています。
専用のユーザータグ設置方法がありますので以下のドキュメントをご確認ください。

ユーザータグの設置

概要