収益と Apple Ads のエンドポイント
アプリごとに接続したデータソース:収益、サブスクリプションのイベント、App Store のファネル、価格とオファーコード、変更の前後比較、そして Apple Ads のキャンペーン、キーワード、検索語句、コマンド。スコープは revenue:read と ads:read です。
認証 · クレジット · 共通パラメータ · エラーコード · openapi.json
GET /apps/{appId}/revenue
ユーザーが連携したソースから取得した、1つのアプリの収益とダウンロードです。App Store Connectの国別の日次販売数、Google Playの日次インストール数、RevenueCatのMRR、28日間の収益、アクティブなサブスクリプションとトライアル、MRRの増減の内訳を返します。connected=false はソースが1つも連携されていないこと、measured=false はソースにこのアプリの行がないことを意味します。ここに推定値は一切ありません。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
days | query | integer | 返す日次系列の日数。1〜365(既定は90) |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/revenue" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /apps/{appId}/subscriptions
RevenueCat / Adapty のWebhookから取得した、1つのアプリのサブスクリプションイベント数です。日別・国別に、トライアル開始、トライアルからの転換、有料開始、更新、解約、返金、請求の問題、収益を返し、月次コホート(ユーザー、支払者)も返します。数えているのはイベントで、ユーザー数ではありません。connected=false はWebhookが連携されていないことを意味します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
days | query | integer | 期間(日数)。1〜365(既定は90) |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/subscriptions" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /apps/{appId}/funnel
App Store Connectのアナリティクスから取得した、1つのアプリのApp Storeコンバージョンファネルです。インプレッション → プロダクトページビュー → ダウンロードを、今日の値と日ごとの履歴で返し、Appleが提供している場合はトラフィックソース別とカスタムプロダクトページ別の内訳も返します。Google Playにはこれに相当するものがありません。connected=false はApp Store Connectが連携されていないことを意味します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
days | query | integer | 履歴の期間(日数)。1〜365(既定は90) |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/funnel" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /apps/{appId}/campaigns
1つのアプリを宣伝しているApple Adsキャンペーンです(名前ではなくアプリのApp Store IDで照合します)。直近28日間のキャンペーン別の広告費、インプレッション、タップ、インストール、予算、配信ステータス、合計、そして広告費の多いキーワードと検索語句を返します。広告費はアカウント自身の通貨(currency)です。connected=false はApple Adsが連携されていないことを意味します。
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/campaigns" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /apps/{appId}/ads-keywords
1つのアプリのために全キャンペーンで購入しているApple Adsキーワードを、広告費の多い順にすべて返します(直近28日間)。入札額、マッチタイプ、広告グループ、広告費、インプレッション、タップ、インストール、タップスルー率、コンバージョン率、タップ単価、インストール単価に加え、その国での同じ語のオーガニック順位を並べて返します(追跡していない語は tracked:false)。campaign を渡すと1つのキャンペーンに絞れます。connected=false はApple Adsが連携されていないことを意味します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
country | query | string | オーガニック順位の列に使う国コード(既定はアプリの最初の国) |
campaign | query | string | 1つのキャンペーンに絞るためのキャンペーンID |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/ads-keywords?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /apps/{appId}/ads-search-terms
アプリのApple Adsを表示させた、ユーザーが実際に入力した検索を広告費の多い順に返します(直近28日間)。検索語句、それを拾ったキーワードとマッチタイプ、広告費、タップ、インストール、タップ単価とインストール単価、そしてその国でのその検索に対するアプリのオーガニック順位を並べて返します。キーワードとして追加する検索、除外キーワードに追加する検索、すでに順位があるので支払いをやめる検索を見つけるための一覧です。検索数が少ないためにAppleが非表示にしている語句は hidden に合算されます。connected=false はApple Adsが連携されていないことを意味します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
country | query | string | オーガニック順位の列に使う国コード(既定はアプリの最初の国) |
campaign | query | string | 1つのキャンペーンに絞るためのキャンペーンID |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/ads-search-terms?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /apps/{appId}/ads-commands
1つのアプリのキャンペーンに対するApple Adsコマンドを、新しい順に返します。ダッシュボード、自動化ルール、confirm_action から出されたものが対象です。それぞれにステータス(queued、applying、applied、failed、unknown)、完了時刻、エラーがあればその内容、取り消し操作が付きます。unknown は送信が途中で中断され、Apple に届いたかどうか分からない状態です。送り直す前に Apple Ads で確認してください。id を渡すとコマンド1件を返します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
id | query | string | 一覧で返されたコマンドID。コマンド1件を取得します |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/ads-commands" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /apps/{appId}/search-popularity
このワークスペースに連携したApple Adsアカウントから取得した、Apple自身の検索人気度です。アプリのカテゴリについて、その国で最も検索されている語句(週次、Appleの順序)を、カテゴリ内順位、人気度1-100(カテゴリ内と国全体)、1-5(Apple Adsの尺度)とともに返し、追跡キーワードにはすべて inTopTerms の true / false が付きます。ほかの語も調べるには terms を渡します。connected=false はApple Adsが連携されていないことを意味します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
terms | query | string | 追加で調べる語句。カンマ区切り、最大50 |
limit | query | number | 返す上位語句の数。最大200(既定は50) |
ほかに受け付けるもの: appId (必須) · country
curl "https://storelift.net/v1/apps/sbx-lumen/search-popularity?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /apps/{appId}/pricing
RevenueCatまたはAdaptyのWebhookから取得した、1つのアプリの商品価格とオファーコードです(直近365日)。商品・国ごとに、現在有効な価格(通貨、現地価格、開始日)と、価格が一定だった各期間のトライアル開始、新規の有料サブスクリプション、トライアルからの転換、収益を返し、各オファーコードの初日・最終日・利用数も返します。価格変更は新しい期間として現れるため、変更前後は期間ごとに比べられます。connected=false はどちらのWebhookも連携されていないことを意味します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
country | query | string | 1つのストアフロントに絞るための2文字の国コード |
product | query | string | 1つの商品に絞るためのストア商品ID |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/pricing?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /apps/{appId}/country-prices
アプリの商品1つの国別価格を、App Store Connect / Google Playから読み取って返します(Pro)。国ごとに、現地価格、そのUSD換算額と指数(米国 = 100)、まだApple(またはGoogle)の自動価格のままかどうか、価格をローカライズしている競合の中央値(Appleの自動価格に対する倍率と競合の数)と差(パーセント)、さらに切りのよい価格帯に丸めた提案価格とその理由(競合の中央値または所得帯)を返します。競合は、アプリに手動で追加したiOSの競合です。比較には1つの国につき3件以上が必要です。summary は、競合より高い国、低い国、自動価格のままの国を数えます。state は not_connected、pending(最初の読み取りがまだ終わっていない)、permission(キーのロールでは価格を読めない)、no_products、ok のいずれかです。products にはほかの商品が並びます。切り替えるには product を渡します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
country | query | string | 1行だけ返すための2文字の国コード |
product | query | string | 商品IDまたはSKU(既定は最初の商品) |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/country-prices?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /apps/{appId}/change-impact
変更が何をもたらしたかを返します。1つの変更日(新バージョン、スクリーンショット、サブタイトル、キーワード欄、キャンペーン開始。既定は掲載情報のタイムラインで最新の変更)について、前後の同じ日数を並べて比べます。キーワード順位(上昇/下落/ランクイン/圏外と、最も大きな変動)、App Storeのファネル(1日あたりのインプレッション、ページビュー、ダウンロードとコンバージョン率)、売上レポートのダウンロード、1日あたりのサブスクリプション収益とトライアル/有料の開始数を、それぞれ変化率(パーセント)とともに返します。変更日そのものは両方の期間から除きます。complete=false は変更後の期間がまだ終わっていないことを意味します。recentChanges には直近の変更日が並び、別の日を選べます。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
country | query | string | 順位と掲載情報のタイムラインに使う国コード(既定はアプリの最初の国) |
day | query | string | 変更日。YYYY-MM-DD(既定は最新の変更) |
window | query | integer | 前後それぞれの日数。3〜30(既定は7) |
ほかに受け付けるもの: appId (必須)
curl "https://storelift.net/v1/apps/sbx-lumen/change-impact?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"