Shopifyテーマ情報アクセスの更新について

今回、Shopifyのテーマ情報にアクセスするための方法が大きく変わります。これまでBOOMR変数を使用してテーマの識別やカスタマイズを行っていた開発者の皆様は、新たな方法への移行を始める必要があります。具体的には、window.Shopify.themeのプロパティを使用するようになります。

BOOMRスクリプトの廃止

BOOMR(Boomerang)JavaScriptライブラリは、ストアフロントのWebパフォーマンスデータ収集に使用されていましたが、より軽量で準拠性の高いライブラリに置き換えられました。テーマやアプリ開発者の一部では、BOOMRが設定したいくつかの変数に依存していました。これらの変数には次のものがあります。


BOOMR.themeName
BOOMR.themeVersion

これらの変数は2025年1月31日まで利用可能です。その後は、新しい方法でテーマ情報にアクセスする必要があります。

Enhanced Theme Informationの導入

開発者からのフィードバックに応え、window.Shopify.themeオブジェクトを強化します。今後、次の2つの新しいプロパティが追加されます。


schema_name
schema_version

これらは、それぞれテーマのsettings_schema.jsonからname属性とversion属性を反映します。これらの追加は、Shopifyグローバルオブジェクトから直接テーマ情報にアクセスするための、標準化され信頼性の高い方法を提供することを目指しています。

新しい方法の利用手順

新たな方法への移行は以下の手順で行います。

1. window.Shopify.theme.schema_namewindow.Shopify.theme.schema_versionを使用してテーマ情報にアクセスします。 2. BOOMR変数の代わりにこれらの新しいプロパティを使用してテーマを識別し、カスタマイズします。 3. 既存のコード内でBOOMR変数が使用されている場合は、これらを新しいプロパティに置き換えます。

パフォーマンス・コスト分析

新しい方法は、BOOMRスクリプトを使用するよりも軽量であり、ストアフロントのパフォーマンスを改善します。また、新しい方法はBOOMRスクリプトよりも準拠性が高く、信頼性が向上します。

実装時の注意点・ベストプラクティス

新しい方法への移行は2025年1月31日までに完了する必要があります。BOOMR変数はこの日をもって利用不可となります。また、新しい方法が提供する情報に依存する機能を開発する際は、BOOMR変数ではなく新しいプロパティを使用するようにしてください。

次のステップ・発展案

新しい方法を使用してテーマの識別やカスタマイズを行うことで、より高速で信頼性の高いストアフロントを実現できます。また、新しい方法は、テーマ情報に直接アクセスするための標準化された方法を提供します。これにより、開発者はテーマに関する情報をより簡単に取得し、管理することができます。

参考記事: Updates to Theme Information Access in Shopify