Hämta uppgraderingsblock för ditt skrivbordsprogram

Använd den här REST-URI:n för att få information om Windows 10- och Windows 11-enheter där ditt skrivbordsprogram blockerar en Uppgradering av Windows 10 eller Windows 11 från att köras. Du kan endast använda den här URI:n för skrivbordsprogram som du har lagt till i Windows Desktop-programprogrammet. Den här informationen finns också i rapporten Programblock för skrivbordsprogram i Partnercenter.

Information om enhetsblock för en specifik körbar fil i ditt skrivbordsprogram finns i Hämta information om uppgraderingsblock för ditt skrivbordsprogram.

Förutsättningar

Om du vill använda den här metoden måste du först göra följande:

  • Om du inte redan har gjort det, slutför alla krav som behövs för Microsoft Store Analytics-API:et.
  • Hämta en Azure AD-åtkomsttoken som ska användas i begärandehuvudet för den här metoden. När du har fått en åtkomsttoken har du 60 minuter på dig att använda den innan den upphör att gälla. När token har upphört att gälla kan du skaffa en ny.

Begäran

Begärningssyntax

Metod Begäran om URI
https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits

Förfrågningshuvudrad

Rubrik Typ Beskrivning
Auktorisering snöre Obligatoriskt. Azure AD-åtkomsttokenet i formen Bearer<token>.

Parametrar för begäran

Parameter Typ Beskrivning Krävs
applicationId snöre Produkt-ID för skrivbordsprogrammet som du vill hämta blockdata för. Om du vill hämta produkt-ID:t för ett skrivbordsprogram öppnar du alla analysrapporter för ditt skrivbordsprogram i Partnercenter (till exempel Blocks-rapporten) och hämtar produkt-ID:t från URL:en. Ja
startdatum datum Startdatumet i datumintervallet för blockdata som ska hämtas. Standardvärdet är 90 dagar före det aktuella datumet. Nej
slutdatum datum Slutdatumet i datumintervallet för blockdata som ska hämtas. Standardvärdet är det aktuella datumet. Nej
topp Int Antalet rader med data som ska returneras i begäran. Det maximala värdet och standardvärdet om det inte anges är 10000. Om det finns fler rader i frågan innehåller svarstexten en nästa länk som du kan använda för att begära nästa sida med data. Nej
hoppa över Int Antalet rader som ska hoppa över i frågan. Använd den här parametern för att bläddra igenom stora datamängder. Till exempel hämtar top=10000 och skip=0 de första 1 0000 raderna med data, top=10000 och skip=10000 hämtar nästa 1 0000 rader med data och så vidare. Nej
filter snöre En eller flera instruktioner som filtrerar raderna i svaret. Varje uttryck innehåller ett fältnamn från svarstexten och ett värde som är associerade med eq- eller ne-operatorerna, och uttrycken kan kombineras med och eller eller. Strängvärden måste omges av enkla citattecken i filterparametern. Du kan ange följande fält från svarstexten:

  • applicationVersion
  • arkitektur
  • blockTyp
  • enhetstyp
  • filnamn
  • marknad
  • osRelease
  • OS-version
  • productName (produktnamn)
  • targetOs
Nej
sortera efter snöre En instruktion som sorterar resultatdatavärdena för varje block. Syntaxen är orderby=field [order],field [order],.... Parametern fält kan vara ett av följande fält från svarstexten:

  • applicationVersion
  • arkitektur
  • blockTyp
  • datum
  • enhetstyp
  • filnamn
  • marknad
  • osRelease
  • OS-version
  • productName (produktnamn)
  • targetOs
  • enhetsantal

Orderparametern är valfri och kan vara asc eller desc för att ange stigande eller fallande ordning för varje fält. Standardvärdet är asc.

Här är ett exempel på en orderby-sträng : orderby=date,market

Nej
gruppera efter snöre En instruktion som endast tillämpar dataaggregering på de angivna fälten. Du kan ange följande fält från svarstexten:

  • applicationVersion
  • arkitektur
  • blockTyp
  • enhetstyp
  • filnamn
  • marknad
  • osRelease
  • OS-version
  • targetOs

De returnerade dataraderna innehåller de fält som anges i groupby-parametern samt följande:

  • applicationId
  • datum
  • productName (produktnamn)
  • enhetsantal

Nej

Exempel på begäran

I följande exempel visas flera begäranden om att hämta blockdata för skrivbordsprogram. Ersätt värdet applicationId med produkt-ID:t för ditt skrivbordsprogram.

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>

Svar

Svarsdel

Värde Typ Beskrivning
Värde samling En matris med objekt som innehåller aggregerade blockdata. Mer information om data i varje objekt finns i följande tabell.
@nextLink snöre Om det finns ytterligare sidor med data innehåller den här strängen en URI som du kan använda för att begära nästa sida med data. Det här värdet returneras till exempel om den översta parametern för begäran är inställd på 10000 men det finns mer än 1 0000 rader blockdata för frågan.
Totalantal Int Det totala antalet rader i dataresultatet för frågan.

Element i matrisen Value innehåller följande värden.

Värde Typ Beskrivning
applicationId snöre Produkt-ID för skrivbordsprogrammet som du hämtade blockdata för.
datum snöre Det datum som är associerat med värdet för blockträffar.
produktnamn snöre Visningsnamnet för skrivbordsprogrammet som härletts från metadata för dess associerade körbara filer.
filnamn snöre Den körbara fil som blockerades.
applikationsversion snöre Den körbara versionen av programmet som blockerades.
osVersion snöre En av följande strängar som anger den operativsystemversion som skrivbordsprogrammet för närvarande kör:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Okänd
osRelease snöre En av följande strängar som anger operativsystemets versionsnummer eller distributionsring (som en delpopulation inom OS-versionen) där skrivbordsprogrammet för närvarande körs.

För Windows 11: Version 2110

För Windows 10:

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • Version 1709
  • Förhandsversion
  • Insider – snabb
  • Insider-läge långsamt

För Windows Server 1709:

  • RTM

För Windows Server 2016:

  • Version 1607

För Windows 8.1:

  • Uppdatering 1

För Windows 7:

  • Service Pack 1 (Service Pack)

Om OS-versionen eller flygringen är okänd har det här fältet värdet Okänd.

marknad snöre ISO 3166-landskoden för den marknad där skrivbordsprogrammet blockeras.
enhetstyp snöre En av följande strängar som anger vilken typ av enhet som skrivbordsprogrammet blockeras på:

  • PERSONDATOR
  • Server
  • Tablett
  • Okänd
blocktyp snöre En av följande strängar som anger vilken typ av block som finns på enheten:

  • Potentiellt sediment
  • tillfälligt sediment
  • Körningsvarning

Mer information om dessa blocktyper och vad de betyder för utvecklare och användare finns i beskrivningen av rapporten Programblock.
arkitektur snöre Arkitekturen för enheten där blocket finns:

  • ARM64
  • X86
targetOs snöre En av följande strängar som anger den Windows 10- eller Windows 11 OS-version där skrivbordsprogrammet blockeras från att köras:

  • Version 1709
  • Version 1803
Antal enheter nummer Antalet distinkta enheter som har block på den angivna aggregeringsnivån.

Svarsexempel

I följande exempel visas ett exempel på JSON-svarstext för den här begäran.

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