Abrufen von Details zur Upgradeblockierung für Ihre DesktopanwendungGet upgrade block details for your desktop application

Verwenden Sie diesen Rest-URI, um Details für Windows 10-Geräte zu erhalten, auf denen eine bestimmte ausführbare Datei in der Desktop Anwendung die Ausführung eines Windows 10-Upgrades blockiert.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. Sie können diesen URI nur für Desktop Anwendungen verwenden, die Sie dem Windows-Desktop Anwendungsprogrammhinzugefügt haben.You can use this URI only for desktop applications that you have added to the Windows Desktop Application program. Diese Informationen sind auch im Bericht " Anwendungs Blöcke " für Desktop Anwendungen in Partner Center verfügbar.This information is also available in the Application blocks report for desktop applications in Partner Center.

Dieser URI ähnelt dem erzielen von upgradeblöcken für Ihre Desktop Anwendung, gibt jedoch Geräte Block Informationen für eine bestimmte ausführbare Datei in der Desktop Anwendung zurück.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.

VoraussetzungenPrerequisites

Zur Verwendung dieser Methode sind folgende Schritte erforderlich:To use this method, you need to first do the following:

  • Wenn Sie dies nicht bereits getan haben, müssen Sie alle Voraussetzungen für die Microsoft Store Analytics-API erfüllen.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird.Obtain an Azure AD access token to use in the request header for this method. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft.After you obtain an access token, you have 60 minutes to use it before it expires. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.After the token expires, you can obtain a new one.

AnforderungRequest

AnforderungssyntaxRequest syntax

MethodeMethod Anforderungs-URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails

AnforderungsheaderRequest header

HeaderHeader typeType BESCHREIBUNGDescription
AuthorizationAuthorization Zeichenfolgestring Erforderlich.Required. Das Azure AD-Zugriffstoken im Format Bearer <token>.The Azure AD access token in the form Bearer <token>.

AnforderungsparameterRequest parameters

ParameterParameter TypType BESCHREIBUNGDescription ErforderlichRequired
applicationIdapplicationId Zeichenfolgestring Die Produkt-ID der Desktop Anwendung, für die Sie Blockdaten abrufen möchten.The product ID of the desktop application for which you want to retrieve block data. Wenn Sie die Produkt-ID einer Desktop Anwendung abrufen möchten, öffnen Sie einen beliebigen Analysebericht für Ihre Desktop Anwendung im Partner Center (z. b. den Bericht "Blöcke"), und rufen Sie die Produkt-ID aus der URL ab.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. JaYes
fileNamefileName Zeichenfolgestring Der Name der gesperrten ausführbaren Datei.The name of the blocked executable
startDatestartDate datedate Das Startdatum im Datumsbereich der abzurufenden Blockdaten.The start date in the date range of block data to retrieve. Der Standardwert ist 90 Tage vor dem aktuellen Datum.The default is 90 days prior to the current date. NeinNo
endDateendDate datedate Das Enddatum im Datumsbereich von Blockdaten, die abgerufen werden sollen.The end date in the date range of block data to retrieve. Als Standardeinstellung wird das aktuelle Datum festgelegt.The default is the current date. NeinNo
toptop INTint Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen.The number of rows of data to return in the request. Der Maximal- und Standardwert ist 10.000, wenn nicht anders angegeben.The maximum value and the default value if not specified is 10000. Sind in der Abfrage keine weiteren Zeilen, enthält der Antworttext den Link „Weiter“, über den Sie die nächste Seite mit Daten anfordern können.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. NeinNo
skipskip INTint Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen.The number of rows to skip in the query. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern.Use this parameter to page through large data sets. Beispielsweise rufen „top=10000“ und „skip=0“ die ersten 10.000 Datenzeilen ab, „top=10000“ und „skip=10000“ die nächsten 10.000 Datenzeilen usw.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. NeinNo
filterfilter Zeichenfolgestring Mindestens eine Anweisung, die die Zeilen in der Antwort filtert.One or more statements that filter the rows in the response. Jede-Anweisung enthält einen Feldnamen aus dem Antworttext und den Wert, die den EQ -oder ne -Operatoren zugeordnet sind, und-Anweisungen können mithilfe von and oder orkombiniert werden.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. Zeichenfolgenwerte im Parameter filter müssen von einfachen Anführungszeichen eingeschlossen werden.String values must be surrounded by single quotes in the filter parameter. Sie können die folgenden Felder aus dem Antworttext angeben:You can specify the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • den DeviceType "deviceType
  • Marktforschungsmarket
  • osReleaseosRelease
  • osVersionosVersion
  • ProductNameproductName
  • targetOstargetOs
