検索アダプタからPLP ウィジェットへの移行
検索アダプターはLive Search 4.0.0時点で非推奨であり、セキュリティ更新プログラムのみを受け取ります。 製品リストページ (PLP) ウィジェット は、今後Live Searchのすべての実装でサポートされるソリューションです。 このガイドでは、移行が簡単な場合と、追加作業が必要な場合について説明します。
前提条件
移行プロセスを開始する前に、環境がこれらの要件を満たしていることを確認してください。
移行を開始する前に:
技術要件:
- Adobe Commerce 2.4.4以降。
- Live Search拡張機能がインストールされました。
- コマンドライン(CLI)へのアクセス。
- Commerce管理者へのアクセス。
- テスト用のステージング環境またはQA環境。
バックアップと準備:
- データベースとコードをバックアップします。
- 現在のカスタマイズを文書化する。
- 制限と制限を確認して、PLP ウィジェットがニーズを満たしていることを確認します。
- 低トラフィック期間に移行をスケジュールします。
- ストアフロント行動の変更が発生する可能性があることを関係者に通知します。
現在の実装を確認:
- 現在のLive Search バージョンを確認してください。
- 使用されているファセットとその設定を文書化します。
- あらゆる検索機能をテストし、期待される動作をドキュメント化します。
- 現在の検索結果プレゼンテーションのスクリーンショットを撮影します。
バージョンの互換性:
- Adobe Commerce 2.4.4以降を実行している。
- Live Search 4.0.0以降にアップグレードする準備ができました。
移行シナリオ
容易な移行(追加作業は不要)
実装が次のすべての条件を満たす場合は、PLP ウィジェットに直接移行できます。
標準のLuma ベースのストアフロント:
- Luma テーマまたは最小限のカスタマイズでLumaから継承するテーマを使用している。
- PLP レイアウトまたはテンプレートにカスタム変更を行っていません。
- 検索結果を操作するカスタム JavaScript拡張機能を作成していません。
標準商品カタログ:
- すべての製品属性では、標準ソースモデルを使用します(カスタムソースモデルは使用しません)。
- 特別なレンダリングロジックを必要とするカスタム製品タイプはありません。
- カタログでは、標準ファセットとフィルタリングのみを使用します。
標準統合:
- AnalyticsにGoogle Tag Manager (GTM)を使用していません。
- 検索動作を変更するサードパーティの拡張機能を使用していません。
実装がこれらの条件に一致する場合は、標準の移行手順に進みます。
追加作業を必要とする移行
実装に次のいずれかが含まれている場合は、追加作業が必要です。
カスタムテーマの変更:
- Luma テンプレートを上書きするカスタム PLP レイアウト。
- 検索アダプタ固有の要素をターゲットとするカスタム CSSまたはJavaScript。
- PLPまたは関連ファイルに対するカスタムテンプレートの変更。
- テーマはLumaから継承されません(たとえば、最初からカスタムテーマを継承します)。
カスタム製品属性:
- ファセットとして使用されるカスタムソースモデルを持つ製品属性。
- 特別な表示要件を持つカスタム製品タイプ。
"is_user_defined": falseのプログラム属性。
高度な統合:
- Google Tag Manager (GTM)は、トラッキングに積極的に使用されます。
- 検索に統合されたサードパーティの分析ツールまたはパーソナライゼーションツール。
- カスタムイベント追跡またはデータレイヤーの実装:
- 外部検索やレコメンデーションエンジンとの統合。
ヘッドレスまたはPWAの実装:
- ヘッドレスアーキテクチャ(PWA Studio、Vue Storefrontなど)の使用。
- カスタムフロントエンドフレームワーク(React、Vue、Angular):
- カタログクエリにのみGraphQLを使用する。
- カスタムストアフロントイベントの実装:
カスタムウィジェットコード:
- 以前に検索アダプターコードをカスタマイズしました。
- 独自のCDNでウィジェットのカスタムバージョンをホスティングする。
- 検索機能のためのカスタムJavaScript拡張機能。
実装にこれらのシナリオがある場合は、複雑な移行シナリオ を参照してください。
標準的な移行手順
特別なカスタマイズを行わない実装の場合は、次の手順に従います。
手順1: Live Searchのアップグレード
PLP ウィジェットにアクセスするには、Live Search拡張機能をバージョン 4.0以降にアップグレードしてください。
役割: マーチャントまたはパートナー
-
現在のLive Search バージョンを確認してください:
code language-bash composer show magento/live-search | grep version -
バージョン 3.x以前の場合は、アップグレードする前にAdvancedSearch モジュールを有効にします。
code language-bash bin/magento module:enable Magento_AdvancedSearch -
composer.jsonを更新して、Live Search 4.0以降を必要とします。code language-json "require": { "magento/live-search": "^4.0" } -
アップグレードを実行します。
code language-bash composer update magento/live-search --with-dependencies -
セットアップ アップグレードを実行して再コンパイルします。
code language-bash bin/magento setup:upgrade bin/magento setup:di:compile -
必要に応じて、静的コンテンツをデプロイします。
code language-bash bin/magento setup:static-content:deploy
手順2: PLP ウィジェットを有効にする
Commerce AdminでPLP ウィジェットを設定します。
役割:マーチャント
PLP ウィジェットは、Live Search 4.0.0以降の新規インストールでデフォルトで有効になっています。 以前のバージョンからアップグレードする場合:
- Stores / 設定/ Configurationに移動します。
- Live Search > Storefront Featuresに移動します。
- Storefront Features セクションを展開します。
- Enable Product Listing Widgetsを はい に設定します。
- Save Configをクリックします。
- キャッシュをフラッシュします:System > ツール > Cache Management > Flush Magento Cache。
ステップ 3:ステージングのテスト
本番稼働前に、非本番環境での移行を検証します。
役割: マーチャント/パートナー
本番環境にデプロイする前に、検索機能を徹底的にテストします。
機能テスト:
- 検索結果が正しく表示されることを確認します。
- 設定済みのすべてのファセットをテストします。
- カテゴリーナビゲーションの動作を確認します。
- 結果を通じてページネーションをテストします。
- 並べ替えオプションが期待どおりに機能することを確認します。
- シンプルな商品のカートへの追加機能をテストします。
ビジュアルテスト:
- 商品画像が正しく表示されることを確認してください。
- 商品名と価格が適切に表示されていることを確認する。
- カラースウォッチをテストします(使用する場合)。
- モバイルデバイスでのレスポンシブ動作を確認します。
- スタイルがブランドに一致することを確認します。
パフォーマンステスト:
- ページ読み込み時間の測定。
- 現実的なカタログサイズでテストする。
- サーバーリソースの使用状況の監視:
- ブラウザーコンソールでJavaScript エラーを確認します。
手順4:実稼動環境へのデプロイ
検証済みの設定をライブストアフロントに移動します。
役割: マーチャント/パートナー
- 可能であれば、メンテナンスウィンドウ中にデプロイメントをスケジュールします。
- 標準的なデプロイメントプロセスに従います。
- 実稼動環境でを使用してPLP ウィジェットを有効にする手順2: PLP ウィジェットを有効にする。
- デプロイメント直後に問題がないか監視します。
- 重要な問題が発生した場合は、ロールバックプランを準備します。
手順5:検証と監視
移行後の検索パフォーマンスと顧客体験を追跡します。
役割:マーチャント
デプロイメント後、主要な指標を監視します。
- 検索結果ゼロ率
- 検索からカートへのコンバージョン率
- ページ読み込みパフォーマンス
- 顧客からのフィードバック/サポートチケット
- ブラウザーコンソールでのJavaScript エラー
複雑な移行シナリオ
次のシナリオでは、標準の移行手順を超えて、追加の計画、カスタム開発、または専用サポートが必要です。
レイアウト変更機能を備えたカスタムテーマ
このシナリオでは、デフォルトの製品リスト動作を上書きするカスタムテンプレートまたはレイアウトがあります。
役割:開発者/パートナー
-
監査のカスタマイズ:
- テーマ内のすべてのカスタムレイアウト XML ファイルを文書化します。
- 商品リストページや関連ファイルへのカスタムテンプレートの変更を確認できます。
- スタイル設定に使用するカスタム CSS クラスを特定します。
- Adobe JavaScriptのカスタムインタラクションのドキュメント化。
-
CSS ベースのカスタマイズへの移行:
- PLP ウィジェットは特定のCSS クラスを使用します(PLP スタイルガイド を参照)。
- PLP ウィジェット CSS クラスを使用してビジュアルカスタマイズを再作成します。
- カスタムスタイルが正しく適用されるかどうかをテストします。
-
競合するカスタマイズを削除:
- 製品リスト構造を変更するレイアウト XMLを削除します。
- 検索アダプタ固有の要素をターゲットとするJavaScriptをクリーンアップします。
- ウィジェットのレンダリングと競合するテンプレートの上書きを更新します。
-
徹底的にテストする:
- すべてのビジュアルカスタマイズがPLP ウィジェットで機能することを確認します。
- レイアウトの競合がないようにする:
- あらゆるブレイクポイントとデバイスをまたいでテスト。
カスタムソースモデルを使用した製品属性
このシナリオでは、検索アダプターではサポートされていないがPLP ウィジェットでサポートされているカスタムソースモデルで製品属性を使用するファセットがあります。
役割: マーチャント (管理者設定)
-
影響を受ける属性を特定:
- ファセットとして使用される製品属性を確認します。
- カスタムソースモデルを使用するものを特定:
- 現在のファセット設定を文書化します。
-
アップグレードしてPLP ウィジェットを有効にする:
- 標準の移行手順に従います。
- PLP ウィジェットは、カスタムソースモデル属性をサポートしています。
-
ファセットの再構成:
- Marketing / SEOと検索/ Live Searchに移動します。
- 影響を受ける属性のファセット設定を確認します。
- カスタムソースモデルでファセットを正しくテストする。
-
検証:
- カスタムソースモデルファセットを使用したテストフィルタリング。
- すべての属性値が正しく表示されることを確認します。
- パフォーマンスが適切であることを確認する。
Google Tag Manager (GTM)の統合
このシナリオでは、PLP ウィジェットを有効にするとGTMが失敗する既知の問題があります。
役割:開発者/パートナー+顧客エンジニアリング
オプション 1:検索アダプターで続行(暫定のみ)
- GTMがビジネスに不可欠な場合、検索アダプタを有効のままにします。
- セキュリティ更新プログラムのみが受け取られることを理解します。
- GTMの互換性が解決されたら、移行する予定です。
- GTMの互換性に関する最新情報については、Adobe サポートにお問い合わせください。
オプション 2: GTM トラッキングを別のアプローチに移行
-
カスタムイベントコレクションを実装:
- Storefront Events SDKを使用します。
- 検索イベントや商品インタラクションイベントを収集します。
- GTM データレイヤーにイベントを手動でプッシュします。
-
次の手順を実行します:
- 現在のGTM トラッキング要件を監査します。
- GTM イベントをストアフロントイベントにマッピングします。
- カスタムイベントリスナーを実装します。
- GTMへのデータフローをテストする。
- 分析レポートの検証:
選択肢3:GTMをAdobe Analyticsに置き換える
- 該当する場合は、Adobe Analyticsへの移行を検討してください。
- ガイダンスについては、カスタマーエンジニアリングにお問い合わせください。
お問い合わせ先: GTM互換性の更新またはカスタマーエンジニアリングのサポートに関するサポートチケットを送信します。
シナリオ:ヘッドレスまたはPWAの導入
このシナリオでは、カスタムイベント収集を必要とするヘッドレスストアフロントまたはPWA ストアフロントがあり、標準のPLP ウィジェット UIを使用できません。
役割:開発者/パートナー
-
参照実装を確認:
- PLP ウィジェットのソースコード を調べます。
- Live Search GraphQLのAPI ドキュメントを確認してください。
- カタログサービスクエリ について説明します。
-
カスタム UIを実装:
- クエリにLive Search GraphQL APIを使用します。
- カスタム製品リストコンポーネントの構築。
- ファセットのUIを実装します。
- ページ分割と並べ替えを処理します。
-
イベントコレクションを実装:
-
ストアフロントイベントのドキュメント を確認します。
-
必要なイベントを実装します。
search-request-sentsearch-response-receivedsearch-results-viewproduct-page-viewadd-to-cart
-
Adobe Commerceへのイベントデータフローをテストします。
-
-
ファセットの並べ替えを設定:
- ヘッドレス実装の場合、ファセットはカウント別に並べ替えることができます。
- Live Search > Facets ワークスペースで設定します。
- より優れたユーザーエクスペリエンスを実現するために、Sort Typeを カウント に設定します。
-
テストと検証:
- 検索結果の正確性を検証:
- ファセット機能のテスト:
- イベントが正しく追跡されていることを確認します。
- パフォーマンス指標の監視:
- インテリジェントなマーチャンダイジング機能の検証。
シナリオ:カスタムウィジェットコードの変更
このシナリオでは、以前に検索アダプターまたはウィジェットコードをカスタマイズしたことがあるので、カスタマイズを移行する必要があります。
役割:開発者/パートナー
-
既存のカスタマイズを文書化:
- 検索アダプタに対して行われたすべてのカスタマイズを一覧表示します。
- 各カスタマイズを促すビジネス要件を特定する。
- カスタマイズがまだ必要かどうかを判断します。
-
組み込み機能がユーザーのニーズを満たしているかどうかを確認する:
- PLP ウィジェット機能を確認します。
- CSS ベースのカスタマイズで十分かどうかを確認します。
- デフォルトのPLP ウィジェットの動作をテストします。
-
カスタムコードがまだ必要な場合:
- PLP ウィジェット リポジトリ を複製します。
- カスタマイズ機能の実装。
- 自社のCDNでホストする。
- カスタムウィジェットを使用するようにCommerce設定を更新します。
note warning WARNING リポジトリのコードを使用してPLP ウィジェットをカスタマイズする場合は、メンテナンスと更新を担当します。 Adobeの新しいPLP ウィジェット機能は、カスタマイズと互換性がない可能性があります。 -
徹底的にテストする:
- あらゆるカスタム機能をテスト。
- Commerceのアップデートでカスタマイズが解除されないようにします。
- カスタム実装のドキュメンテーション。
- 継続的なメンテナンス計画。
既知の制限事項とエッジケース
移行する際は、次の制限事項に注意してください。
PLP ウィジェットの制限事項:
- 並べ替え順序: PLP ウィジェットが有効になっている場合、製品リストページの並べ替え順序を変更できません(昇順/降順)。
- 買い物かごに追加:「買い物かごに追加」ボタンは、ウィジェットのシンプルな商品でのみ使用できます。
- 階層の価格: PLP ウィジェットではサポートされていません。
- VAT表示:価格にはVATが含まれていますが、VATを別の値として表示することはできません。
検索アダプタとの機能の違い:
- 色見本: スウォッチが正しく機能するには、
color属性にcolorとまったく同じスペルを入力する必要があります(「色」またはカスタム名ではありません)。 - テーマのスタイル設定:カスタムテーマクラスはウィジェットによって継承されません。ウィジェット固有のCSS クラスをターゲットにする必要があります。
- カスタム製品タイプ: ウィジェットではサポートされていません。
パフォーマンスに関する考慮事項:
- 大規模なカタログ(5万以上の製品)では、最初のページ読み込みが長くなる可能性があります。
- 多くの値を持つ複数のファセットは、パフォーマンスに影響を与える可能性があります。
- モバイルデバイスのパフォーマンスは、カタログのサイズによって異なる場合があります。
互換性の問題:
- Google Tag Managerの互換性の問題(GTM シナリオ を参照)。
- 一部のサードパーティの拡張機能は、PLP ウィジェットと競合する可能性があります。
- カスタムチェックアウト拡張機能には更新が必要な場合があります。
ヘルプの取得
特定のニーズに基づいて適切なリソースに連絡します。
Adobe サポートでは、次のサポートを提供できます。
- 標準のライブサーチ移行手順
- PLP ウィジェット設定の問題
- ファセットまたは属性のインデックス作成の問題
- デフォルト実装でのパフォーマンスの問題
- アップグレードエラー
開発パートナー/システムインテグレーターに連絡する必要があります:
- カスタムテーマの変更
- カスタムウィジェットコード実装
- サードパーティ製の拡張機能との互換性
- ヘッドレスおよびPWAの導入
- カスタムイベントトラッキング
Adobe サポートにお問い合わせするには、 ヘルプセンターユーザーガイド を参照してください。
FAQ
検索アダプタからPLP ウィジェットへの移行に関するよくある質問に対する回答を見つけます。
Q:検索アダプタにバグ修正や機能アップデートが適用されますか?
A:いいえ。 検索アダプターは非推奨(廃止予定)であり、セキュリティ更新のみを受け取ります。 バグ修正、パフォーマンスの改善、新機能は、PLP ウィジェットでのみ使用できます。 検索アダプタで問題が発生した場合は、PLP ウィジェットへの移行が推奨されます。
Q:移行によってストアフロントが中断されますか?
A: ステージングで適切なテスト手順に従う場合、移行はシームレスである必要があります。 本番環境への導入に向けてロールバックプランを準備する。
Q:移行にはどのくらいの時間がかかりますか?
A:標準実装の場合:1~2時間。 カスタム実装の場合:複雑さによっては1~4週間かかります。
Q:検索マーチャンダイジングルールは引き続き機能しますか?
A:はい。Live Search ワークスペースで設定されたすべての検索マーチャンダイジングルール、類義語、ファセットは、引き続きPLP ウィジェットと連携します。
Q: ファセットを再構成する必要がありますか?
A:通常は使用できませんが、検索アダプタを使用するカスタムソースモデル属性によって制限されていた場合は、PLP ウィジェットで使用できるようになりました。
Q: カスタム CSSについて教えてください。
A: PLP ウィジェットクラスをターゲットにするには、CSSを更新する必要があります。 CSS クラス参照を参照してください。
Q:検索パフォーマンスに影響しますか?
A: PLP ウィジェットはパフォーマンスが高いように設計されています。 多くの顧客は、同等またはより優れたパフォーマンスを期待しています。 大きなカタログはステージングでテストする必要があります。