JavaScriptスニペットを使用して、WalkMeをデプロイする

Last Updated 1月 30, 2024

概要

WalkMeスニペットは、WalkMeをサイトで実行できるようにするものです。 スニペットを含むページまたはブラウザは、サーバーでパブリッシュされたWalkMeファイルにアクセスでき、これによりユーザーは、コンテンツにアクセスして再生できます。

スニペットは、WalkMeがページで動作するために、ユーザーのブラウザで実行する必要があるJavaScriptコードです。 各スニペットは特定のWalkMeエディタのアカウントに関連付けられています。 WalkMeエディタでアイテムがパブリッシュされると、関連付けられたスニペットをブラウザで実行しているユーザーがアイテムにアクセスすることができます。

以下の手順に従って、スニペットを使用して、WalkMeをデプロイします。

デプロイメントガイド

1. スニペットコードを取得する

展開

スニペットコードは、WalkMeエディタから利用できます。 まだエディタをインストールしていない場合は、 これらの手順を参照してください。

  1. 設定メニューからシステム設定を開きます。

  2. [Snippet(スニペット)]タブを開きます
  3. ドロップダウンから環境を選択します(テスト/本番)
    • 環境には、わずかに異なるスニペットコードがあります
    • テスト/サンドボックス/ステージングサイトがある場合は、テストのスニペットを選択します
    • エンドユーザー向けにパブリッシュするためのスニペットを希望する場合は、本番のスニペットを選択します

      スニペット画面の環境は、メインのエディタビューと同じ環境を自動的に表示します。

  4. コードをコピーをクリックして、スニペットをコピーします

スニペットコードを取得できない場合は、サポートチームにお問い合わせください。

スニペットコードは、希望の機能向けにウェブサイトに追加する必要があるコードです。 スニペットをウェブサイトに直接インストールするには、アプリケーションのコードにアクセスする必要があります。

2. ウェブサイトのバックエンドにアクセスする

展開

ウェブサイトのバックエンドまたはコンテンツ管理システム(CMS)にログインします。

バックエンドへのアクセスについて馴染みがない場合、ウェブサイトの開発者または管理者にお問い合わせください。

3. ヘッダー/フッターセクションを探す

展開

ウェブサイトのヘッダーまたはフッターを編集できるCMSのセクションに移動します。

このセクションは通常、設定、外観、またはテーマのカスタマイズエリアにあります。

4. ヘッダー/フッターを編集する

展開

ヘッダー/フッターセクションで、カスタムコードまたはスクリプトを追加できるセクションを見つけます。

このセクションは、「カスタムスクリプト」、「ヘッダースクリプト」、「フッタースクリプト」、またはそれらと類似したもので表示されている場合があります。

5. スニペットコードを追加する

展開

スニペットコード(ステップ1でコピーされたもの)を、CMSのヘッダー/フッターセクションの指定された領域に貼り付けます。

必須:

  • WalkMeスニペットは、WalkMeに読み込むすべてのページのHTMLに配置する必要があります
  • WalkMeは、ページの読み込み時に、ユニークなユーザーID(UUID)をチェックします

ベストプラクティス:ログインページの後にスニペットを配置する

  • UUIDは、ユーザーがログインするまで使用できません。 希望のUUIDが利用できない場合は、ランダムに生成されたセッションIDが作成されます
  • ログインページで特定のコンテンツを作成する必要がある場合は、ログイン後にページの完全な読み込みが発生していることを確認してください。 これは、UUIDをキャプチャするために必要です
  • シングルページのアプリケーションの場合:WalkMeがログインページを読み込む場合、UUIDが読み込まれることを確実にするために、ログイン後にページの更新が必要になります

6. 変更を保存する

展開

  1. スニペットコードをCMSのヘッダー/フッターセクションに貼り付けた後に、変更を保存します
  2. このアクションには、「保存」、「更新」、または「パブリッシュ」ボタンを押すことが含まれる場合があります
  3. WalkMeがサイトで正しく読み込むためには、エディタから設定をパブリッシュする必要があります。 これにより、必要なファイルが生成され、WalkMeが適切に機能できるようになります

7. インストールを確認する

展開

  1. ウェブサイトにアクセスし、スニペットコードを動作させたい特定のページに移動します
  2. ページを調べて、希望の機能がアクティブになったことを確認します
  3. スニペットコードが期待通りに動作していないことに気づいた場合、コードの配置を再度確認してください
  4. それでも問題がある場合には、お気軽に当社のサポートチームに連絡してください

スニペットが配置されると、エディタからパブリッシュされたコンテンツ を確認できるようになります。 スニペットをテストし、それが正しく設定されていることを確認するには:

  1. サイトを開きます
  2. 右クリックして、ページの検査を選択します
  3. コンソールを開きます
  4. 以下のテキストクエリを入力します : _walkMe.getEnvId()
  5. このコマンドは、どの環境が読み込まれているかを示す値を返します。
    1. 0 = 本番
    2. 1 = プレビュー
    3. 2 = 再生
    4. 3 = テスト
    5. 未定義 = スニペットが適切に設定されていないため、サポートに連絡する必要があります

これで完了です。 ウェブサイトにスニペットコードを正常にインストールしました。 さらに質問がある場合、またはサポートが必要な場合は、お気軽にお問い合わせください。

🎓 Digital Adoption Institute

この記事は役に立ちましたか?

ご意見ありがとうございます!

Be part of something bigger.

Engage with peers, ask questions, share ideas

Ask the Community
×

アカウントタイプの選択

選ぶ
< 戻る

Mobile account login

< 戻る