Abrufen von Upgradeblockierungen für Ihre Desktopanwendung

Verwenden Sie diesen REST-URI, um Informationen zu Windows 10 und Windows 11 Geräten abzurufen, auf denen Ihre Desktopanwendung die Ausführung eines Windows 10 oder Windows 11 Upgrades blockiert. Sie können diesen URI nur für Desktopanwendungen verwenden, die Sie dem Windows-Desktopanwendungsprogramm hinzugefügt haben. Diese Informationen sind auch im Bericht Anwendungsblöcke für Desktopanwendungen im Partner Center verfügbar.

Informationen zu Geräteblöcken für eine bestimmte ausführbare Datei in Ihrer Desktopanwendung finden Sie unter Abrufen von Upgradeblockdetails für Ihre Desktopanwendung.

Voraussetzungen

Zur Verwendung dieser Methode sind folgende Schritte erforderlich:

  • Wenn Sie dies noch nicht getan haben, müssen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API erfüllen.
  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.

Anforderung

Anforderungssyntax

Methode Anforderungs-URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits

Anforderungsheader

Header type BESCHREIBUNG
Authorization Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Format Bearertoken<>.

Anforderungsparameter

Parameter Typ BESCHREIBUNG Erforderlich
applicationId Zeichenfolge Die Produkt-ID der Desktopanwendung, für die Sie Blockdaten abrufen möchten. Um die Produkt-ID einer Desktopanwendung abzurufen, öffnen Sie einen beliebigen Analysebericht für Ihre Desktopanwendung im Partner Center (z. B. den Bericht Blöcke), und rufen Sie die Produkt-ID aus der URL ab. Ja
startDate date Das Startdatum im Datumsbereich der abzurufenden Blockdaten. Der Standardwert ist 90 Tage vor dem aktuellen Datum. Nein
endDate date Das Enddatum im Datumsbereich der abzurufenden Blockdaten. Als Standardeinstellung wird das aktuelle Datum festgelegt. Nein
top INT Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Maximal- und Standardwert ist 10.000, wenn nicht anders angegeben. 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. Nein
skip INT Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern. 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. Nein
filter Zeichenfolge Mindestens eine Anweisung, die die Zeilen in der Antwort filtert. Jede Anweisung enthält einen Feldnamen aus dem Antworttext und -wert, die den Operatoren eq oder ne zugeordnet sind, und Anweisungen können mit undoder kombiniert werden. Zeichenfolgenwerte im Parameter filter müssen von einfachen Anführungszeichen eingeschlossen werden. Sie können die folgenden Felder im Antworttext angeben:

  • applicationVersion
  • architecture
  • blockType
  • Devicetype
  • fileName
  • Markt
  • osRelease
  • osVersion
  • Productname
  • targetOs
Nein
orderby Zeichenfolge Eine Anweisung, die die Ergebnisdatenwerte für jeden Block anordnet. Die Syntax lautet orderby=field [order],field [order],.... Der Field-Parameter kann eines der folgenden Felder aus dem Antworttext sein:

  • applicationVersion
  • architecture
  • blockType
  • date
  • Devicetype
  • fileName
  • Markt
  • osRelease
  • osVersion
  • Productname
  • targetOs
  • deviceCount

Der Parameter order ist optional und kann asc oder desc sein, um die auf- oder absteigende Anordnung der einzelnen Felder anzugeben. Der Standardwert ist asc.

Hier ist ein Beispiel für orderby string: orderby=date,market

Nein
groupby Zeichenfolge Eine Anweisung, die nur auf die angegebenen Felder Datenaggregationen anwendet. Sie können die folgenden Felder im Antworttext angeben:

  • applicationVersion
  • architecture
  • blockType
  • Devicetype
  • fileName
  • Markt
  • osRelease
  • osVersion
  • targetOs

Die zurückgegebenen Datenzeilen enthalten die Felder, die im Parameter groupby angegeben sind, sowie die folgenden:

  • applicationId
  • date
  • Productname
  • deviceCount

