WalkMeスニペットおよびデプロイ方法の概要

Download as PDF

スニペットとは？

スニペットとは、WalkMeをサイトに表示できるようにするJavaScriptコードのことです。 WalkMeエディタの各アカウントには、独自のスニペットコードがあり、エディタからアクセスできます。

環境

テストサイトがある場合、WalkMeアイテムを本番サイトでエンドユーザーにパブリッシュする前に、まずはテストサイトにパブリッシュすることができます。 スニペットは環境ごとに微妙に異なります。 スニペットは環境ごとに異なるため、環境ごとに個別にデプロイする必要があります。

テスト（またはサンドボックスまたはステージング）サイトのテスト用スニペットをデプロイすると、テストにパブリッシュされたアイテムがテストサイトに表示されます。 同様に、サイトに本番用スニペットをデプロイすると、本番にパブリッシュされたアイテムが本番サイトに表示されます。

また、個々のビジネスニーズに合わせてカスタム環境を作成することもできます。詳細については、こちらをご覧ください。

スニペットはどこにありますか？

1. エディタメニュー内で［スニペット］を選択します
2. 環境を選択します
   • 各環境には微妙に異なるスニペットコードがあります。 テスト/サンドボックス/ステージングサイトがある場合は、テスト用のスニペットをコピーします。 エンドユーザー向けにパブリッシュするためのスニペットが必要な場合は、本番用のスニペットをコピーします。
     
3. スニペットコードをコピーします。
   
4. WalkMe Enabled（WalkMeの有効化）トグルの切り替え
   • 緊急の理由から、あらゆる環境のWalkMeを無効にする必要がある場合は、［WalkMe Enabled（WalkMeの有効化）］トグルをクリックするだけで対応できます。 オフに切り替えると、WalkMeスニペットは非アクティブ化されます。

スニペットをデプロイする方法

デプロイはITチームが行う簡単な1回限りのタスクです。

WalkMeスニペットをデプロイする方法はいくつかあります。 正しい方法はアプリケーションの仕様により異なります。 これらのオプションの詳細については以下の各リンクをクリックしてください。

1. アプリケーションのHTMLにアクセスできる場合は、WalkMeコンテンツを表示する各ページのheadタグにスニペットを貼り付けることを推奨します。詳細はこちらをご覧ください。
2. アプリケーションのHTMLにアクセスできない場合（または何らかの理由でHTMLを変更したくない場合）は、プレーヤーブラウザー拡張機能を大量にデプロイしてスニペットを挿入することを推奨します。詳細はこちらをご覧ください。
3. スニペット挿入プロセスを迅速に進める3つめのオプションは、Googleタグマネージャーを使用することです。詳細はこちらをご覧ください。

スニペットを追加した後、WalkMeエディタから関連するすべての環境に対して設定のパブリッシュ（［Settings（設定）］>［Publish Settings（設定をパブリッシュ）］）を行ってファイルを生成し、WalkMeがサイトに正しく読み込まれるようにします。 設定をパブリッシュしないと、WalkMeファイルは正しく読み込まれず、コードのネットワークリクエストに403エラーが表示されます。

スニペットが機能していることを確認するにはどうすればよいですか？

スニペットを配置すると、パブリッシュされたコンテンツがエディタに表示されます。 スニペットをテストして、正しく設定されていることを確認するには以下を実行します。

1. サイトを開きます。
2. 右クリックして、ページの検証を選択します。
3. コンソールを開きます。
4. 以下のテキストクエリを入力します。 _walkMe.getEnvId()
   • このコマンドは、どの環境が読み込まれているかを示す値を返します。
     0=本番
     1=プレビュー
     2=再生
     3=テスト
   • 未定義が返ってくる場合、スニペットが正しく設定されていません。サポートにお問い合わせください