記事のサマリー(TL;DR)
- Shopifyは、アプリの活動をマーチャントがShopify Analyticsで確認できるようにする機能を発表しました。マーチャントはレポートビルダー、またはShopifyQLの
FROM app_eventsでアプリのメトリクスやディメンションを参照できます。 - アプリ開発者は
analytics_app_events拡張内でイベントを宣言し、App Events APIを通じて宣言済みイベントを送信することで、マーチャントがそのイベントをレポートできるようになります。Shopify定義の標準イベント(例:メール送信)の利用、独自の属性・メトリクスを持つカスタムイベントの定義、標準イベントへの独自属性・メトリクスの拡張が可能です。 - 既存のDev Dashboardログや課金用に送信しているイベントは自動的にShopify Analyticsで利用可能にはならず、リリース済みのAnalytics App Events宣言に一致する必要があります。既存のApp Events連携は、Shopify Analyticsに表示したい場合を除き変更の必要はありません。
対象者と必要な対応
この機能は、インストール済みアプリの活動をマーチャントにShopify Analyticsでレポートしてもらいたい開発者を対象としています。Shopify Analyticsにアプリの活動を表示したい場合を除き、特に対応は不要です。
利用を開始するには、shopify.extension.toml内のanalytics_app_events拡張で標準イベントまたはカスタムイベントを宣言します。例えば、メールマーケティングアプリであれば、標準のemail-sentイベントを以下のように宣言できます。
[[extensions]]
type = "analytics_app_events"
handle = "app-events"
[[extensions.events]]
name = "shopify.marketing.email_sent"
kind = "standard"
この設定をshopify app deployでリリースした後、アプリがインストールされている各ストアに対して、宣言した内容に一致するイベントをApp Events API経由で送信します。イベントが処理されると、マーチャントはShopifyQLを使って以下のように時系列でメール送信数をレポートできます。
FROM app_events
SHOW emails_sent
TIMESERIES day
詳細
変更内容
アプリはこれまで、analytics_app_events拡張内でイベントを宣言できるようになりました。アプリが宣言済みイベントをApp Events API経由で送信すると、マーチャントはそのイベントをShopify Analyticsでレポートできます。
- 一般的なイベントタイプ(メール送信など)には、Shopifyが定義する標準イベントを使用できます。
- アプリ固有の属性やメトリクスを持つカスタムイベントを定義できます。
- 標準イベントに独自の属性やメトリクスを追加して拡張できます。
対象範囲
この機能は、インストール済みアプリの活動についてマーチャントにShopify Analytics上でレポートしてもらいたい開発者向けです。すでにDev Dashboardのログや課金のためにイベントを送信している場合でも、それらのイベントが自動的にShopify Analyticsで利用可能になるわけではありません。リリース済みのAnalytics App Events宣言に一致させる必要があります。既存のApp Events連携については、Shopify Analyticsにイベントを表示させたい場合を除き、変更の必要はありません。
この変更が重要な理由
マーチャントは、Shopifyから離れたり別のダッシュボードを開いたりすることなく、アプリの活動をShopify Analytics上で確認できるようになります。開発者側は、独自の分析機能を構築したりホスティングしたりする必要がありません。アプリは、マーチャントがビジネスを分析する場であればどこにでも表示されるようになります。
開発者が行うべきこと
Shopify Analyticsにアプリの活動を表示したい場合を除き、対応は不要です。開始するには、shopify.extension.toml内のanalytics_app_events拡張で標準イベントまたはカスタムイベントを宣言します。
関連ドキュメントとして、「App Events in Analytics」ガイドに沿って進めることが案内されています。関連資料には、App Events in Analytics、Configure Analytics App Events、Standard event registry、App Events API referenceが挙げられています。