The Sprocket Developer Hub

The Sprocket Developer Hub

Sprocket の developer hub にようこそ。このサイトでは API 仕様や JavaScript タグ仕様など、Sprocket を活用していただくうえでの技術情報が掲載されています。適宜参照しながら Sprocket をご活用ください。

    

会員ID連携(簡易連携)

Sprocket で発番するユーザーID(SprocketユーザーID)とサイトで管理する会員IDを紐づけることができます。

設定の流れ

会員ID連携を実施する場合は、まず担当プロデューサーまでご連絡ください。

📘

補足説明

  • ユーザー属性タグを使って会員ID連携する場合、本記事記載の簡易連携の実装は不要です
  • サイトで管理する会員ID を動的に出力するにはサイトの改修が必要です
  • サイトの改修が完了したら、担当プロデューサーまでご連絡ください。Sprocket で出力状況を確認したうえで、会員ID連携機能を有効化します。

会員IDに求められる要件

サイトで管理する会員IDは以下を満たす必要があります。

・文字数:1〜128文字
・使用できる文字:ASCIIコードの英数記号全て

連携方法1(Cookie を使用)

任意の Cookie に サイトで管理する会員ID を出力してください。Cookie 名をご連絡いただければ、その値を取得するように Sprocket 側で設定を行います。

🚧

注意事項

  • JavaScript から Cookie にアクセスする必要がありますので、httponly 属性は付与しないでください。

連携方法2(JavaScript 変数を使用)

任意のグローバル変数に サイトで管理する会員ID を出力してください。グローバル変数名をご連絡いただければ、その値を取得するように Sprocket 側で設定を行います。

連携方法3(ページ内の HTML 情報を使用)

ページ内の HTML 要素として サイトで管理する会員ID を出力してください。2通りの連携方法が利用可能です。

・任意の DOM 要素のテキスト部分に会員 ID を出力(DOM 要素を特定する CSS セレクター名をご連絡ください)
・任意の DOM 要素の任意の属性に会員 ID を出力(DOM 要素を特定するCSSセレクター名と属性名をご連絡ください)

会員ID連携時の挙動

初めてサイトに来訪したユーザーはゲストユーザーとなります。この場合、 Sprocket がブラウザー毎に発番するゲストIDSprocketユーザーID と紐付けられます。

会員ID連携することにより、 サイトで管理する会員IDSprocketユーザーID と紐付けられます。

複数ブラウザーで会員ID連携した場合の挙動

例として PC とスマートフォンの両方からアクセスし、当初別々のゲストユーザーと見なされていたユーザーは、両方のデバイスから サイトで管理する会員ID が送信された時点で同一のユーザーとして扱われるようになります。

この場合、最初に会員ID連携したブラウザーで計測された行動データは会員ID連携後も引き継がれます。それ以外のブラウザーでアクセスした行動データは会員ID連携後に利用できなくなります。

ログアウト時の挙動

ログイン機能のあるサイトでユーザーがログアウトした場合でも、会員IDの連携状態は引き継がれます。

🚧

注意事項

  • 複数のユーザーから同一の会員IDを送信しないでください。複数のユーザーが1人のSprocketユーザーIDと紐づくため、ユーザーを正常に識別できなくなります。例えば非ログイン時に Cookie や JavaScript の変数に "guest"、 "logout" 、“null” といった共通の値をセットすると、全ての非ログインユーザーが1人のユーザーに紐づきます。そのため、非ログイン時や非会員では、Cookie や JavaScript 変数が存在しない状態、もしくは値をブランクにしてください。
  • サイトで管理する会員IDは Sprocket タグの発火前に出力されている必要があります。Sprocket タグの発火より後にデータ出力されると会員ID連携されませんのでご注意ください。

Updated 8 months ago

会員ID連携(簡易連携)


Sprocket で発番するユーザーID(SprocketユーザーID)とサイトで管理する会員IDを紐づけることができます。

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.