ドキュメント

JavaScript API

ウィジェットスクリプトを読み込んだ後に利用できるグローバルメソッドです。

Respondo.init(config)#

ウィジェットを初期化してマウントします。1 回だけ呼び出す必要があります。ウィジェットインスタンスを返します。

const widget = Respondo.init({
  agentId: 'YOUR_AGENT_ID'
});

Respondo.identify(identity)#

ユーザー ID を現在のセッションに添付します。ログイン後に呼び出してください。

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  userHash: 'hmac_sha256_signature', // 任意、本人確認用
  metadata: { plan: 'pro' },
  properties: {                      // カスタムの連絡先プロパティ
    account_type: 'enterprise',      // キーは Agent Settings で定義
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)#

現在の訪問者のクライアントサイドイベント（購入、プランのアップグレードなど）を記録します。イベントはイベントトリガー型のツアーを開始でき、ツアーのゴールにもカウントされます。 keepalive によるベストエフォート配信のため、ナビゲーション直前（チェックアウトへのリダイレクトなど）に発火したイベントも届きます。 init() の後に呼び出してください。

Respondo.track('purchase_completed', {
  plan: 'pro',
  amount: 49
});

Respondo.destroy()#

ウィジェットをページから削除します。ウィジェットを表示すべきでないページへ遷移する SPA で便利です。訪問者の ID や保存された会話はクリアされません — ログアウトには Respondo.reset() を使用してください。

// ウィジェットをページから削除
Respondo.destroy();

// 必要なら後で再初期化（同じ会話を再開します）
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()#

ログアウト / 共有デバイスの引き継ぎ用。匿名の訪問者 ID、保存された会話、セッショントークンをブラウザからクリアし、セッショントークンをサーバー側で失効させて（そのコピーは機能しなくなります）、新しい匿名ウィジェットを再マウントします。アプリのログアウトフックから呼び出してください。

// ログアウト時 — ID、会話、セッションを消去して最初から開始
Respondo.reset();

自動データ収集

ウィジェットは各会話とともに以下を自動的に取得して保存します:

データ取得元
クライアント IPHTTP ヘッダー
ブラウザ / OSUser-Agent ヘッダー
言語Accept-Language ヘッダー
タイムゾーンIntl API（JavaScript）
ページ URLwindow.location
リファラーReferer ヘッダー