Nein

Anforderungsbeispiel

Im folgenden Beispiel werden mehrere Anforderungen zum Abrufen von Blockdaten für Desktopanwendungen veranschaulicht. Ersetzen Sie den Wert applicationId durch die Produkt-ID für Ihre Desktopanwendung.

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>

Antwort

Antworttext

Wert Typ BESCHREIBUNG
Wert array Ein Array von -Objekten, die aggregierte Blockdaten enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in der folgenden Tabelle.
@nextLink Zeichenfolge 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. Dieser Wert wird beispielsweise zurückgegeben, wenn der top-Parameter der Anforderung auf 100000 festgelegt ist, aber mehr als 10.000 Zeilen mit Blockdaten für die Abfrage vorhanden sind.
TotalCount INT Die Gesamtzahl der Zeilen im Datenergebnis für die Abfrage.

Elemente im Array Value enthalten die folgenden Werte.

Wert Typ Beschreibung
applicationId Zeichenfolge Die Produkt-ID der Desktopanwendung, für die Sie Blockdaten abgerufen haben.
date Zeichenfolge Das Datum, das dem Blocktreffwert zugeordnet ist.
ProductName Zeichenfolge Der Anzeigename der Desktopanwendung, der aus den Metadaten der zugehörigen ausführbaren Datei(en) abgeleitet ist.
fileName Zeichenfolge Die ausführbare Datei, die blockiert wurde.
applicationVersion Zeichenfolge Die Version der ausführbaren Anwendungsdatei, die blockiert wurde.
osVersion Zeichenfolge Eine der folgenden Zeichenfolgen, die die Betriebssystemversion angibt, unter der die Desktopanwendung derzeit ausgeführt wird:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unbekannt
osRelease Zeichenfolge Eine der folgenden Zeichenfolgen, die das Betriebssystemrelease oder flighting Ring (als Teilpopulation innerhalb der Betriebssystemversion) angibt, auf der die Desktopanwendung derzeit ausgeführt wird.

Für Windows 11: Version 2110

Für Windows 10:

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • Version 1709
  • Releasevorschau
  • Insider Fast
  • Insider Langsam

Für Windows Server 1709:

  • RTM

Für Windows Server 2016:

  • Version 1607

Für Windows 8.1:

  • Update 1

Für Windows 7:

  • Service Pack 1

Wenn die Betriebssystemversion oder der Flighting-Ring unbekannt ist, weist dieses Feld den Wert Unbekannt auf.

market Zeichenfolge Der ISO 3166-Ländercode des Marktes, auf dem die Desktopanwendung blockiert ist.
deviceType Zeichenfolge Eine der folgenden Zeichenfolgen, die den Typ des Geräts angibt, auf dem die Desktopanwendung blockiert wird:

  • PC
  • Server
  • Tablet
  • Unbekannt
blockType Zeichenfolge Eine der folgenden Zeichenfolgen, die den Typ des auf dem Gerät gefundenen Blocks angibt:

  • Potenzielles Sediment
  • Temporäres Sediment
  • Laufzeitbenachrichtigung

Weitere Informationen zu diesen Blocktypen und was sie für Entwickler und Benutzer bedeuten, finden Sie in der Beschreibung des Berichts Anwendungsblöcke.
Architektur Zeichenfolge Die Architektur des Geräts, auf dem der Block vorhanden ist:

  • ARM64
  • X86
targetOs Zeichenfolge Eine der folgenden Zeichenfolgen, die die Windows 10 oder Windows 11 Betriebssystemversion angibt, für die die Ausführung der Desktopanwendung blockiert ist:

  • Version 1709
  • Version 1803
deviceCount number Die Anzahl der unterschiedlichen Geräte mit Blöcken auf der angegebenen Aggregationsebene.

Antwortbeispiel

Das folgende Beispiel zeigt ein Beispiel für einen JSON-Antworttext für diese Anforderung.

{
  "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
}