JSSを用いたカスタムレイアウトサービス構成の使用

レイアウトサービスのJSONレンダリングプロセスは非常に設定可能で、レイアウトサービスの特定の側面をカスタマイズできます。

jssレイアウトサービス構成の任意の要素をカスタマイズしたい場合は、ref属性を使って既存の構成をコピーし、その要素内でカスタマイズすることをお勧めします。これにより、アップグレード時にjss設定が変更された場合に設定の変更を減らすことができます。

!重要JSSで使用されるレイアウトサービスの設定を変更すると、オブジェクトの形状、シリアル化、プレースホルダー処理に変更が生じると、JSS SDKが破損し、JSSインポートプロセスの前提と矛盾することがあります。

シリアライゼーションの設定を変更することで、ユーザーが影響できないJSONデータを変更することができます。シリアライゼーションの設定を変更する際は、JSON出力全体を変更するか、フィールド名だけを変更することができます。例えば、フィールド名をキャメルケースにしたい場合に変更できます。

カスタム構成を定義した後、renderJsonRenderingパイプラインのリストに設定名を追加します。これを行うことで、デフォルトのjss設定で実行されるPlaceholderTransformerコードがカスタム設定でも実行されます。

!注このステップは、カスタム構成がデフォルトのJSS構成と形状が似ている場合にのみ関係します。カスタム構成がJSSと関連しない場合や、デフォルトのjss構成に依存していない場合は、このステップは不要です。

以下は、デフォルトのjss構成に基づくカスタムレイアウトサービス構成の「my-jss-config」のSitecore構成パッチです。

カスタム設定をパッチで取り付けた後、JSSアプリでlayoutServiceConfiguration属性を使って活用できます。

この設定名はクライアントコード内およびdataApiを使ってレイアウトサービスを呼び出す際にも必ず記載してください(前述の例を参照)。