Developer Changelog / Apps × Analytics

App Events in Analytics
アプリの活動データが Shopify Analytics のレポートに並ぶ

アプリが analytics_app_events 拡張でイベントを宣言し、App Events API で送信すると、マーチャントはレポートビルダーや ShopifyQL(FROM app_events)でアプリの指標・ディメンションを分析できるようになる。

このページの構成
  1. そもそも何が変わるのか(30秒で理解)
  2. 仕組み図解 : 宣言 → 送信 → レポート
  3. 宣言できるイベントの3パターン
  4. 誰が影響を受けるか / 既存連携の扱い
  5. 始め方(3ステップ)
  6. コード例 : TOML 宣言と ShopifyQL
  7. 技術者が押さえるべき5つのポイント
  8. 業務に活かせる3つのユースケース
  9. 提案で使える1行サマリ

1そもそも何が変わるのか

これまでアプリの活動データ(例 : 送信したメール数)は、アプリ側の管理画面や別ダッシュボードで見るしかなかった。
今回から、アプリが宣言・送信したイベントを マーチャントが Shopify Analytics の中でレポートできる ようになった。

従来 : 分析が分断

アプリの数字を見るには別ダッシュボードを開く必要がある。アプリ開発者は自前で分析画面を作り、ホストする必要があった。

これから : Shopify Analytics に統合

マーチャントは Shopify を離れずにアプリの指標を分析。レポートビルダーでも ShopifyQL でも扱える。開発者は分析基盤を自作・ホスト不要。

2仕組み図解 : 宣言 → 送信 → レポート

① 宣言 shopify.extension.toml analytics_app_events standard / custom 開発者 ② リリース shopify app deploy 宣言が「released」に Shopify CLI ③ 送信 App Events API 宣言と一致するイベント (インストール済みストア分) アプリのバックエンド ④ レポート レポートビルダー ShopifyQL: FROM app_events マーチャント
ポイントは 「宣言」と「送信」の両方が必要 なこと。送るだけでも、宣言するだけでもレポートには出ない。リリース済みの宣言に一致したイベントだけ が、処理後に Shopify Analytics に現れる。

3宣言できるイベントの3パターン

standard

Shopify 定義の標準イベント

「メール送信」のような一般的なイベント種別は、Shopify が定義した標準イベントを使う。例 : shopify.marketing.email_sent。一覧は Standard event registry に記載。

custom

カスタムイベント

アプリ固有の 属性(attributes)と指標(metrics) を持つイベントを独自に定義できる。

standard + 拡張

標準イベントを拡張

標準イベントをベースに、自分のアプリ独自の属性・指標を追加できる。

4誰が影響を受けるか / 既存連携の扱い

状況扱い必要な対応
アプリの活動を Shopify Analytics で見せたい開発者 対象 今回の新機能を利用できる 拡張で宣言 → deploy → API で送信
Dev Dashboard ログや課金用に既に App Events を送っている 自動では出ない Analytics には反映されない Analytics に出したい場合のみ、リリース済みの Analytics App Events 宣言と一致させる
既存の App Events 連携を変えたくない 変更不要 対応なし(Analytics 表示を望む場合のみ対応)
料金・対応プラン・データ保持期間 記載なし ガイド・API リファレンスで要確認
必須の対応は無し。 アプリの活動を Shopify Analytics で見せたい場合だけ着手すればよい(オプトイン型)。

5始め方(3ステップ)

1

拡張でイベントを宣言

shopify.extension.toml に analytics_app_events 拡張を作り、標準 or カスタムイベントを宣言。

2

shopify app deploy でリリース

設定をリリースして、宣言を有効な状態にする。

3

App Events API で送信

アプリがインストールされたストア向けに、宣言と一致するイベントを送る。処理後にレポート可能になる。

6コード例 : TOML 宣言と ShopifyQL

① 宣言(shopify.extension.toml)

メールマーケティングアプリが標準の「メール送信」イベントを宣言する例。

