アプリのインストール数の取得

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

指定した期間やその他のオプションフィルターに該当するアプリケーションのインストール集計データを JSON 形式で取得するには、Microsoft Store 分析 API でこのメソッドを使用します。この情報は、パートナーセンターの取得レポートでも確認できます。

前提条件

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

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

要求

要求の構文

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

要求ヘッダー

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

要求パラメーター

パラメーター	Type	内容	必須
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 osVersion deviceType packageVersion	いいえ
aggregationLevel	string	集計データを取得する時間範囲を指定します。次のいずれかの文字列を指定できます。day、week、または month。指定しない場合、既定値は day です。	No
orderby	string	各インストールの結果データ値の順序を指定するステートメント。構文は orderby=field [order],field [order],... です。field パラメーターは応答本文の次のいずれかのフィールドになります。 applicationName date deviceType market osVersion packageVersion successfulInstallCount order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。既定値は asc です。 orderby 文字列の例: orderby=date,market	No
groupby	string	指定したフィールドのみにデータ集計を適用するステートメントです。応答本文から次のフィールドを指定できます。 applicationName date deviceType market osVersion packageVersion 返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。 date applicationId successfulInstallCount groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。例: &groupby=ageGroup,market&aggregationLevel=week	いいえ

要求の例

アプリのインストールデータを取得するいくつかの要求の例を次に示します。 applicationId 値を、目的のアプリのストア ID に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答本文

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

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

値	種類	説明
date	string	インストールデータの期間の最初の日付。要求に日付を指定した場合、この値はその日付になります。要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
applicationId	string	インストールデータを取得するアプリの Store ID。
applicationName	string	アプリの表示名です。
deviceType	string	インストールを完了したデバイスの種類を指定する、次のいずれかの文字列。 PC 電話 Console-Xbox One Console-Xbox Series X IoT Holographic Unknown
packageVersion	string	インストールされたパッケージのバージョン。
osVersion	string	インストールが発生した OS のバージョンを指定する次のいずれかの文字列。 Windows Phone 7.5 Windows Phone 8 Windows Phone 8.1 Windows Phone 10 Windows 8 Windows 8.1 Windows 10 Windows 11 Unknown
market	string	インストールが発生した市場の ISO 3166 国コード。
successfulInstallCount	数値	指定した集計レベルで発生した正常なインストールの数。

要求と応答の例

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

サンプル要求

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

サンプル応答

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "successfulInstallCount": 100053
        }
    ],
    "TotalCount": 1
}

サンプル要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=06/19/2022&endDate=07/21/2022&top=10&skip=0&groupby=applicationName,date,deviceType,market,osVersion,packageVersion&orderby=date desc
HTTP/1.1
Authorization: Bearer <your access token>

サンプル応答

{
    "Value": [
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AU",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BD",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BG",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BO",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 6
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 11",
            "successfulInstallCount": 3
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CA",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CN",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "MX",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        }
    ],
    "TotalCount": 10
}

アプリのインストール数の取得

前提条件

要求

要求の構文

要求ヘッダー

要求パラメーター

要求の例

[応答]

応答本文

要求と応答の例

サンプル要求

サンプル応答

サンプル要求

サンプル応答

フィードバック

フィードバック

その他のリソース

アプリのインストール数の取得

前提条件

要求

要求の構文

要求ヘッダー

要求パラメーター

要求の例

[応答]

応答本文

要求と応答の例

サンプル要求

サンプル応答

サンプル要求

サンプル応答

関連トピック

フィードバック

フィードバック

その他のリソース