非同期通話とキャッシュの理解

Commerce Search結果によるAJAX呼び出しの表示

Commerce Search Resultsレンダリングは標準SXA Search Resultsレンダリングの拡張です。SXA Search結果レンダリングはSXA Searchサービス を利用してAJAXコールを行い、インデックスをクエリしてレンダリングするアイテムのリストを取得します。生成されたアイテムは設定されたレンダリングバリアントによってサーバーサイドで処理され、結果はマークアップとして返HTMLされます。

ProcessSearchItemsパイプラインはSXA Searchサービスの拡張ポイントです。設定されたスコープクエリから返されたアイテムを処理し、設定されたレンダリングバリアントがさらに処理する前に関連モデルを入力する役割を担います。このパイプラインを拡張して、Sitecoreアイテムを含むSearchItemパイプライン引数や、タイプオブジェクトのカスタムモデルを埋め込むことができます。ProcessSearchItemsパイプラインはPrepareSearchItemsというコマースプロセッサで拡張されています。このプロセッサはコマースエンジンから価格と在庫情報を取得し、データをProductSummaryViewModelに変換します。このモデルはCommerce Search Results Scribanテンプレートからo_model変数を使ってコンテンツのレンダリングにアクセスします。プロセッサがデータを実行・取得するかどうかは、設定や設定によって異なります。

ストアフロントの設定(/sitecore/Content///Settings/Commerce/Search Results Configuration)では、Commerce Search Resultsレンダリングでどのコールを使うか、いつ実行されるかを設定できます。「 価格と在庫情報を取得するために別のAJAXコールを使う 」チェックボックスはデフォルトでクリアされており、レンダリングは1回の呼び出しを行います。

このコールの一環として、コマースProcessSearchItemsプロセッサは価格および在庫データを実行・取得します。このデータは、レンダリングバリアントが処理される際に価格や在庫情報を出力するためにScribanテンプレートで使用されます。

Content Delivery Network(CDN)を使わない場合、パフォーマンスの観点から1回の通話を使うのが最も効率的な構成です。これは、クライアントブラウザからマークアップや価格・在庫情報を取得するためにAJAXコールが1回だけ行われるためです。ただし、CDNを使用している場合は、価格や在庫情報もキャッシュしていることに注意してください。これは望ましくない場合があります。なぜなら、価格や在庫は商品情報よりも頻繁に変動する傾向があるからです。

!注商品やプライスカードで価格を変更したり、すでにCDNでキャッシュされている特定の商品のプロモーションを追加したりしても、XCからCDNキャッシュを強制的にクリアする方法はありません。これらは別途行うか、カスタムスクリプトの一部として行うか、ビジネスツールとのカスタム統合として行う必要があります。このため、CDNを使用している場合は2つのAJAXコールを使用することを推奨します。

「 価格と在庫情報を取得するために別個のAJAXコール を使う」チェックボックスを選択すると、Commerce Search Resultsレンダリングはカタログ項目のリストをレンダリングする際に非同期のJavaScriptとAJAXの呼び出しを2回行います。

• 最初の呼び出しはインデックスを照会し、レンダリングするアイテムのリストを取得します。Commerce Search ResultsレンダリングはSXA Searchサービスを呼び出し、HTMLマークアップとしてアイテムを返し、レンダリングバリアントによってサーバー側で処理されます。Commerce ProcessSearchItemsプロセッサは価格や在庫データを取得したり、ProductSummaryViewModelを埋め込んだりするためにCommerce Engineを呼び出しません。価格やステータスの変動性が存在せず、カタログアイテムのリストや製品内容が比較的安定しているため、CDNを使用する場合は適切な有効期限でこのコールをキャッシュすることを推奨します。

• 2つ目の呼び出しは商業専用です。これはカタログ品目リストのマークアップを取得した後に行われ、商品リストの価格と在庫情報を取得するためにコマースエンジンで行われます。データはJSON形式で返されます。

  !注このコールをキャッシュすることは推奨しません。価格や株価情報は頻繁に変動する可能性が高いためです。

  このコールは最初の呼び出しと並行して行うことはできません。なぜなら、そのクエリパラメータの一つであるProduct IDのリストは、最初の呼び出しから取得した応答データに依存しているからです。このコールは、Product IDのリストが入力され、空でなくなった場合にのみ行われます。価格と在庫情報が受信されると、Knockout JSバインディングでマークアップにバインドされ、それに応じて更新されます。価格情報と在庫情報は、それぞれprice属性とstockLabel属性にバインドされます。2回目の通話のJavaScriptコードは*、/sitecore/Media library/Base Themes/Commerce Components Theme/Scripts/Catalog/catalog-commerce-search-results-model/*に保存されたcatalog-commerce-search-results-modelスクリプトに位置しています。

AJAXが呼ぶ製品リストおよびプロモート製品

製品リストレンダリングはAJAX呼び出しを1回のみ行います。この呼び出しは製品情報だけでなく価格や在庫情報も取得し、Knockout JSを使ってHTMLマークアップにバインドされたJSONとして返します。製品リストレンダリングには、CDインスタンスレベルで処理されるAJAXコールキャッシュのサポートが組み込まれています。

プロモート製品レンダリングはプロダクトリストのレンダリングに似ていますが、プロダクトリストの取得方法と、組み込みのAJAXコールキャッシュをサポートしていない点が異なります。

!注両方のレンダリングは、分散型およびジオロケーション型キャッシュ機能を活用するために、Content Delivery Network (CDN)を使用する際にAJAXコールキャッシュをサポートしています。 CDNキャッシュは、静的リソースがユーザーによりローカルなサーバーに保存されるため、組み込みキャッシュよりも優れています。AJAX通話のキャッシュがオンになると、コンテンツだけでなく価格や在庫情報もキャッシュされます。これは、商品コンテンツを価格や在庫情報の取得と別にキャッシュできるCommerce Search Resultsレンダリングに比べて柔軟性が劣ります。