デスクトップ アプリケーションのアップグレード ブロックの詳細情報の取得Get upgrade block details for your desktop application

この REST URI を使用して、デスクトップ アプリケーションで特定の実行可能ファイルが、Windows 10 アップグレードの実行をブロックは、Windows 10 デバイスの詳細を取得します。Use this REST URI to get details for Windows 10 devices on which a specific executable in your desktop application is blocking a Windows 10 upgrade from running. この URI を使用して、デスクトップ アプリケーションに追加するだけで、 Windows デスクトップ アプリケーション プログラムします。You can use this URI only for desktop applications that you have added to the Windows Desktop Application program. この情報も記載されて、アプリケーション ブロック レポートパートナー センターでのデスクトップ アプリケーションです。This information is also available in the Application blocks report for desktop applications in Partner Center.

この URI はのようなデスクトップ アプリケーションの取得のアップグレードがブロックが、デスクトップ アプリケーションで実行可能ファイルを特定のデバイスのブロック情報が返されます。This URI is similar to Get upgrade blocks for your desktop application, but it returns device block info for a specific executable in your desktop application.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.

要求Request

要求の構文Request syntax

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

パラメーターParameter 種類Type 説明Description 必須Required
applicationIdapplicationId stringstring ブロックのデータを取得するデスクトップ アプリケーションの製品の ID。The product ID of the desktop application for which you want to retrieve block data. デスクトップ アプリケーションの製品 ID を取得するには、いずれかを開くanalytics は、パートナー センターでデスクトップ アプリケーションのレポート(など、ブロック レポート) し、URL から、製品 ID を取得します。To get the product ID of a desktop application, open any analytics report for your desktop application in Partner Center (such as the Blocks report) and retrieve the product ID from the URL. Yes
fileNamefileName stringstring ブロックされている実行可能ファイルの名前The name of the blocked executable
startDatestartDate datedate 取得するデータ ブロックの日付範囲の開始日。The start date in the date range of block data to retrieve. 既定では、現在の日付の前に 90 日間です。The default is 90 days prior to the current date. XNo
endDateendDate datedate 取得するデータ ブロックの日付範囲の終了日。The end date in the date range of block data to retrieve. 既定値は現在の日付です。The default is the current date. XNo
toptop intint 要求で返すデータの行数です。The number of rows of data to return in the request. 最大値および指定しない場合の既定値は 10000 です。The maximum value and the default value if not specified is 10000. クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. XNo
skipskip intint クエリでスキップする行数です。The number of rows to skip in the query. 大きなデータ セットを操作するには、このパラメーターを使用します。Use this parameter to page through large data sets. たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. XNo
filterfilter stringstring 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。One or more statements that filter the rows in the response. 各ステートメントには、応答本文からのフィールド名、および eq 演算子または ne 演算子と関連付けられる値が含まれており、andor を使用してステートメントを組み合わせることができます。Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. filter パラメーターでは、文字列値を単一引用符で囲む必要があります。String values must be surrounded by single quotes in the filter parameter. 応答本文から次のフィールドを指定することができます。You can specify the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • marketmarket
  • osReleaseosRelease
  • osVersionosVersion
  • ProductNameproductName
  • targetOstargetOs
XNo
orderbyorderby stringstring 各ブロックのデータ値の結果を注文するステートメント。A statement that orders the result data values for each block. 構文は orderby=field [order],field [order],... です。field パラメーターには、応答本文から次のフィールドのいずれかを指定できます。The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • datedate
  • deviceTypedeviceType
  • marketmarket
  • osReleaseosRelease
  • osVersionosVersion
  • ProductNameproductName
  • targetOstargetOs
  • deviceCountdeviceCount

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. 既定値は asc です。The default is asc.

orderby 文字列の例: orderby=date,marketHere is an example orderby string: orderby=date,market

XNo
groupbygroupby stringstring 指定したフィールドのみにデータ集計を適用するステートメントです。A statement that applies data aggregation only to the specified fields. 応答本文から次のフィールドを指定することができます。You can specify the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • deviceTypedeviceType
  • marketmarket
  • osReleaseosRelease
  • osVersionosVersion
  • targetOstargetOs

返されるデータ行には、groupby パラメーターに指定したフィールドと次の値が含まれます。The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • applicationIdapplicationId
  • datedate
  • ProductNameproductName
  • deviceCountdeviceCount

XNo

要求の例Request example