NeinNo
orderbyorderby Zeichenfolgestring Eine-Anweisung, die die Ergebnisdaten Werte für jeden Block anordnet.A statement that orders the result data values for each block. Die Syntax lautet OrderBy = Field [Order], Field [Order],.... Der Feld Parameter kann eines der folgenden Felder aus dem Antworttext sein: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
  • den DeviceType "deviceType
  • Marktforschungsmarket
  • osReleaseosRelease
  • osVersionosVersion
  • ProductNameproductName
  • targetOstargetOs
  • devicecountdeviceCount

Der Parameter order ist optional und kann asc oder desc sein, um die auf- oder absteigende Anordnung der einzelnen Felder anzugeben.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Der Standardwert ist ASC.The default is asc.

Hier ist ein Beispiel für eine OrderBy -Zeichenfolge: OrderBy = Date, MarketHere is an example orderby string: orderby=date,market

NeinNo
groupbygroupby Zeichenfolgestring Eine Anweisung, die nur auf die angegebenen Felder Datenaggregationen anwendet.A statement that applies data aggregation only to the specified fields. Sie können die folgenden Felder aus dem Antworttext angeben:You can specify the following fields from the response body:

  • applicationVersionapplicationVersion
  • architecturearchitecture
  • blockTypeblockType
  • den DeviceType "deviceType
  • Marktforschungsmarket
  • osReleaseosRelease
  • osVersionosVersion
  • targetOstargetOs

Die zurückgegebenen Datenzeilen enthalten die Felder, die im Parameter groupby angegeben sind, sowie die folgenden:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • applicationIdapplicationId
  • datedate
  • ProductNameproductName
  • devicecountdeviceCount

NeinNo

AnforderungsbeispielRequest example

Im folgenden Beispiel werden mehrere Anforderungen zum erhalten von Daten für Desktop Anwendungs Blöcke veranschaulicht.The following example demonstrates several requests for getting desktop application block data. Ersetzen Sie den Wert ApplicationId durch die Produkt-ID für Ihre Desktop Anwendung.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>

AntwortResponse

AntworttextResponse body

WertValue TypType BESCHREIBUNGDescription
WertValue arrayarray Ein Array von-Objekten, die Aggregat Blockdaten enthalten.An array of objects that contain aggregate block data. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in der folgenden Tabelle.For more information about the data in each object, see the following table.
@nextLink Zeichenfolgestring Wenn weitere Seiten mit Daten vorhanden sind, enthält diese Zeichenfolge einen URI, mit dem Sie die nächste Seite mit Daten anfordern können.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Dieser Wert wird z. b. zurückgegeben, wenn der Top -Parameter der Anforderung auf 10000 festgelegt ist, aber mehr als 10000 Zeilen mit Blockdaten für die Abfrage vorhanden sind.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 Die Gesamtzahl der Zeilen im Datenergebnis für die Abfrage.The total number of rows in the data result for the query.

Elemente im Array Value enthalten die folgenden Werte.Elements in the Value array contain the following values.

