Abrufen von Upgradeblockierungen für Ihre Desktopanwendung

Verwenden Sie diesen REST-URI, um Informationen zu Windows 10- und Windows 11-Geräten zu erhalten, auf denen Ihre Desktopanwendung ein Windows 10- oder Windows 11-Upgrade 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.

Details 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

Um diese Methode zu verwenden, müssen Sie zuerst Folgendes tun:

  • Falls noch nicht geschehen, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API.
  • 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. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.

Anfordern

Anforderungssyntax

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

Anforderungsheader

Header Typ Beschreibung
Autorisierung Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.

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 jeden Analysebericht für Ihre Desktopanwendung im Partner Center (z. B. den Blockbericht), 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. Die Standardeinstellung ist das aktuelle Datum. Nein
Oben int Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Höchstwert und der Standardwert, falls nicht angegeben, ist 10000. Wenn in der Abfrage weitere Zeilen vorhanden sind, enthält der Antworttext einen nächsten Link, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. Nein
skip int Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datasets zu durchlaufen. Beispielsweise ruft top=10000 und skip=0 die ersten 10000 Datenzeilen ab, top=100000 und skip=10000 ruft die nächsten 10000 Datenzeilen usw. ab. Nein
filter Zeichenfolge Eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Jede Anweisung enthält einen Feldnamen aus dem Antwortkörper und einen Wert, die mit den Operatoren eq oder ne verbunden sind, und Anweisungen können mit and oder or kombiniert werden. Zeichenfolgenwerte müssen von einfachen Anführungszeichen im Filter-Parameter umgeben sein. Sie können die folgenden Felder aus dem Antworttext angeben:

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • fileName
  • market
  • osRelease
  • osVersion
  • productName
  • targetOs
No
orderby Zeichenfolge Eine Anweisung, die die Ergebnisdatenwerte für jeden Block anordnet. Die Syntax ist orderby=field [order],field [order],.... Der Feldparameter kann eines der folgenden Felder aus dem Antworttext sein:

  • applicationVersion
  • architecture
  • blockType
  • date
  • deviceType
  • fileName
  • market
  • osRelease
  • osVersion
  • productName
  • targetOs
  • deviceCount

Der Order-Parameter ist optional und kann asc oder desc sein, um die aufsteigende oder absteigende Reihenfolge für jedes Feld anzugeben. Die Standardeinstellung ist asc.

Hier ist ein Beispiel für eine orderby-Zeichenfolge: orderby=date,market

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

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • fileName
  • market
  • osRelease
  • osVersion
  • targetOs

Die zurückgegebenen Datenzeilen enthalten die im groupby-Parameter angegebenen Felder sowie Folgendes:

  • applicationId
  • date
  • productName
  • deviceCount

No

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 Desktop-Anwendung.

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 zusätzliche Datenseiten vorhanden sind, enthält diese Zeichenfolge einen URI, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. Dieser Wert wird beispielsweise zurückgegeben, wenn der oberste Parameter der Anforderung auf 10000 festgelegt ist, aber für die Abfrage mehr als 10000 Zeilen mit Blockdaten vorhanden sind.
TotalCount int Die Gesamtanzahl der Zeilen im Datenergebnis für die Abfrage.

Elemente im Value-Array 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 Blocktrefferwert zugeordnet ist.
productName Zeichenfolge Der Anzeigename der Desktopanwendung, die von den Metadaten der zugeordneten ausführbaren Dateien abgeleitet wurde.
fileName Zeichenfolge Die ausführbare Datei, die blockiert wurde.
applicationVersion Zeichenfolge Die Version der ausführbaren Anwendung, die blockiert wurde.
osVersion Zeichenfolge Eine der folgenden Zeichenfolgen, die die Betriebssystemversion angibt, auf 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 den Betriebssystemversions- oder Flighting-Ring (als Unterpopulation 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
  • Vorschauversion
  • Insider Fast
  • Insider Slow

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.

Markt Zeichenfolge Der ISO 3166-Ländercode des Marktes, in dem die Desktopanwendung blockiert wird.
deviceType Zeichenfolge Eine der folgenden Zeichenfolgen, die den Gerätetyp 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 ihren Bedeutungen für Entwickler und Benutzer finden Sie in der Beschreibung des Berichts "Anwendungsblöcke".
architecture 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, auf der die Desktopanwendung nicht ausgeführt wird:

  • Version 1709
  • Version 1803
deviceCount Zahl Die Anzahl der unterschiedlichen Geräte, die Blöcke auf der angegebenen Aggregationsebene aufweisen.

Beispielantwort

Im folgenden Beispiel wird ein Beispiel für einen JSON-Antworttext für diese Anforderung veranschaulicht.

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