概要
WalkMeスニペットは、WalkMeをサイトで実行できるようにするものです。 スニペットを含むページまたはブラウザは、サーバーでパブリッシュされたWalkMeファイルにアクセスでき、これによりユーザーは、コンテンツにアクセスして再生できます。
スニペットは、WalkMeがページで動作するために、ユーザーのブラウザで実行する必要があるJavaScriptコードです。 各スニペットは特定のWalkMeエディタのアカウントに関連付けられています。 WalkMeエディタでアイテムがパブリッシュされると、関連付けられたスニペットをブラウザで実行しているユーザーがアイテムにアクセスすることができます。
以下の手順に従って、スニペットを使用して、WalkMeをデプロイします。
注
- スニペットは、希望する機能用にウェブサイトに追加する必要があるコードの一部です
- スニペットをサイトに直接インストールするには、アプリケーションのコードにアクセスする必要があります。
🎓 Digital Adoption Institute
デプロイメントガイド
注
実装方法に応じて、スニペットコードまたはスニペットURLが必要になります。
1a. スニペットコードを取得する
展開
スニペットコードは、WalkMeエディタから利用できます。 エディタをインストールする方法を学びます。
- エディタで設定アイコンをクリックしてシステム設定を開きます
- スニペットタブに移動します
- ドロップダウンから正しい環境を選択します（テスト/本番）
- 各環境には微妙に異なるスニペットコードがあります
- テスト/サンドボックス/ステージングサイトがある場合は、テストスニペットを選択します
- エンドユーザーに公開するスニペットが必要な場合は、本番スニペットを選択してください
- コードをコピーをクリックして、スニペットをコピーします
1b スニペットURLを取得します
展開
スニペットURLは、WalkMeエディタから利用できます。 エディタをインストールする方法を学びます。
- エディタで設定アイコンをクリックしてシステム設定を開きます
- スニペットタブに移動します
- ドロップダウンから正しい環境を選択します（テスト/本番）
- 各環境には微妙に異なるスニペットコードがあります
- テスト/サンドボックス/ステージングサイトがある場合は、テストスニペットを選択します
- エンドユーザーに公開するスニペットが必要な場合は、本番スニペットを選択してください
- 「walkme.src=」の後に表示される値をコピーします 例：「https://cdn.walkme.com/users//walkme__https.js」
2a ウェブサイトのバックエンドにスニペットを追加する
展開
- ウェブサイトのバックエンドまたはコンテンツ管理システム（CMS）にログインします
- ウェブサイトのヘッダーまたはフッターを編集できるCMSのセクションに移動します
- カスタムコードまたはスクリプトを追加できるセクションを見つけます
- スニペットコード（ステップ1でコピーされたもの）を、CMSのヘッダー/フッターセクションの指定された領域に貼り付けます
ヒント
- ヘッダー/フッターセクションは、通常、設定、外観、テーマのカスタマイズエリアにあります
- このセクションは、「カスタムスクリプト」、「ヘッダスクリプト」、「フッタースクリプト」などと呼ばれます
- バックエンドへのアクセス方法がよくわからない場合は、ウェブサイト開発者または管理者に相談してください
必須
- WalkMeスニペットは、WalkMeに読み込むすべてのページのHTMLに配置する必要があります
- WalkMeは、ページの読み込み時に、ユニークなユーザーID（UUID）をチェックします
ベストプラクティス：ログインページの後にスニペットを配置する
- UUIDは、ユーザーがログインするまで使用できません
- 希望のUUIDが利用できない場合は、ランダムに生成されたセッションIDが作成されます
- ログインページで特定のコンテンツを作成する必要がある場合は、ログイン後に完全にページが読み込まれていることを確認してください - これはUUIDをキャプチャするために必要です
- シングルページのアプリケーションの場合：WalkMeがログインページを読み込む場合、UUIDが確実に読み込まれるように、ログイン後にページの更新が必要になります
重要な注意事項
- ページごとにスニペットを 1 つだけ追加する必要があります
- スニペットを追加する場合、何も変更しないようにしてください
- 変更を行うと、意図しない問題が発生する可能性があり、WalkMeが実装をサポートできません
2b. アプリケーションの設定にスニペットを追加する
展開
- アプリケーション設定で検索対象のWalkMeを探してください（WalkMeインテグレーション対象）
- スニペットURLコード（ステップ1でコピーされた）を指定されたエリアに貼り付けます
ヒント
- スニペットURLのみをコピーしたことを確認してください
- このセクションは、通常、設定または構成エリアにあります
- このアクセス方法がよくわからない場合は、管理者に相談してください
3. 変更を保存する
展開
CMSとWalkMeエディタで変更内容を保存します。
- スニペットコードを貼り付けた後、サイトまたはアプリケーションの変更を保存してください
- このアクションには、「保存」、「更新」、「公開」ボタンを押すことが含まれる場合があります
- エディタでシステム設定に移動します
- 一般タブで、設定の公開をクリックします
注
WalkMeがサイトで正しく読み込むためには、エディタから設定をパブリッシュする必要があります。 これにより、必要なファイルが生成され、WalkMeが適切に機能できるようになります。
4. インストールを検証する
展開
- ウェブサイトにアクセスし、スニペットコードを動作させたい特定のページに移動します
- ページを調べて、希望の機能がアクティブになったことを確認します
- スニペットコードが期待通りに動作していないことに気づいた場合、コードの配置を再度確認してください
- それでも問題がある場合は、サポートチームに問い合わせることができます
スニペットが配置されると、エディタからパブリッシュされたコンテンツ を確認できるようになります。 スニペットをテストし、それが正しく設定されていることを確認するには：
- サイトを開きます
- 右クリックして、ページの検査を選択します
- コンソールを開きます
- 以下のテキストクエリを入力します : _walkMe.getEnvId()
- このコマンドは、どの環境が読み込まれているかを示す値を返します。
- 0 = 本番
- 1 = プレビュー
- 2 = 再生
- 3 = テスト
- 未定義 = スニペットが適切に設定されていないため、サポートに連絡する必要があります
これで完了です。 ウェブサイトにスニペットコードを正常にインストールしました。 さらに質問がある場合、またはサポートが必要な場合は、お気軽にお問い合わせください。
注
スニペットコードを取得できない場合は、サポートチームにお問い合わせください。