次の例では、デスクトップ アプリケーション ブロックのデータを取得するためのいくつかの要求を示します。The following example demonstrates several requests for getting desktop application block data. 置換、 applicationIdデスクトップ アプリケーションの製品 ID を持つ値。Replace the applicationId value with the Product ID for your desktop application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&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/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&startDate=2018-05-01&endDate=2018-06-07&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
ValueValue arrayarray 集計のブロックでデータを格納するオブジェクトの配列。An array of objects that contain aggregate block data. 各オブジェクトのデータの詳細については、以下の表を参照してください。For more information about the data in each object, see the following table.
@nextLink stringstring データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。If there are additional pages of data, this string contains a URI that you can use to request the next page of data. この値が返される場合など、上部10000 に、要求のパラメーターが設定されているが、クエリのブロックでデータの 10000 個を超える行があります。For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of block data for the query.
TotalCountTotalCount intint クエリの結果データ内の行の総数です。The total number of rows in the data result for the query.

Value 配列の要素には、次の値が含まれます。Elements in the Value array contain the following values.

ValueValue 種類Type 説明Description
applicationIdapplicationId stringstring ブロックでデータを取得し、デスクトップ アプリケーションの製品の ID。The product ID of the desktop application for which you retrieved block data.
datedate stringstring ブロックのヒット数の値に関連付けられた日付。The date associated with the block hits value.
productNameproductName stringstring デスクトップ アプリケーションの表示名です。アプリケーションに関連付けられている実行可能ファイルのメタデータから取得されます。The display name of the desktop application as derived from the metadata of its associated executable(s).
fileNamefileName stringstring ブロックされた実行可能ファイル。The executable that was blocked.
applicationVersionapplicationVersion stringstring ブロックされたアプリケーションの実行可能ファイルのバージョン。The version of the application executable that was blocked.
osVersionosVersion stringstring デスクトップ アプリケーションが現在実行されている OS バージョンを指定する次の文字列のいずれか:One of the following strings that specifies the OS version on which the desktop application is currently running:

  • Windows 7Windows 7
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • Windows Server 2016Windows Server 2016
  • Windows Server 1709Windows Server 1709
  • UnknownUnknown
osReleaseosRelease stringstring (OS のバージョン内で subpopulation) として、デスクトップ アプリケーションが現在実行されている OS のリリースまたはフライト リングを指定する次の文字列の 1 つ。One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the desktop application is currently running.

Windows 10 の場合:For Windows 10:

  • バージョン 1507Version 1507
  • バージョン 1511Version 1511
  • バージョン 1607Version 1607
  • バージョン 1703Version 1703
  • バージョン 1709Version 1709
  • Release PreviewRelease Preview
  • Insider FastInsider Fast
  • 低速 insiderInsider Slow

Windows Server 1709 の場合:For Windows Server 1709:

  • RTMRTM

Windows Server 2016 の場合:For Windows Server 2016:

  • バージョン 1607Version 1607

Windows 8.1 の場合:For Windows 8.1:

  • 更新プログラム 1Update 1

Windows 7 の場合:For Windows 7:

  • Service Pack 1Service Pack 1

OS リリースまたはフライティング リングが不明な場合、このフィールドは値 Unknown になります。If the OS release or flighting ring is unknown, this field has the value Unknown.

marketmarket stringstring デスクトップ アプリケーションがブロックされている市場の ISO 3166 国コード。The ISO 3166 country code of the market in which the desktop application is blocked.
deviceTypedeviceType stringstring デスクトップ アプリケーションがブロックされているデバイスの種類を指定する次の文字列のいずれか:One of the following strings that specifies the type of device on which the desktop application is blocked:

  • PCPC
  • [サーバー]Server
  • タブレットTablet
  • UnknownUnknown
blockTypeblockType stringstring 次のブロックは、デバイスの種類を指定する文字列のいずれか:One of the following strings that specifies the type of block found on the device:

  • 潜在的な SedimentPotential Sediment
  • 一時 SedimentTemporary Sediment
  • 実行時の通知Runtime Notification

これらのブロック型と、開発者とユーザーへの影響の詳細については、の説明を参照して、アプリケーション ブロック レポートします。For more information about these block types and what they mean to developers and users, see the description of the Application blocks report.

architecturearchitecture stringstring ブロックが存在するデバイスのアーキテクチャ:The architecture of the device on which the block exists:

  • ARM64ARM64
  • X86X86
targetOstargetOs stringstring 実行するデスクトップ アプリケーションがブロックされている Windows 10 の OS のリリースを指定します、次の文字列のいずれか:One of the following strings that specifies the Windows 10 OS release on which the desktop application is blocked from running:

  • バージョン 1709Version 1709
  • バージョン 1803Version 1803
deviceCountdeviceCount numbernumber 指定された集計レベルでブロックがある個別のデバイスの数。The number of distinct devices that have blocks at the specified aggregation level.

応答の例Response example

この要求の JSON 返信の本文の例を次に示します。The following example demonstrates an example JSON response body for this request.

{
  "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/blockdetails?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}