この REST URI を使用して、デスクトップ アプリケーションが Windows 10 または Windows 11 のアップグレードの実行をブロックしている Windows 10 および Windows 11 デバイスに関する情報を取得します。 この URI は、Windows デスクトップ アプリケーション プログラムに追加したデスクトップ アプリケーションにのみ使用できます。 この情報は、パートナー センターのデスクトップ アプリケーションの アプリケーション ブロック レポート でも確認できます。
デスクトップ アプリケーションの特定の実行可能ファイルのデバイス ブロックの詳細については、「デスクトップ アプリケーションのアップグレード ブロックの詳細を取得する」を参照してください。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | ブロック データを取得するデスクトップ アプリケーションの製品 ID。 デスクトップ アプリケーションの製品 ID を取得するには、パートナー センター でデスクトップ アプリケーションの |
イエス |
開始日 | 日付 | 取得するブロック データの日付範囲の開始日。 既定値は、現在の日付の 90 日前です。 | いいえ |
終了日 | 日付 | 取得するブロック データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 各ステートメントには、応答本文のフィールド名と、eq または ne 演算子に関連付けられている値が含まれており、ステートメントは、、、、またはを使用して結合できます。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。 応答本文から次のフィールドを指定できます。
|
いいえ |
オーダーバイ (orderby) | ひも | 各ブロックの結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],...です。フィールド パラメーターには、応答本文から次のいずれかのフィールドを指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc 例として次のような orderby 文字列があります: orderby=date、market |
いいえ |
グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 応答本文から次のフィールドを指定できます。
返されるデータ行には、 groupby パラメーターで指定されたフィールドと、次のものが含まれます。
|
いいえ |
要求の例
次の例では、デスクトップ アプリケーション ブロック データを取得するためのいくつかの要求を示します。 applicationId の値を、デスクトップ アプリケーションの製品 ID に置き換えます。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits?applicationId=5126873772241846776&startDate=2018-05-01&endDate=2018-06-07&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits?applicationId=5126873772241846776&startDate=2018-05-01&endDate=2018-06-07&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答内容
価値 | タイプ | 説明 |
---|---|---|
価値 | 配列 | 集計ブロック データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、次の表を参照してください。 |
@nextLink | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10000 に設定されていても、クエリのブロック データが 1,0000 行を超える場合、この値が返されます。 |
トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
Value 配列内の要素には、次の値が含まれています。
価値 | タイプ | 説明 |
---|---|---|
アプリケーションID | ひも | ブロック データを取得したデスクトップ アプリケーションの製品 ID。 |
日付 | ひも | ブロックヒット値に関連する日付。 |
製品名 | ひも | 関連付けられている実行可能ファイルのメタデータから派生したデスクトップ アプリケーションの表示名。 |
ファイル名 | ひも | ブロックされた実行可能ファイル。 |
アプリケーションバージョン | ひも | ブロックされたアプリケーション実行可能ファイルのバージョン。 |
osVersion (英語) | ひも | デスクトップ アプリケーションが現在実行されている OS バージョンを指定する次のいずれかの文字列。
|
osリリース | ひも | デスクトップアプリケーションが現在実行されているOSリリースまたはフライティングリング(OSバージョン内のサブグループとして)を指定する次のいずれかの文字列。 Windows 11 の場合: バージョン 2110 Windows 10 の場合:
Windows Server 1709 の場合:
Windows Server 2016 の場合:
Windows 8.1 の場合:
Windows 7 の場合:
OS リリースまたはフライティング リングが不明な場合、このフィールドの値は [不明] になります。 |
市場 | ひも | デスクトップ アプリケーションがブロックされている市場の ISO 3166 国コード。 |
デバイスタイプ | ひも | デスクトップ アプリケーションがブロックされるデバイスの種類を指定する次のいずれかの文字列。
|
ブロックタイプ | ひも | デバイスで見つかったブロックの種類を指定する次のいずれかの文字列。
|
建築 | ひも | ブロックが存在するデバイスのアーキテクチャ:
|
ターゲットOS | ひも | デスクトップ アプリケーションの実行がブロックされている Windows 10 または Windows 11 OS リリースを指定する次のいずれかの文字列。
|
デバイス数 | 数 | 指定した集計レベルでブロックを持つ個別のデバイスの数。 |
応答の例
次の例は、この要求の JSON 応答本文の例を示しています。
{
"Value": [
{
"applicationId": "10238467886765136388",
"date": "2018-06-03",
"productName": "Contoso Demo",
"fileName": "contosodemo.exe",
"applicationVersion": "2.2.2.0",
"osVersion": "Windows 8.1",
"osRelease": "Update 1",
"market": "ZA",
"deviceType": "All",
"blockType": "Runtime Notification",
"architecture": "X86",
"targetOs": "RS4",
"deviceCount": 120
}
],
"@nextLink": "desktop/blockhits?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
"TotalCount": 23012
}
関連トピック
- Windows デスクトップ アプリケーション プログラム
- デスクトップ アプリケーションのアップグレード ブロックの詳細を取得