アプリの使用状況 (月単位) の取得

[アーティクル]
01/17/2024

Microsoft Store 分析 API でこのメソッドを使用すると、特定の期間 (過去 90 日間のみ) および他のオプションフィルターを指定して、集計使用状況データ (Xbox マルチプレーヤーは含めない) を JSON 形式で取得できます。この情報は、パートナーセンターの使用状況レポートでも確認できます。

Anaheim ベースの PWA アプリのテレメトリは、デバイスレベルで収集されます。そのため、ユーザーに関連するメトリックは、このような製品では使用できません。フィールドの有効性の詳細については、以下の「使用状況の値」セクションを参照してください。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

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

要求

要求の構文

認証方法	要求 URI
GET	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly`

要求ヘッダー

Header	型	説明
承認	string	必須。 Bearer<トークン> という形式の Azure AD アクセストークン。

要求パラメーター

パラメーター	型	内容	必須
applicationId	string	レビューデータを取得するアプリの Store ID。	はい
startDate	日付	取得するレビューデータの期間の開始日。既定値は現在の日付です。	いいえ
endDate	日付	取得するレビューデータの期間の終了日。既定値は現在の日付です。	いいえ
top	int	要求で返すデータの行数です。最大値および指定しない場合の既定値は 10000 です。クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。	いいえ
skip	int	クエリでスキップする行数です。大きなデータセットを操作するには、このパラメーターを使用します。たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。	No
filter	string	応答内の行をフィルター処理する 1 つまたは複数のステートメントです。各ステートメントでは応答本文のフィールド名と値が eq 演算子または ne 演算子で関連付けられ、ステートメントは and または or を使用して組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。応答本文から次のフィールドを指定できます。 market deviceType packageVersion	いいえ
orderby	string	結果データ値の順序を指定するステートメントです。構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。 date applicationId applicationName market packageVersion deviceType subscriptionName monthlySessionCount engagementDurationMinutes monthlyActiveUsers monthlyActiveDevices monthlyNewUsers averageDailyActiveUsers averageDailyActiveDevices monthlyNewDevices order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。既定値は asc です。 orderby 文字列の例: orderby=date,market	No
groupby	string	指定したフィールドのみにデータ集計を適用するステートメントです。応答本文から次のフィールドを指定できます。 applicationName subscriptionName deviceType packageVersion market date 返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。 applicationId subscriptionName monthlySessionCount engagementDurationMinutes monthlyActiveUsers monthlyActiveDevices monthlyNewUsers averageDailyActiveUsers averageDailyActiveDevices monthlyNewDevices groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。例: &groupby=ageGroup,market&aggregationLevel=week	いいえ

要求の例

次の例は、月ごとのアプリの使用状況データを取得する要求を示しています。 applicationId 値を、目的のアプリのストア ID に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=XXXXXXXXXXXX&startDate=2018-06-01&endDate=2018-07-01 HTTP/1.1  
Authorization: Bearer <your access token>

[応答]

応答本文

値	種類	説明
値	配列	集計使用状況データを含むオブジェクトの配列。各オブジェクトのデータの詳細については、以下の表を参照してください。
@nextLink	string	データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。たとえば、要求の top パラメーターが 10000 に設定されていた場合、クエリのレビューデータが 10000 行を超えると、この値が返されます。
TotalCount	int	クエリの結果データ内の行の総数です。

使用状況の値

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

値	種類	説明	UWP の可用性	Anaheim ベースの PWA 可用性	Xbox 可用性
日付	string	使用状況データの日付範囲の最初の日付。要求に日付を指定した場合、この値はその日付になります。要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。	はい	イエス	はい
applicationId	string	使用状況データを取得するアプリの Store ID。	はい	イエス	はい
applicationName	string	アプリの表示名です。	はい	イエス	はい
market	string	ユーザーがアプリを使用した市場の ISO 3166 国番号。	はい	イエス	はい
packageVersion	string	使用されたパッケージのバージョン。	はい	はい	いいえ
deviceType	string	使用されたデバイスの種類を指定する、以下のいずれかの文字列です。 PC 電話 Console-Xbox One Console-Xbox Series X タブレット PC IoT [サーバー] Holographic 不明	はい	イエス	はい
subscriptionName	string	Xbox Game Pass 経由の使用かどうかを示します。	はい	いいえ	いいえ
monthlySessionCount	long	その月のユーザーセッション数。	はい	イエス	はい
engagementDurationMinutes	倍精度浮動小数点	ユーザーがアプリをアクティブに使用している時間を、アプリの起動時 (プロセスの開始) に始まり、アプリの終了時 (プロセスの終了) または非アクティブな期間の後に終了する個別の期間ごとに測定した値 (分単位)。	はい	イエス	はい
monthlyActiveUsers	long	その月にアプリを使用しているユーザー数。	はい	いいえ	はい
monthlyActiveDevices	long	アプリの起動時 (プロセスの開始) に始まり、アプリの終了時 (プロセスの終了) または非アクティブな期間の後に終了する個別の期間にアプリを実行しているデバイス数。	はい	イエス	はい
monthlyNewUsers	long	その月に初めてアプリを使用したユーザー数。	はい	いいえ	はい
averageDailyActiveUsers	倍精度浮動小数点	アプリを使用している平均ユーザー数 (日単位)。	はい	いいえ	はい
averageDailyActiveDevices	倍精度浮動小数点	そのアプリの操作のためにすべてのユーザーによって使用されている平均デバイス数 (日単位)。	はい	イエス	はい
monthlyNewDevices	long	その月に初めてアプリを使用したデバイスの数です。	いいえ	有効	いいえ

Note

フィールドが特定の製品に対して有効でない場合、それらのフィールドへの値は応答で 0 または null として送信されます。新しいユーザーと新しいデバイスの計算は、3 年のローリングウィンドウで行われます。つまり、ユーザー/デバイスが 3 年以上アプリケーションを使用していない場合は、3 年後に新しいユーザー/デバイスとして扱われます。

要求と応答の例

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

サンプル要求

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

サンプル応答

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "deviceType": "All",
            "packageVersion": "All",
            "market": "All",
            "engagementDurationMinutes": 2828568.3,
            "monthlyActiveUsers": 165249,
            "monthlyActiveDevices": 165753,
            "monthlyNewUsers": 95787,
            "monthlySessionCount": 314263,
            "averageDailyActiveUsers": 192.506111111111,
            "averageDailyActiveDevices": 191.199722222222,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 1
}

サンプル要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagemonthly?applicationId=9NBLGGGZ5QDR&startDate=2022-06-01&endDate=2022-07-01&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

サンプル応答

{
    "Value": [
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "JP",
            "engagementDurationMinutes": 0.3,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "MX",
            "engagementDurationMinutes": 2.7,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "Unknown",
            "engagementDurationMinutes": 0.1,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "1.0.0.4957",
            "market": "US",
            "engagementDurationMinutes": 0.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AE",
            "engagementDurationMinutes": 3.2,
            "monthlyActiveUsers": 2,
            "monthlyActiveDevices": 2,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 3,
            "averageDailyActiveUsers": 0.07,
            "averageDailyActiveDevices": 0.07,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AO",
            "engagementDurationMinutes": 1.2,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AR",
            "engagementDurationMinutes": 574.7,
            "monthlyActiveUsers": 39,
            "monthlyActiveDevices": 39,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 53,
            "averageDailyActiveUsers": 1.43,
            "averageDailyActiveDevices": 1.43,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AT",
            "engagementDurationMinutes": 5.3,
            "monthlyActiveUsers": 4,
            "monthlyActiveDevices": 4,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 9,
            "averageDailyActiveUsers": 0.17,
            "averageDailyActiveDevices": 0.17,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AU",
            "engagementDurationMinutes": 434.7,
            "monthlyActiveUsers": 22,
            "monthlyActiveDevices": 22,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 36,
            "averageDailyActiveUsers": 0.9,
            "averageDailyActiveDevices": 0.9,
            "monthlyNewDevices": 0
        },
        {
            "date": "2022-06-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "subscriptionName": "null",
            "deviceType": "PC",
            "packageVersion": "2.5.2.34894",
            "market": "AZ",
            "engagementDurationMinutes": 13.5,
            "monthlyActiveUsers": 1,
            "monthlyActiveDevices": 1,
            "monthlyNewUsers": 0,
            "monthlySessionCount": 1,
            "averageDailyActiveUsers": 0.03,
            "averageDailyActiveDevices": 0.03,
            "monthlyNewDevices": 0
        }
    ],
    "TotalCount": 10
}

次の方法で共有

アプリの使用状況 (月単位) の取得

前提条件

要求

要求の構文

要求ヘッダー

要求パラメーター

要求の例

[応答]

応答本文

使用状況の値

要求と応答の例

サンプル要求

サンプル応答

サンプル要求

サンプル応答

フィードバック

その他のリソース

次の方法で共有

アプリの使用状況 (月単位) の取得

前提条件

要求

要求の構文

要求ヘッダー

要求パラメーター

要求の例

[応答]

応答本文

使用状況の値

要求と応答の例

サンプル要求

サンプル応答

サンプル要求

サンプル応答

関連トピック

フィードバック

その他のリソース