diff --git a/js-sdk/widget.md b/js-sdk/widget.md index fc09ca7..43c6ac3 100644 --- a/js-sdk/widget.md +++ b/js-sdk/widget.md @@ -2,26 +2,26 @@ ### 概要 -チャットウィジェットを表示するためのJavascript APIです。 +任意のウェブサイトに、チャットウィジェットを表示するための JavaScript API です。 -* JS SDKのoptions部分にログイン情報やユーザ情報を追加できます。 +* ログイン情報やユーザ情報を追加できます。 * ユーザ情報は接客管理サイトの「来訪者詳細」に表示されます。 * ユーザ情報のキーワードは接客管理サイトの「マスターキーワード」に自動登録されます。 ### 対象 * 来訪者用のチャットウィジェットを導入するウェブサイトがある -* HTML / JavaScriptに関する基本的な知識がある +* HTML / JavaScript に関する基本的な知識がある -## JS SDKの導入 +## JS SDK の導入 -1. JS SDKの読み込み +1. JS SDK の読み込み 2. チャットウィジェットの表示 -### JS SDKの読み込み方法 +### JS SDK の読み込み方法 ```markup - + ``` * `` 内に記載 @@ -31,35 +31,67 @@ ```javascript ``` * `` 直後に記載 -* ① ウィジェットID - * ウィジェットIDは、接客管理サイトにて、「ウィジェット」管理ページにて、取得することができます。 -* ② OK SKYシステムのURL - * 接客管理サイトのURLから取得することができます。 - * `https://から始まり、/で終わる` 形で、 `https://{OK SKYシステムのFQDN}/` の形になります。 +* ① ウィジェット ID + * ウィジェット ID は、接客管理サイトの「ウィジェット」管理ページで取得することができます。 +* ② OK SKY システムの URL + * 接客管理サイトの URL を指定します。 + * `https://から始まり、/で終わる` 形で、 `https://{OK SKYシステムの FQDN}/` の形になります。 -### GA\(Google Analytics\)でトラッキングする +### GA\(Google Analytics\) でトラッキングする ```javascript ``` -* オプションとして、 `ga_client_code` をキーとして、トラッキングコードを設定します。 +* オプションに `{"ga_client_code", "トラッキングID"}` を設定します。 +* トラッキング ID には Google アナリティクスで作成した `UA-********-*` 形式の文字列が入ります。 + +### チャットウィジェットを開くボタンを表示させないようにする + +```javascript + +``` + +* チャットウィジェットを開くためのボタンとして、OK SKY が提供するデフォルトのボタンは表示せず、ご自身でデザインしたボタンを使いたい場合、この機能を利用します。 +* `chatWidget.show()` の引数に `{"hideButton":true}` を指定することで、チャットウィジェットを開くボタンを表示させないようにすることができます。 +* この引数を指定することでデフォルトのボタンは表示されなくなります。 `widget.onReady()` イベントのコールバックによって代わりのボタンを表示するとともに、そのボタンのイベントに `chatWidget.widget.open()` を割り当てる必要があります。 +* チャットウィジェットを開くボタンとポップアップウィンドウのどちらも表示させない場合は `{"hideButton":true,"hidePopup":true}` のように指定します。 + +### ポップアップウィンドウを表示させないようにする + +```javascript + +``` + +* チャットウィジェットが閉じた状態でメッセージを受信した際、ポップアップウィンドウによって受信したメッセージが表示されますが、これを表示させない場合にこの機能を利用します。 +* `chatWidget.show()` の引数に `{"hidePopup":true}` を指定することで、チャットウィジェットが閉じた状態でメッセージを受信した際に表示されるポップアップウィンドウを表示させないようにすることができます。 +* チャットウィジェットを開くボタンとポップアップウィンドウのどちらも表示させない場合は `{"hideButton":true,"hidePopup":true}` のように指定します。 ## ログイン情報 / ユーザ情報の追加方法 -ログイン方法やユーザ情報は `OkskyChat()` 関数の第三引数に追加します。 上の導入手順のコードに当てはめた場合、以下のようになります。 +ログイン方法やユーザ情報は `OkskyChat()` 関数の第三引数 `options` に追加します。 上の導入手順のコードに当てはめた場合、以下のようになります。 ```javascript