収益化指標APIの概要
収益化指標APIを使用すると、Fire TVおよびFireタブレットアプリの登録、更新、キャンセル、再アクティベーションなどのサブスクリプション指標にプログラムでアクセスできます。これらの指標は指標セットにまとめられています。指標セットは、共通の属性（最新状況と詳細度）を共有し、まとめてクエリできる関連指標を論理的にグループ化したものです。各指標セットは、結果を絞り込んだり、内訳を作成したりするために使用できるディメンションをサポートしています。
収益化指標APIの使用には、Program Materials License Agreementが適用されます。
前提条件
このAPIを呼び出すために必要なものは、次のとおりです。
- 管理者レベルの認証情報を持つAmazon開発者アカウント
- Reporting APIにマッピングされたセキュリティプロファイル（開発者コンソール > [設定] > [APIアクセス] で作成）
- プロファイルの [ウェブ設定] タブにあるクライアントIDとクライアントシークレット
- アプリのパッケージ名
動作のしくみ
データは未処理のサブスクリプションイベントから、日単位および時間単位の集計テーブルに流れます。
- 日次指標では、1日に1つのデータポイントが提供され、T-1日に利用できます。
- 時間単位の指標では、1時間あたり1つのデータポイントが提供され、T-3時間に利用できます。これは、プロモーションや価格変更後のトレンドを早期に検出するのに役立ちます。
開発者コンソールのインタラクティブサンドボックスを使用して、このAPIを確認してください。詳細については、API Explorerを参照してください。
最新状況
各メトリックセットには、利用可能な最新のデータのタイムスタンプ（最新状況と呼ばれる）を取得するための標準のGETメソッドが用意されています。指標セットは複数の詳細度（日次、時間単位）をサポートできるため、オペレーションでは、サポートされている詳細度ごとに1つの最新状況値が返されます。
| 集計期間 | 最新状況SLA | リテンション | 最大クエリ範囲 |
|---|---|---|---|
DAILY |
T-1日 | 30日間 | 1回のリクエストにつき30日間 |
HOURLY |
T-3時間 | 15日間 | 1回のリクエストにつき15日間 |
クエリを実行する前に、どの日付範囲のデータが返されるかを把握するため、常に最新状況を確認する必要があります。
FreshnessInfoは、メトリックセットがサポートする集計期間ごとに1つのエントリを返します。DAILYをサポートする指標セットは1つのエントリしか返さないため、常に2つのエントリが存在するとは限りません。latestDataTimestampの解釈： 値はISO 8601 UTCインスタントラベルで、最新の完全完成アグリゲーションバケットです。ラベルはバケットの開始瞬間であり、バケット全体が完成します。HOURLY、Thh:00:00Zは、hh:00–hh:59の時間が完了したことを意味します（たとえば、2026-07-06T14:00:00Zは14:00～14:59の時間が完了したことを意味します）。DAILYの場合、YYYY-MM-DDT00:00:00ZはUTCの1日全体が完了したことを意味します（たとえば、2026-07-06T00:00:00Zは7月6日の1日全体が完了したことを意味します）。
データクエリ
指標セットのデータにアクセスするには、POST :queryメソッドを使用します。各クエリでは、詳細度と時間範囲を指定する必要があります。アクセスする指標と共に、ディメンションを指定して集計結果の内訳を示したり、フィルターを指定して内訳を追加せずに結果を絞り込んだりできます。
結果は、クエリでディメンションを指定するかどうかによって異なります。
- ディメンションの指定あり： 期間ごと、一意のディメンションの組み合わせごとに1行が返されます。
- ディメンションの指定なし： 期間ごとに1つの集計値が返されます。
HOURLYのクエリでは、"2026-08-30T14:00:00Z"のように、ISO 8601タイムスタンプで直接時間を指定します。どちらの境界も包括的です。1日中使用するには、startTimeをT00:00:00Zに、endTimeをT23:00:00Zに設定します。集計期間より細かいフィールドは無視されます。HOURLYクエリでは分と秒がそれらを含む時間に切り捨てられ、DAILYクエリでは時間以下の細かい単位が切り捨てられます。
使用可能な指標セット
次の表は、使用可能なすべてのメトリックセットとその説明を示しています。
subsActiveMetricSetおよびsubsCancellationSurveyMetricSetは、DAILYの詳細度のみをサポートします。いずれかの指標セットに対してHOURLYクエリを実行するとエラーが返されます。| 指標セット | 説明 | サポートされている指標 |
|---|---|---|
subsSignupMetricSet |
サブスクリプション登録とサインアップ収益。 | signups（数）： この期間に新規購読が開始。 signupRevenue（数）： それらのサインアップからの収益。 |
subsRenewalMetricSet |
サブスクリプションの更新と更新収益。 | renewals（数）： この期間にサブスクリプションが更新。 renewalRevenue（数）： これらの更新による収益。 |
subsCancellationMetricSet |
自発的および非自発的なキャンセル、および払い戻し額。 | cancellations（数）： サブスクリプションはその期間にキャンセルされました。 cancellationRefunds（数）： これらのキャンセルに対する払戻し完了。 |
subsReactivationMetricSet |
以前にキャンセルされたサブスクリプションが再アクティベートされました。 | reactivations（数）： 以前にキャンセルされ、その期間に再開されたサブスクリプション。 reactivationRevenue（数）： それらの再アクティベーションによる収益。 |
subsActiveMetricSet |
アクティブなサブスクリプション数。DAILYの詳細度のみ。 |
activeSubscriptions（数）： その日の終わりにサブスクリプションが有効。 |
subsHealthMetricSet |
自動更新イベントと猶予期間イベント。 | autoRenewalOff（数）： 自動更新機能がオフになっているサブスクリプション。 autoRenewalOn（数）： 自動更新機能が有効になっているサブスクリプション。 gracePeriodEntries（数）： 支払い猶予期間に入っているサブスクリプション。 gracePeriodRecoveries（数）： 支払い問題または失敗が解決した後の猶予期間から回復したサブスクリプション。 |
subsCancellationSurveyMetricSet |
キャンセルアンケートの回答。DAILYの詳細度のみ。 |
surveyedCancellations（数）： 各アンケート回答によるキャンセルを、cancellationReasonごとに分類。 |
subsFulfillmentMetricSet |
レシート配信の状態と確認待ち時間。 | totalReceipts（数）： その期間に発行されたレシート。 fulfilled（数）： アプリで確認できたレシート。 unavailable（数）： 利用不可とマークされたアプリを受信します。 pending（数）： 領収書は配達されたが、まだ確認されていない。 notEligible（数）： アイテム付与対象外のレシート。 existingPurchase（数）： 顧客が既に所有しているサブスクリプションの領収書。 notDelivered（数）： アプリに配信されなかったレシート。 p50AcknowledgementDelay、p90AcknowledgementDelay、p95AcknowledgementDelay（数）： 確認応答遅延 秒単位。 |
指標値の操作
指標値を解釈する際に知っておくべきことがいくつかあります。
activeSubscriptionsは、その期間中のイベントの合計ではなく、その日にアクティブなサブスクリプションのポイントインタイムカウントです。日をまたいで合計すると、同じ購読者が二重にカウントされます。- 収益または返金は、同じ指標セット内のカウント指標と常に対になります -
signups/signupRevenue、renewals/renewalRevenue、cancellations/cancellationRefunds、reactivations/reactivationRevenue。数値を数量に使用し、収益指標を金銭的価値に使用します。 - In
subsFulfillmentMetricSet,totalReceiptsは、fulfilled、unavailable、pending、notEligible、existingPurchase、およびnotDeliveredの合計に等しくなります。これを使用して、内訳と合計を調整します。 subsFulfillmentMetricSetのパーセンタイル指標は、リクエストされた期間に領収書の確認応答がなかった場合、nullを返し、0は返しません。nullは、パーセンタイルを計算するためのデータがなかったことを意味します。0の場合、瞬時に確認応答があったことを誤って示すことになります。カウントと収益の指標がNULLになることはありません。それぞれ0と0.00を返します。subsCancellationMetricSetとsubsCancellationSurveyMetricSetは、どちらもキャンセルを報告しますが、回答する質問は異なります。subsCancellationMetricSetを使用すると、キャンセルされたサブスクリプションの数と、キャンセルが自発的か非自発的かを確認できます。subsCancellationSurveyMetricSetを使用すると、顧客がキャンセルアンケートで選択した理由別にキャンセルを分類できます。アンケートの回答は任意であるため、アンケートの合計が同じ期間のキャンセル合計よりも少なくなる場合があります。
ディメンション
各指標セットは、絞り込みと内訳表示のための共通のディメンションセットをサポートしています。各ディメンションは、Available on 列に表示されている指標セットで使用できます。
| ディメンション | 型 | 利用可能 | 値 | 説明 |
|---|---|---|---|---|
marketplace |
文字列 | すべてのメトリックセット | US DE JP GB FR IT ES CA BR MX IN AU |
購読アクティビティが発生したマーケットプレイス。2文字のISO 3166-1アルファ2コード。 |
termSku |
文字列 | すべてのメトリックセット | フリーテキスト、最大256文字 | 顧客が購入した定期購入商品のSKUという用語。 |
deviceType |
文字列 | すべてのメトリックセット | FIRE_TV FIRE_TABLET OTHER |
デバイスのフォームファクター。 |
deviceOs |
文字列 | すべてのメトリックセット | FIRE_OS VEGA_OS |
デバイスのOSの種類。 |
subscriptionType |
文字列 | subsRenewalMetricSetとsubsFulfillmentMetricSet を除くすべてのメトリックセット |
REGULAR FREE_TRIAL INTRO |
サブスクリプションの価格タイプ。標準の有料サブスクリプションでも、無料試用版でも、お試し価格でも。 |
purchaseChannel |
文字列 | subsFulfillmentMetricSetのみ |
QS IAP |
購入が行われたチャネル。 |
renewalType |
文字列 | subsRenewalMetricSetのみ |
REGULAR FREE_TRIAL_CONVERSION INTRO_CONVERSION |
リニューアルの性質。定期的な更新、または無料試用版やお試し価格からの切り替え。 |
cancellationType |
文字列 | subsCancellationMetricSetのみ |
VOLUNTARY INVOLUNTARY |
サブスクリプションがユーザーの明示的な操作によってキャンセルされたか（VOLUNTARY）、または支払い失敗などにより明示的な操作なしに失効したか（INVOLUNTARY）。 |
cancellationReason |
文字列 | subsCancellationSurveyMetricSetのみ |
PRICE_RELATED NOT_USING_RELATED CONTENT_RELATED SERVICE_RELATED DISCOUNT_RELATED SPECIFIC_SHOW_RELATED TECHNICAL_ISSUE_RELATED PREFER_NOT_TO_SAY |
顧客がキャンセル調査で選択した理由。アンケート回答バリアントは、この固定された理由コードのセットに正規化されます。 |
termSkuはフリーテキストで、指定されたとおりに渡されます。そのため、フィルター値のスペルを間違えると、エラーではなく空の結果セットが返されます。他のすべてのディメンションは固定の値セットに対して検証され、認識されない値は 400 VALIDATION_ERRORで拒否されます。400 VALIDATION_ERROR が返されます。たとえば、purchaseChannelはsubsFulfillmentMetricSetでのみ使用できます。ディメンション値
一部のディメンションではコード値を使用します。このセクションでは、それぞれの値の意味について説明します。
subscriptionType - サブスクリプションの価格タイプ。標準の有料サブスクリプションでも、無料試用版でも、お試し価格でも。
REGULAR： 標準価格で請求されるサブスクリプション。FREE_TRIAL: 無料試用期間中のサブスクリプション。お客様にはまだ請求が行われていません。INTRO： 標準価格に切り替える前に割引料金で請求されるお試し価格期間のサブスクリプション。
renewalType - 更新の性質。定期的な更新、または無料試用版やお試し価格からの切り替え。
REGULAR： 既存の価格での有料サブスクリプションの定期的な更新。FREE_TRIAL_CONVERSION： 無料試用版を有料サブスクリプションに変換した更新。顧客の最初の請求。INTRO_CONVERSION： サブスクリプションが導入価格から標準価格に移行した更新。
purchaseChannel - サブスクリプションの購入が行われた場所。
QS（クイック定期購入）： たとえばFire端末のアプリの詳細ページでのワンクリック、またはアプリのAmazonのECウェブページで登録した場合です。IAP（アプリ内課金）： 顧客はアプリにログインし、標準のアプリ内購入フローを使用してアプリ内から購入しました。
cancellationType - キャンセルがどのように発生したか。
VOLUNTARY： サブスクリプションは、自動更新をオフにしたり、カスタマーサポートに連絡してキャンセルしたりするなど、ユーザーの明示的な操作によってキャンセルされました。INVOLUNTARY： 支払い猶予期間の満了を含む、支払いの失敗または不完全な支払いなど、ユーザーによる明示的な操作なしにサブスクリプションがキャンセルされました。
cancellationReason - ユーザーがオプションのキャンセルアンケートで選択した理由。調査は、表面や時間が経つにつれてさまざまな表現で提示されてきたため、複数の調査回答が1つの理由コードにマップされます。次の各コードには、含まれているアンケート回答が一覧表示されます。
PRICE_RELATED： 価格に関する不満。「サブスクリプションが高すぎる、または価格が上昇した」、「サブスクリプション価格が上昇した」、「他のサービスと比べて高すぎる」、または「価格が高すぎる」。NOT_USING_RELATED： 「ストリーミングサービスを十分に利用していない」。SPECIFIC_SHOW_RELATED： 「特定の番組、映画、スポーツイベントを視聴するためにサインアップした」。CONTENT_RELATED： コンテンツの不満。「視聴するテレビ番組、スポーツ、映画が足りない」または「コンテンツまたはサービスに不満がある」。TECHNICAL_ISSUE_RELATED： 技術的な問題またはデバイスの問題。「クラッシュ、フリーズ、ログインの問題が多すぎる」、「ストリーミングサービスへのログインに関する問題」、「クラッシュまたはフリーズが多すぎる」、「デバイスに不満がある」。DISCOUNT_RELATED： プロモーション価格は終了しました。「無料試用版または割引サブスクリプション価格が終了した」または「割引サブスクリプション価格が終了した」。SERVICE_RELATED： 「別のサービスへの切り替え」。PREFER_NOT_TO_SAY： 具体的な理由を述べたくない。「回答したくない」、「上記のどれでもない」、「その他」。
surveyedCancellations の合計は、同じ期間のcancellationsの合計より少なく、両者が一致することは想定されていません。関連トピック
- 収益化指標APIリファレンス： 前提条件、認証、APIエンドポイント、コード例、エラー処理、ベストプラクティス
- Reporting API： 売上、収益、定期購入レポートのダウンロード
- APIの確認： 開発者コンソールのAPI Explorerへのリンク
Last updated: 2026年10月13日