WertValue TypType BESCHREIBUNGDescription
applicationIdapplicationId Zeichenfolgestring Die Produkt-ID der Desktop Anwendung, für die Sie Blockdaten abgerufen haben.The product ID of the desktop application for which you retrieved block data.
datedate Zeichenfolgestring Das Datum, das dem Block Treffer Wert zugeordnet ist.The date associated with the block hits value.
ProductNameproductName Zeichenfolgestring Der Anzeige Name der Desktop Anwendung, die von den Metadaten der zugehörigen ausführbaren Dateien abgeleitet ist.The display name of the desktop application as derived from the metadata of its associated executable(s).
fileNamefileName Zeichenfolgestring Die ausführbare Datei, die blockiert wurde.The executable that was blocked.
applicationVersionapplicationVersion Zeichenfolgestring Die Version der ausführbaren Datei der Anwendung, die blockiert wurde.The version of the application executable that was blocked.
osVersionosVersion Zeichenfolgestring Eine der folgenden Zeichen folgen, die die Betriebssystemversion angibt, auf der die Desktop Anwendung derzeit ausgeführt wird: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
  • UnbekanntUnknown
osReleaseosRelease Zeichenfolgestring Eine der folgenden Zeichen folgen, die das Betriebssystem Release oder den flighting-Ring (als untergeordnete Population innerhalb der Betriebssystemversion) angibt, auf dem die Desktop Anwendung derzeit ausgeführt wird.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.

Für Windows 10:For Windows 10:

  • Version 1507Version 1507
  • Version 1511Version 1511
  • Version 1607Version 1607
  • Version 1703Version 1703
  • Version 1709Version 1709
  • ReleasevorschauRelease Preview
  • Insider fastInsider Fast
  • Insider langsamInsider Slow

Für Windows Server 1709:For Windows Server 1709:

  • RTMRTM

Für Windows Server 2016:For Windows Server 2016:

  • Version 1607Version 1607

Für Windows 8.1:For Windows 8.1:

  • Update 1Update 1

Für Windows 7:For Windows 7:

  • Service Pack 1Service Pack 1

Wenn das Betriebssystem Release oder der flighting-Ring unbekannt ist, hat dieses Feld den Wert Unknown.If the OS release or flighting ring is unknown, this field has the value Unknown.

marketmarket Zeichenfolgestring Der ISO 3166-Ländercode des Markts, auf dem die Desktop Anwendung blockiert wird.The ISO 3166 country code of the market in which the desktop application is blocked.
deviceTypedeviceType Zeichenfolgestring Eine der folgenden Zeichen folgen, die den Typ des Geräts angibt, auf dem die Desktop Anwendung blockiert ist:One of the following strings that specifies the type of device on which the desktop application is blocked:

  • PCsPC
  • ServerServer
  • TabletTablet
  • UnbekanntUnknown
blockTypeblockType Zeichenfolgestring Eine der folgenden Zeichen folgen, die den Typ des auf dem Gerät gefundenen Blocks angibt:One of the following strings that specifies the type of block found on the device:

  • Potenzieller SedimentPotential Sediment
  • Temporäres SedimentTemporary Sediment
  • Lauf Zeit BenachrichtigungRuntime Notification

Weitere Informationen zu diesen Blocktypen und deren Bedeutung für Entwickler und Benutzer finden Sie in der Beschreibung des Berichts zu Anwendungs Blöcken.For more information about these block types and what they mean to developers and users, see the description of the Application blocks report.

Architekturarchitecture Zeichenfolgestring Die Architektur des Geräts, auf dem der Block vorhanden ist:The architecture of the device on which the block exists:

  • ARM64ARM64
  • X86X86
targetOstargetOs Zeichenfolgestring Eine der folgenden Zeichen folgen, die die Version des Windows 10-Betriebssystems angibt, auf der die Ausführung der Desktop Anwendung blockiert ist:One of the following strings that specifies the Windows 10 OS release on which the desktop application is blocked from running:

  • Version 1709Version 1709
  • Version 1803Version 1803
deviceCountdeviceCount numbernumber Die Anzahl der unterschiedlichen Geräte, die Blöcke auf der angegebenen Aggregations Ebene aufweisen.The number of distinct devices that have blocks at the specified aggregation level.

AntwortbeispielResponse example

Das folgende Beispiel zeigt ein Beispiel für einen JSON-Antworttext für diese Anforderung.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
}