サブスクリプションアドオンを取得する

2025-05-03

Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲およびその他のオプションフィルター中にアプリのアドオンサブスクリプションの集計取得データを取得します。

[前提条件]

このメソッドを使用するには、まず次の操作を行う必要があります。

まだ行っていない場合は、Microsoft Store 分析 API の前提条件をすべて満たしてください。
このメソッドの要求ヘッダーで使用する Azure AD アクセストークンを取得します。アクセストークンを取得すると、有効期限が切れるまで 60 分かかります。トークンの有効期限が切れた後、新しいトークンを取得できます。

リクエスト

リクエスト構文

メソッド	URI リクエスト
取得する	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions`

リクエストヘッダー

ヘッダ	タイプ	説明
認証	ひも	必須。 Bearer<token> 形式の Azure AD アクセストークン。

要求パラメーター

パラメーター	タイプ	説明	必須
アプリケーションID	ひも	アプリのサブスクリプションアドオン取得データを取得したい場合のストア ID。	イエス
サブスクリプション製品ID	ひも	取得データを取得したいサブスクリプションアドオンのストア ID。この値を指定しない場合、このメソッドは、指定したアプリのすべてのサブスクリプションアドオンの取得データを返します。	いいえ
開始日	日付	取得するサブスクリプションアドオン取得データの日付範囲の開始日。既定値は現在の日付です。	いいえ
終了日	日付	取得するサブスクリプションアドオン取得データの日付範囲の終了日。既定値は現在の日付です。	いいえ
ページのトップへ	整数 (int)	要求で返されるデータの行数。最大値と既定値 (指定されていない場合) は 100 です。クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。	いいえ
スキップ	整数 (int)	クエリでスキップする行数。大きなデータセットをページングするには、このパラメーターを使用します。たとえば、top=100 と skip=0 はデータの最初の 100 行を取得し、top=100 と skip=100 は次の 100 行のデータを取得します。	いいえ
フィルター	ひも	応答本文をフィルター処理する 1 つ以上のステートメント。各ステートメントは、eq または ne 演算子を使用できます。ステートメントは、、、、またはを使用して結合できます。フィルターステートメントで次の文字列を指定できます (これらは応答本文の値に対応します)。日付サブスクリプションプロダクト名アプリケーション名スクイド市場デバイスタイプ次に、フィルターパラメーターの例を示します: filter=date eq '2017-07-08' .	いいえ
集約レベル	ひも	集計データを取得する時間範囲を指定します。次のいずれかの文字列を指定できます:日、週、または月します。指定しない場合、既定値は日です。	いいえ
オーダーバイ (orderby)	ひも	各サブスクリプションアドオンの取得の結果データ値を並べ替えるステートメント。構文は orderby=field [order],field [order],...です。フィールドパラメーターには、次のいずれかの文字列を指定できます。日付サブスクリプションプロダクト名アプリケーション名スクイド市場デバイスタイプ order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。既定値は ascです。例として次のような orderby 文字列があります: orderby=date、market	いいえ
グループバイ	ひも	指定したフィールドにのみデータ集計を適用するステートメント。次のフィールドを指定できます。日付サブスクリプションプロダクト名アプリケーション名スクイド市場デバイスタイプ groupby パラメーターは、aggregationLevel パラメーターと共に使用できます。例: groupby=market&aggregationLevel=week	いいえ

要求の例

次の例では、サブスクリプションアドオンの取得データを取得する方法を示します。 applicationId の値を、アプリの適切なストア ID に置き換えます。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答内容

価値	タイプ	説明
価値	配列	サブスクリプションアドオンの取得データの集計を含むオブジェクトの配列。各オブジェクトのデータの詳細については、以下のサブスクリプション取得値のセクションを参照してください。
@nextLink	ひも	追加のデータページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。たとえば、要求の最上位パラメーターが 100 に設定されているが、クエリのサブスクリプションアドオン取得データが 100 行を超える場合、この値が返されます。
トータルカウント	整数 (int)	クエリのデータ結果内の行の合計数。

サブスクリプションの取得値

Value 配列内の要素には、次の値が含まれています。

価値	タイプ	説明
日付	ひも	取得データの日付範囲の最初の日付。要求で 1 日を指定した場合、この値はその日付になります。要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
サブスクリプション製品ID	ひも	購入データを取得しようとしているサブスクリプションアドオンのストア ID。
サブスクリプション商品名	ひも	サブスクリプションアドオンの表示名。
アプリケーションID	ひも	サブスクリプションアドオン取得データを取得するアプリのストア ID。
アプリケーション名	ひも	アプリの表示名。
スクイド	ひも	取得データを取得するサブスクリプションアドオンの SKU の ID。
デバイスタイプ	ひも	取得を完了したデバイスの種類を指定する次のいずれかの文字列。パソコン電話 Console-Xbox 1 Console-Xbox シリーズ X IoTのホログラフィック不明
市場	ひも	取得が行われた市場の ISO 3166 国コード。
通貨コード	ひも	税引き前総売上の ISO 4217 形式の通貨コード。
税引前の総売上	整数 (integer)	currencyCode 値で指定された現地通貨での総売上。
総アクティブ数	整数 (integer)	指定した期間中のアクティブなサブスクリプションの合計数。これは、良好な状態のアクティブカウント、保留中の猶予期間アクティブカウント、猶予期間アクティブカウント、ロックされたアクティブカウントの値の合計と同じです。
総解約件数	整数 (integer)	指定した期間中に非アクティブ化されたサブスクリプションの合計数。これは billingChurnCount、nonRenewalChurnCount、refundChurnCount、chargebackChurnCount、earlyChurnCount、およびその他のChurnCount 値の合計に相当します。
新しいカウント	整数 (integer)	試用版を含む、指定した期間中の新しいサブスクリプション取得の数。
更新カウント	整数 (integer)	ユーザーが開始した更新や自動更新を含む、指定した期間中のサブスクリプションの更新の数。
良好状態アクティブ数	整数 (integer)	指定した期間中にアクティブであり、かつ有効期限が「>= クエリのendDate 値」となるサブスクリプションの数。
ペンディング・グレース・アクティブカウント	整数 (integer)	指定した期間中にアクティブであったが課金エラーが発生し、サブスクリプションの有効期限がクエリの > 値= であるサブスクリプションの数。
グレースアクティブカウント	整数 (integer)	指定した期間中にアクティブであったが、課金エラーが発生したサブスクリプションの数と、次の場所。サブスクリプションの有効期限は、クエリにある < の値です。猶予期間の終了は >、すなわち endDate の値です。
ロックされたアクティブ数	整数 (integer)	指定した期間中に督促ステータスにあるサブスクリプションの数 (つまり、サブスクリプションの有効期限が近づいており、Microsoft が自動更新のための支払いを回収しようとしている状態)、そして次の場合: サブスクリプションの有効期限は、クエリにある < の値です。猶予期間の終了は <、すなわち endDate の値です。
ビリングチャーンカウント	整数 (integer)	請求料金の処理が失敗し、サブスクリプションが取り立て段階にあったために、指定した期間中に非アクティブ化されたサブスクリプションの数。
非更新解約件数	整数 (integer)	更新されなかったために、指定した期間中に非アクティブ化されたサブスクリプションの数。
返金解約件数	整数 (integer)	払い戻しされたために指定した期間中に非アクティブ化されたサブスクリプションの数。
チャージバック解約件数	整数 (integer)	チャージバックのために指定された期間中に非アクティブ化されたサブスクリプションの数。
earlyChurnCount (早期チャーンカウント)	整数 (integer)	指定した期間中に良好な状態で非アクティブ化されたサブスクリプションの数。
その他の解約件数	整数 (integer)	他の理由により、指定した期間中に非アクティブ化されたサブスクリプションの数。

要求と応答の例

次のコードスニペットは、これらの要求の要求と JSON 応答本文の例を示しています。

サンプル依頼

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

応答の例

{
    "Value": [
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "grossSalesBeforeTax": 3460656.260391250,
            "totalActiveCount": 20211321,
            "totalChurnCount": 5605,
            "newCount": 3810366,
            "renewCount": 12102044,
            "goodStandingActiveCount": 17893664,
            "pendingGraceActiveCount": 2255792,
            "graceActiveCount": 61833,
            "lockedActiveCount": 32,
            "billingChurnCount": 4,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 2717,
            "otherChurnCount": 2884
        },
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Unknown",
            "grossSalesBeforeTax": 2342.580615228,
            "totalActiveCount": 50550,
            "totalChurnCount": 7,
            "newCount": 8312,
            "renewCount": 31446,
            "goodStandingActiveCount": 44047,
            "pendingGraceActiveCount": 6503,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 5,
            "otherChurnCount": 2
        }
    ],
    "TotalCount": 2
}

サンプル依頼

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>

応答の例

{
    "Value": [
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "IT",
            "deviceType": "Console-Xbox One",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 2,
            "renewCount": 0,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "NO",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 13,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "CA",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 152,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 270,
            "goodStandingActiveCount": 133,
            "pendingGraceActiveCount": 19,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        }
    ],
    "TotalCount": 3
}

アドオン取得状況レポート
Microsoft Store サービスを使用して分析データにアクセスする

次の方法で共有

サブスクリプションアドオンを取得する

[前提条件]

リクエスト

リクエスト構文

リクエストヘッダー

要求パラメーター

要求の例

[応答]

応答内容

サブスクリプションの取得値

要求と応答の例

サンプル依頼

応答の例

サンプル依頼

応答の例

関連トピック

フィードバック

その他のリソース