Notiondesk Messenger は、Notiondesk ヘルプセンターを Web サイトまたは Web アプリケーションに直接組み込みます。
訪問者はMessengerを使って、ウェブサイトから離れることなく、ヘルプセンターの検索、記事の閲覧、AIアシスタントとのチャット、変更履歴の更新情報の確認、チームへの問い合わせを行うことができます。
このガイドでは、標準的なウェブサイトに Notiondesk Messenger をインストールする方法を説明します。
始める前に
Notiondesk Messenger をインストールする前に、以下のものを用意してください。
- Notiondesk ヘルプセンター
- Notiondesk で設定されたメッセンジャー
- ウェブサイトのコードまたはサイト全体のカスタムコード設定へのアクセス
- あなた独自の Notiondesk Messenger インストール スニペット
インストール方法を選択してください
ご使用のウェブサイトに合ったインストール方法を選択してください。
| ウェブサイトの種類 | 推奨される方法 |
|---|---|
| 標準HTMLまたは複数ページのウェブサイト | JavaScriptスニペット |
| React | Notiondesk Messenger SDK |
| Next.js | Notiondesk Messenger SDK |
| Vue | Notiondesk Messenger SDK |
| ヌクスト | Notiondesk Messenger SDK |
| その他のシングルページアプリケーション | Notiondesk Messenger SDK |
ほとんどの従来型ウェブサイトでは、JavaScriptスニペットが最も簡単なインストール方法です。
標準的なウェブサイトにメッセンジャーをインストールする
1. Messengerのインストールコードをコピーしてください。
Notiondesk でMessenger の設定を開き、「インストール」セクションを探してください。
Messenger用に生成されたインストールスニペットをコピーしてください。
コードの形式は次のとおりです。
YOUR_MESSENGER_ID は、ウェブサイトに読み込むべきメッセンジャーを識別します。
他のウェブサイトやアカウントからメッセンジャーIDをコピーするのではなく、自分のNotiondeskダッシュボードからスニペットをコピーしてください。
2. スニペットをウェブサイトに追加する
Messengerのスニペットを、閉じタグ</body>の直前に貼り付けてください。
ウェブサイトで共有レイアウト、テンプレート、フッター、またはサイト全体のカスタムコードセクションを使用している場合は、そこにスニペットを一度追加することで、ウェブサイト全体でMessengerが読み込まれるようになります。
Messengerを特定のページにのみ表示させたい場合は、そのページにのみスニペットを含めてください。
3. 変更内容を公開する
スニペットを追加したら、ウェブサイトを保存してデプロイまたは公開してください。
Messengerのコードは、公開されているウェブサイト上に必ず設置する必要があります。ローカル環境や非公開バージョンにのみコードを追加しても、訪問者はMessengerを利用できません。
<script
async
src="https://static.notiondesk.help/messenger/widget.js"
data-messenger-id="YOUR_MESSENGER_ID">
</script><body>
<!-- Your website -->
<script
async
src="https://static.notiondesk.help/messenger/widget.js"
data-messenger-id="YOUR_MESSENGER_ID">
</script>
</body>インストールを確認する
公開されているウェブサイトをブラウザで開いてください。
インストールが正常に完了すると、インストールコードを含むページで Notiondesk Messenger ランチャーが読み込まれます。
Messengerを開き、期待されるNotiondeskというコンテンツが表示されることを確認してください。
以下の項目をテストできます。
- Messengerの起動と終了
- ヘルプセンターを検索
- 記事を開く
- AIチャットボットが有効になっている場合は、AIとの会話を開始します。
- 有効にしている他のメッセンジャーセクションを開く
Messengerが表示されない場合は、ブラウザの開発者ツールを開き、ウィジェットが正常に読み込まれているかどうかを確認してください。
React、Next.js、Vue、Nuxt、およびSPA
React、Next.js、Vue、Nuxt、およびその他のシングルページアプリケーションでは、標準のスクリプトスニペットを手動で追加する代わりに、公式の@notiondesk-so/messenger-js-sdkパッケージを使用する必要があります。
パッケージのインストール方法:
Yarnまたはpnpmを使ってインストールすることもできます。
SDKは、以下の専用の統合機能を提供します。
npm install @notiondesk-so/messenger-js-sdk- JavaScriptとTypeScript
- React
- Next.js
- Vue
- ヌクスト
SDKには、Messengerの表示、非表示、切り替え、設定、および破棄を行うためのメソッドも用意されています。
フレームワーク統合では、クライアント側で Notiondesk Messenger を初期化する必要があります。サーバー側レンダリング中は Messenger SDK を初期化しないでください。
意図的に別々のメッセンジャーインスタンスを管理する場合を除き、標準のメッセンジャースニペットとSDKの両方を同じアプリケーションにインストールしないでください。
フレームワークの完全なセットアップについては、 「React と Next.js を使用して Notiondesk Messenger をインストールする」ガイドを参照してください。
トラブルシューティング
メッセンジャーが表示されません
以下の点を確認してください。
- Messengerのスニペットがページ上に存在することを確認してください。
- スニペットに正しい
data-messenger-idが含まれていることを確認してください。
- 最新のウェブサイトの変更が公開されたことを確認してください。
- デプロイ後にページを更新してください
- ブラウザのコンソールでJavaScriptまたはコンテンツセキュリティポリシーのエラーを確認してください。
- ネットワークパネルを確認し、
widget.jsがブロックされていないことを確認してください。
Messengerは一部のページには表示されますが、他のページには表示されません。
Notiondesk Messenger はインストール コードを含むページでのみ読み込まれます。
Messengerをすべてのページに表示させたい場合は、このコードスニペットをサイトのグローバルレイアウト、テンプレート、またはフッターに移動してください。
間違ったメッセンジャーが表示されます
data-messenger-id は、どの Notiondesk Messenger がロードされるかを決定します。
Notiondesk ダッシュボードの正しい Messenger からインストール スニペットを再度コピーしてください。
Messengerはコンテンツセキュリティポリシーによってブロックされています
制限の厳しいコンテンツセキュリティポリシー(CSP)によって、サードパーティのJavaScriptやネットワークリクエストの読み込みが妨げられる場合があります。Messengerスクリプトが存在するにもかかわらず読み込まれない場合は、ブラウザのコンソールでCSPエラーを確認してください。
サイトのコンテンツセキュリティポリシーでは、Notiondesk Messenger が必要とするリソースを許可する必要があります。
Messengerはページ更新後には動作しますが、SPAナビゲーション中は動作しません
シングルページアプリケーションは、通常のナビゲーション中にページ全体の再読み込みを行いません。
標準のインストールスニペットに頼るのではなく、React、Next.js、Vue、Nuxt、およびその他のSPAベースのアプリケーションには@notiondesk-so/messenger-js-sdkを使用してください。
識別されたユーザーが認識されません
バックエンドが有効で期限切れでない Notiondesk ユーザー トークンを生成していることを確認してください。
ブラウザのコード内でトークンを生成しないでください。
ユーザーがログアウトしたら、別のユーザーセッションを開始する前に、Messengerの設定からユーザートークンを削除するか、Messengerインスタンスを破棄してください。
メッセンジャーは別の要素の背後に隠れています
Messenger SDK は、カスタムの zIndex 構成をサポートしています。
Messengerランチャーまたはパネルの上に別の固定要素またはフローティング要素が表示されている場合は、Messengerのスタッキング値を増やしてください。