デスクトップ アプリケーションのインストール数の取得

  • [アーティクル]

この REST URI を使用して、Windows デスクトップ アプリケーション プログラムに追加したデスクトップ アプリケーションの集計インストール データを JSON 形式で取得します。 この URI を使用すると、指定された日付範囲および他のオプション フィルター中にインストール データを取得できます。 この情報は、パートナー センターにあるデスクトップ アプリケーションのインストール レポートでも確認できます。

前提条件

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

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

要求

要求の構文

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

要求ヘッダー

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

要求パラメーター

パラメーター 型 内容 必須
applicationId string インストール データを取得するデスクトップ アプリケーションの製品 ID です。 デスクトップ アプリケーションの製品 ID を取得するには、パートナー センターでデスクトップ アプリケーションの分析レポート (インストール レポートなど) を開き、リンクの上にマウスを置いて URL から製品 ID を取得し、詳細を表示します。 はい
startDate 日付 取得するインストール データの期間の開始日。 既定値は、現在の日付の 90 日前です。 いいえ
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 パラメーターでは、文字列値を単一引用符で囲む必要があります。 応答本文から次のフィールドを指定できます。

  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease
 いいえ
orderby string 各インストールの結果データ値の順序を指定するステートメント。 構文は orderby=field [order],field [order],... です。field パラメーターは応答本文の次のいずれかのフィールドになります。

  • productName
  • date
  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease
  • installBase

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

orderby 文字列の例: orderby=date,market

 No
groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。 応答本文から次のフィールドを指定できます。

  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease

返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。

  • applicationId
  • date
  • productName
  • installBase

 いいえ

要求の例

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&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 インストール データを取得したデスクトップ アプリケーションの製品 ID です。
productName string 関連付けられている実行可能ファイルのメタデータから派生した、デスクトップ アプリケーションの表示名です。
applicationVersion string インストールされたアプリケーション実行可能ファイルのバージョンです。
deviceType string デスクトップ アプリケーションがインストールされているデバイスの種類を示す、以下のいずれかの文字列です。

  • PC
  • [サーバー]
  • タブレット PC
  • 不明
market string デスクトップ アプリケーションがインストールされている市場の ISO 3166 国番号です。
osVersion string デスクトップ アプリケーションがインストールされている OS のバージョンを指定する、以下のいずれかの文字列です。

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • 不明
osRelease string デスクトップ アプリケーションがインストールされている OS のリリースまたはフライティング リング (OS バージョン内のサブグループとして) を指定する、以下のいずれかの文字列です。

Windows 11 の場合: Version 2110

Windows 10 の場合:

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • バージョン 1709
  • Release Preview
  • Insider Fast
  • Insider Slow

Windows Server 1709 の場合:

  • RTM

Windows Server 2016 の場合:

  • Version 1607

Windows 8.1 の場合:

  • Update 1

Windows 7 の場合:

  • Service Pack 1

OS リリースまたはフライティング リングが不明な場合、このフィールドの値は [Unknown] (不明) になります。
installBase 数値 指定した集計レベルで製品がインストールされていた一意のデバイスの数です。

応答の例

この要求の JSON 返信の本文の例を次に示します。

{
  "Value": [
    {
      "date": "2018-01-24",
      "applicationId": "123456789",
      "productName": "Contoso Demo",
      "applicationVersion": "1.0.0.0",
      "deviceType": "PC",
      "market": "All",
      "osVersion": "Windows 10",
      "osRelease": "Version 1709",
      "installBase": 348218.0
    }
  ],
  "@nextLink": "desktop/installbasedaily?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}