Website高度な使用ガイド
websiteチャネルは、ユーザーのニーズを満たすために、LiveDesk Widget SDKインターフェースに基づいたさらなる設定をサポートしています。
LiveDesk Widget SDKインターフェース
Useridおよびユーザー情報の設定(通常モード)
window.addEventListener("livedesk:ready", function () {
window.$livedesk.setUser("ユーザー一意識別子(例:user_id)", { // 第1引数は一意の識別子
email: "user@example.com",
name: "ユーザー名",
avatar_url: "https://example.com/avatar.jpg", // オプション
phone_number: "+1234567890" // オプション
});
});
window.addEventListener("livedesk:ready", function () {
window.$livedesk.setUser("ユーザー一意識別子(例:user_id)", { // 第1引数は一意の識別子
email: "user@example.com",
name: "ユーザー名",
avatar_url: "https://example.com/avatar.jpg", // オプション
phone_number: "+1234567890" // オプション
});
});
このコードブロックはフローティングウィンドウ内に表示されます
Useridおよびユーザー情報の設定(暗号化モード)
認証の有効化(推奨):なりすましを防ぎ、ブラウザ間でセッションを持続させるために、設定でHMACを有効にします(SHA256を使用してidentifier_hashを生成)。例(JavaScript):
const crypto = require('crypto');
const key = 'あなたのHMAC Token'; // Inboxes設定からコピー
const message = 'ユーザー一意識別子';
const identifier_hash = crypto.createHmac('sha256', key).update(message).digest('hex');
// setUser内で追加
window.$livedesk.setUser("ユーザー一意識別子", {
...その他の情報,
identifier_hash: identifier_hash
});
const crypto = require('crypto');
const key = 'あなたのHMAC Token'; // Inboxes設定からコピー
const message = 'ユーザー一意識別子';
const identifier_hash = crypto.createHmac('sha256', key).update(message).digest('hex');
// setUser内で追加
window.$livedesk.setUser("ユーザー一意識別子", {
...その他の情報,
identifier_hash: identifier_hash
});
このコードブロックはフローティングウィンドウ内に表示されます
「会話カスタム変数」の設定
window.$livedesk.setConversationCustomAttributes({
utm_source: "google", // 例:会話レベルのUTM
session_type: "support"
});
window.$livedesk.setConversationCustomAttributes({
utm_source: "google", // 例:会話レベルのUTM
session_type: "support"
});
このコードブロックはフローティングウィンドウ内に表示されます
- これらのカスタム変数は、livedesk - Conversation - 会話情報に表示されます。
「ユーザーカスタム変数」の設定
window.addEventListener("livedesk:ready", function () {
window.$livedesk.setCustomAttributes({
pricing_plan: "premium", // key: 定義済みの一意の識別子, value: タイプに応じた設定(例:文字列)
signup_date: new Date(), // 例:日付タイプ
account_id: 123 // 例:数値タイプ
});
});
window.addEventListener("livedesk:ready", function () {
window.$livedesk.setCustomAttributes({
pricing_plan: "premium", // key: 定義済みの一意の識別子, value: タイプに応じた設定(例:文字列)
signup_date: new Date(), // 例:日付タイプ
account_id: 123 // 例:数値タイプ
});
});
このコードブロックはフローティングウィンドウ内に表示されます
- これらのカスタム変数は、「livedesk - Conversation - 連絡先属性」に表示されます。
ユーザー属性の削除
指定されたカスタム属性を削除します。
window.$livedesk.deleteCustomAttribute("pricing_plan");//string属性キー名
window.$livedesk.deleteCustomAttribute("pricing_plan");//string属性キー名
このコードブロックはフローティングウィンドウ内に表示されます
チャットバブルの開閉状態の切り替え
ウィジェットの開閉状態を切り替えます。
window.$livdesk.toggle();
// Toggle widget by passing state
window.$livedesk.toggle("open"); // チャットウィジェットを開く
window.$livedesk.toggle("close"); // チャットウィジェットを閉じる
window.$livdesk.toggle();
// Toggle widget by passing state
window.$livedesk.toggle("open"); // チャットウィジェットを開く
window.$livedesk.toggle("close"); // チャットウィジェットを閉じる
このコードブロックはフローティングウィンドウ内に表示されます
チャットバブルの表示/非表示
window.$livedesk.toggleBubbleVisibility('hide');// show/hide
window.$livedesk.toggleBubbleVisibility('hide');// show/hide
このコードブロックはフローティングウィンドウ内に表示されます
ポップアップモード
ポップアップウィンドウモードでチャット画面を開きます。
window.$livedesk.popoutChatWindow();
window.$livedesk.popoutChatWindow();
このコードブロックはフローティングウィンドウ内に表示されます
言語設定
ウィジェットの言語を設定します
window.$livedesk.setLocale("en");// string言語コード、例:zh-CN
window.$livedesk.setLocale("en");// string言語コード、例:zh-CN
このコードブロックはフローティングウィンドウ内に表示されます
タグの追加/削除
現在の会話にタグを追加します(会話開始前)、タグは自動的に会話に設定されます
window.$livdesk.setLabel('support-ticket');// stringタグ識別子
window.$livdesk.removeLabel('support-ticket');
window.$livdesk.setLabel('support-ticket');// stringタグ識別子
window.$livdesk.removeLabel('support-ticket');
このコードブロックはフローティングウィンドウ内に表示されます
Livedesk Widget 設定オブジェクト
初期化時(SDKロード前)に設定するグローバルオブジェクトで、ウィジェットの動作をカスタマイズするために使用します。window.livedeskSettingsで定義し、window.livedeskSDK.run()で渡します。
オブジェクト属性
| 属性名 | タイプ | 説明 | デフォルト値 | 例 |
|---|---|---|---|---|
hideMessageBubble |
boolean | メッセージバブルを隠す。 | false | true |
showUnreadMessagesDialog |
boolean | 未読メッセージダイアログを表示。 | true | false |
position |
string | ウィジェットの位置。 | 'right' | 'left' |
locale |
string | デフォルトの言語コード。 | ダッシュボード言語 | 'zh-CN' |
useBrowserLanguage |
boolean | ブラウザの言語を使用(localeを無視)。 |
false | true |
type |
string | ウィジェットタイプ。 | 'standard' |
'expanded_bubble' |
darkMode |
boolean | ダークモードを有効化。 | false | true |
baseDomain |
string | ベースドメイン(オプション、マルチドメイン用)。 | - | 'example.com' |
launcherTitle |
string | ランチャータイトル。 | - | 'サポート' |
showPopoutButton |
boolean | ポップアップボタンを表示。 | true | false |
welcomeTitle |
string | 歓迎タイトル。 | - | 'ようこそ!' |
welcomeDescription |
string | 歓迎の説明。 | - | 'どのようなご用件でしょうか?' |
availableMessage |
string | オンラインメッセージ。 | - | 'オンラインです。' |
unavailableMessage |
string | オフラインメッセージ。 | - | '後ほど返信いたします。' |
enableFileUpload |
boolean | ファイルアップロードを有効化。 | true | false |
enableEmojiPicker |
boolean | 絵文字ピッカーを有効化。 | true | false |
enableEndConversation |
boolean | 会話終了ボタンを有効化。 | true | false |
サンプルコード
<script>
// 1. sdk.jsをロードする前に、グローバル設定を行う(スクリプトの先頭に配置する必要があります)
window.livedeskSettings = {
// ウィジェット位置:左下(デフォルトは右下)
position: "left",
// 言語を簡体字中国語に強制(ブラウザが英語でも中国語を表示)
locale: "zh-CN",
// ブラウザの言語を自動検出(ユーザーのブラウザ言語を優先したい場合はtrueに設定し、上記のlocaleを削除)
// useBrowserLanguage: true,
// ウィジェットタイプ:expanded_bubble = 大きなバブル(歓迎語付き)、standard = クラシックな小さなバブル
type: "expanded_bubble",
// ダークモード(システムに従うか、強制的にダークモードにするか)
darkMode: "auto", // オプション値:true | false | "auto"
// 下部の小さなバブルアイコンを隠す(カスタムボタン内に配置する場合に最適)
hideMessageBubble: false,
// 右下の「ポップアップウィンドウ」の小さな矢印ボタンを隠す
showPopoutButton: false,
// カスタムランチャータイトル(大きなバブルモードで表示)
launcherTitle: "オンラインサポート",
// 歓迎メッセージ(expanded_bubbleモードで有効)
welcomeTitle: "こんにちは!どのようなご用件でしょうか?",
welcomeDescription: "通常、数分以内に返信いたします~",
// オンライン/オフライン時に表示されるヒントテキスト
availableMessage: "オンラインです、いつでも対応可能です",
unavailableMessage: "現在オフラインです、営業時間内にできるだけ早く返信いたします",
// 機能スイッチ
enableFileUpload: true, // ファイルアップロードを許可
enableEmojiPicker: true, // 絵文字の使用を許可
enableEndConversation: true, // ユーザーによる会話の能動的な終了を許可
// その他の高度なオプション(必要に応じてオンにする)
// showUnreadMessagesDialog: true, // 未読メッセージがある場合にポップアップで通知(デフォルトtrue)
// baseDomain: "yourcompany.com", // マルチドメイン展開時に使用
};
</script>
<!-- 2. livedesk Widget SDKのロード(独自のドメインとトークンに置き換えてください)-->
<script>
(function(d,t) {
var BASE_URL="https://www.engagelab.com"; // ← あなたのlivedeskアドレスに変更
var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=BASE_URL+"/packs/js/sdk.js";
g.defer = true;
g.async = true;
s.parentNode.insertBefore(g,s);
g.onload=function(){
window.livedeskSDK.run({
websiteToken: 'abcdefgh1234567890abcdefgh123456', // ← あなたのWebsite Tokenに変更
<script>
// 1. sdk.jsをロードする前に、グローバル設定を行う(スクリプトの先頭に配置する必要があります)
window.livedeskSettings = {
// ウィジェット位置:左下(デフォルトは右下)
position: "left",
// 言語を簡体字中国語に強制(ブラウザが英語でも中国語を表示)
locale: "zh-CN",
// ブラウザの言語を自動検出(ユーザーのブラウザ言語を優先したい場合はtrueに設定し、上記のlocaleを削除)
// useBrowserLanguage: true,
// ウィジェットタイプ:expanded_bubble = 大きなバブル(歓迎語付き)、standard = クラシックな小さなバブル
type: "expanded_bubble",
// ダークモード(システムに従うか、強制的にダークモードにするか)
darkMode: "auto", // オプション値:true | false | "auto"
// 下部の小さなバブルアイコンを隠す(カスタムボタン内に配置する場合に最適)
hideMessageBubble: false,
// 右下の「ポップアップウィンドウ」の小さな矢印ボタンを隠す
showPopoutButton: false,
// カスタムランチャータイトル(大きなバブルモードで表示)
launcherTitle: "オンラインサポート",
// 歓迎メッセージ(expanded_bubbleモードで有効)
welcomeTitle: "こんにちは!どのようなご用件でしょうか?",
welcomeDescription: "通常、数分以内に返信いたします~",
// オンライン/オフライン時に表示されるヒントテキスト
availableMessage: "オンラインです、いつでも対応可能です",
unavailableMessage: "現在オフラインです、営業時間内にできるだけ早く返信いたします",
// 機能スイッチ
enableFileUpload: true, // ファイルアップロードを許可
enableEmojiPicker: true, // 絵文字の使用を許可
enableEndConversation: true, // ユーザーによる会話の能動的な終了を許可
// その他の高度なオプション(必要に応じてオンにする)
// showUnreadMessagesDialog: true, // 未読メッセージがある場合にポップアップで通知(デフォルトtrue)
// baseDomain: "yourcompany.com", // マルチドメイン展開時に使用
};
</script>
<!-- 2. livedesk Widget SDKのロード(独自のドメインとトークンに置き換えてください)-->
<script>
(function(d,t) {
var BASE_URL="https://www.engagelab.com"; // ← あなたのlivedeskアドレスに変更
var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=BASE_URL+"/packs/js/sdk.js";
g.defer = true;
g.async = true;
s.parentNode.insertBefore(g,s);
g.onload=function(){
window.livedeskSDK.run({
websiteToken: 'abcdefgh1234567890abcdefgh123456', // ← あなたのWebsite Tokenに変更
このコードブロックはフローティングウィンドウ内に表示されます










