この REST URI を使用して、 Windows デスクトップ アプリケーション プログラムに追加したデスクトップ アプリケーションの集計インストール データを JSON 形式で取得します。 この URI を使用すると、特定の日付範囲とその他の省略可能なフィルター中にインストール データを取得できます。 この情報は、パートナー センターのデスクトップ アプリケーションの インストール レポート でも確認できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | インストール データを取得するデスクトップ アプリケーションの製品 ID。 デスクトップ アプリケーションの製品 ID を取得するには、 パートナー センターでデスクトップ アプリケーションの分析レポート ( インストール レポートなど) を開き、リンクの上にマウスポインターを置いて詳細を表示することで、URL から製品 ID を取得します。 | イエス |
開始日 | 日付 | 取得するインストール データの日付範囲の開始日。 既定値は、現在の日付の 90 日前です。 | いいえ |
終了日 | 日付 | 取得するインストール データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 各ステートメントには、応答本文のフィールド名と、eq または ne 演算子に関連付けられている値が含まれており、ステートメントは、、、、またはを使用して結合できます。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。 応答本文から次のフィールドを指定できます:
|
いいえ |
オーダーバイ (orderby) | ひも | 各インストールの結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],...です。 field パラメーターには、応答本文から次のいずれかのフィールドを指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc 例として次のような orderby 文字列があります: orderby=date、market |
いいえ |
グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 応答本文から次のフィールドを指定できます:
返されるデータ行には、 groupby パラメーターで指定されたフィールドと、次のものが含まれます。
|
いいえ |
要求の例
次の例では、デスクトップ アプリケーションのインストール データを取得するためのいくつかの要求を示します。 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 | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の 最上位 パラメーターが 10000 に設定されているが、クエリのインストール データが 1,0000 行を超える場合、この値が返されます。 |
トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
Value 配列内の要素には、次の値が含まれています。
価値 | タイプ | 説明 |
---|---|---|
日付 | ひも | インストールの基本値に関連付けられている日付。 |
アプリケーションID | ひも | インストール データを取得したデスクトップ アプリケーションの製品 ID。 |
製品名 | ひも | 関連付けられている実行可能ファイルのメタデータから派生したデスクトップ アプリケーションの表示名。 |
アプリケーションバージョン | ひも | インストールされたアプリケーション実行可能ファイルのバージョン。 |
デバイスタイプ | ひも | デスクトップ アプリケーションがインストールされているデバイスの種類を指定する次のいずれかの文字列。
|
市場 | ひも | デスクトップ アプリケーションがインストールされている市場の ISO 3166 国コード。 |
osVersion (英語) | ひも | デスクトップ アプリケーションをインストールする OS のバージョンを指定する次のいずれかの文字列。
|
osリリース | ひも | デスクトップ アプリケーションがインストールされている OS リリースまたは "フライト リング"(OS バージョンの中のサブカテゴリ)を指定する次のいずれかの文字列。 Windows 11 の場合: バージョン 2110 Windows 10 の場合:
Windows Server 1709 の場合:
Windows Server 2016 の場合:
Windows 8.1 の場合:
Windows 7 の場合:
OS リリースまたはフライティング リングが不明な場合、このフィールドの値は [不明] になります。 |
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
}