[[extensions]]
type = "analytics_app_events"
handle = "app-events"

[[extensions.events]]
name = "shopify.marketing.email_sent"
kind = "standard"
② マーチャント側のクエリ(ShopifyQL)

イベント処理後、送信メール数を日次の時系列で集計する例。

FROM app_events
  SHOW emails_sent
  TIMESERIES day

同じデータはレポートビルダー(GUI)でも探索できる。

App Events API の送信ペイロード形式・カスタムイベントの属性/指標の TOML 記法・処理にかかる時間は、本記事には 記載なし。「App Events in Analytics」ガイド、「Configure Analytics App Events」、「App Events API reference」を参照すること。

7技術者が押さえるべき5つのポイント

宣言 送信

1. 宣言と送信はセット

イベントは analytics_app_events 拡張で宣言し、shopify app deploy でリリース済みになっていることが前提。宣言に一致しないイベントは Analytics に出ない。

2. 既存の App Events は自動で載らない

Dev Dashboard ログや課金のために送っているイベントは、そのままでは Analytics に現れない。載せたいなら宣言側を合わせる設計が必要。

std

3. まず標準イベントを探す

一般的な種別(メール送信など)は標準イベントが用意されている。足りない分は「標準を拡張」→ それでも無ければ「カスタム」という順で検討すると整理しやすい。

FROM app_events

4. 指標名がクエリの語彙になる

マーチャントは FROM app_events と指標名(例 : emails_sent)で ShopifyQL を書く。宣言する指標・属性がそのままマーチャントの分析語彙になる点を意識して命名する。

5. 自前の分析基盤を作らなくてよい

記事では「自前のアナリティクスを構築・ホストする必要がない」と明言。アプリ内レポート画面の開発・保守を Shopify Analytics に寄せられる可能性がある。既存ダッシュボードとの機能差(粒度・保持期間など)は記載なし のため、置き換え判断は要検証。

8業務に活かせる3つのユースケース

USE CASE 1

メールマーケティングアプリの成果を Shopify 上で見せる

課題
マーチャントは送信数をアプリ側画面で、売上を Shopify Analytics で別々に確認しており、横並びで見られない。
打ち手
標準イベント shopify.marketing.email_sent を宣言・deploy し、送信ごとに App Events API へ送る。
効果
マーチャントが Shopify を離れずに emails_sent を日次で追える。アプリの存在感が分析の場に常駐する。
技術メモ
記事の公式例そのもの。送信イベントは「インストール済みストア」単位で送る。
USE CASE 2

自社アプリ内のレポート画面を Shopify Analytics に寄せる

課題
アプリ独自の指標を見せるために分析画面を自作・ホストしており、開発と保守コストがかかっている。
打ち手
アプリ固有の属性・指標をカスタムイベント(または標準イベントの拡張)として宣言し、Shopify Analytics で提供。
効果
分析 UI の新規開発を抑えつつ、マーチャントはレポートビルダーや ShopifyQL で自由に切り口を変えて分析できる。
技術メモ
既存画面の完全置き換え可否は、属性・指標の表現力や反映タイミング(記載なし)を検証してから判断する。
既存 events 宣言 一致
USE CASE 3

既存の App Events 連携を棚卸しして Analytics に開放

課題
Dev Dashboard ログや課金のためにすでに App Events を送っているが、その情報はマーチャントの分析には使われていない。
打ち手
送信中のイベントを棚卸し → マーチャントに価値があるものを選定 → 一致する Analytics App Events 宣言を作成して deploy。
効果
既存の送信基盤を活かしながら、マーチャント向けレポートを追加できる。
技術メモ
既存連携は「変更不要」。Analytics に出したいイベントだけ宣言を合わせればよく、段階的に移行できる。

9提案で使える1行サマリ

「アプリの活動データを、宣言(TOML)+送信(App Events API)だけで Shopify Analytics のレポートに載せられる 新機能。
マーチャントは Shopify を離れずに分析でき、開発者は自前の分析基盤を作らなくて済む。」