Ottenere i dettagli dei blocchi di aggiornamento per l'applicazione desktop

Usare questo URI REST per ottenere dettagli per i dispositivi Windows 10 e Windows 11 su cui un eseguibile specifico nell'applicazione desktop blocca l'esecuzione dell'aggiornamento di Windows 10 o Windows 11. È possibile usare questo URI solo per le applicazioni desktop aggiunte al programma per applicazioni desktop di Windows. Queste informazioni sono anche disponibili nel report sui blocchi delle applicazioni per le applicazioni desktop nel Centro per i partner.

Questo URI è simile al recupero di blocchi di aggiornamento per l'applicazione desktop, ma restituisce le informazioni sui blocchi per un eseguibile specifico nell'applicazione desktop.

Prerequisiti

Per usare questo metodo, è necessario prima eseguire le operazioni seguenti:

  • Se non lo si è ancora fatto, completare i prerequisiti per l'API di analisi di Microsoft Store.
  • Ottenere un token di accesso di Azure AD da usare nell'intestazione della richiesta per questo metodo. Dopo aver ottenuto un token di accesso, questo sarà disponibile per 60 minuti prima della scadenza. Dopo la scadenza del token, è possibile ottenerne uno nuovo.

Richiesta

Sintassi della richiesta

metodo URI della richiesta
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails

Intestazione della richiesta

Intestazione Type Descrizione
Autorizzazione stringa Obbligatorio. Token di accesso di Azure AD nel formato Token di<connessione>.

Parametri della richiesta

Parametro Tipo Descrizione Richiesto
applicationId string ID prodotto dell'applicazione desktop per cui si desidera recuperare i dati sui blocchi. Per ottenere l'ID prodotto di un'applicazione desktop, aprire qualsiasi report di analisi partner per l'applicazione desktop (ad esempio il report sui blocchi) e recuperare l'ID prodotto dall'URL.
fileName string Nome dell'eseguibile bloccato
startDate data Data di inizio nell'intervallo di date dei dati sui blocchi da recuperare. Il valore predefinito è 90 giorni prima della data corrente. No
endDate data Data di fine nell'intervallo di date dei dati sui blocchi da recuperare. L'impostazione predefinita è la data corrente. No
migliori int Numero di righe di dati da restituire nella richiesta. Il valore massimo e il valore predefinito, se non specificati, sono pari a 10000. Se nella query sono presenti più righe, il corpo della risposta includerà un collegamento che consente di richiedere la pagina successiva dei dati. No
skip int Numero di righe da ignorare nella query. Usare questo parametro per scorrere i set di dati di grandi dimensioni. Ad esempio, top=10000 e skip=0 recupera le prime 10.000 righe di dati, top=10000 e skip=10000 recupera le 10.000 righe di dati successive e così via. No
filter string Una o più istruzioni che filtrano le righe nella risposta. Ogni istruzione contiene un nome di campo del corpo della risposta e un valore associati agli operatori eq o ne e le istruzioni possono essere combinate usando and o or. I valori stringa devono essere racchiusi tra virgolette singole nel parametro filter. È possibile specificare i campi seguenti del corpo della risposta:

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • market
  • osRelease
  • osVersion
  • productName
  • targetOs
No
orderby string Istruzione che ordina i valori dei dati dei risultati per ogni blocco. La sintassi è orderby=field [order],field [order],.... Il parametro field può essere uno dei campi seguenti del corpo della risposta:

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

Il parametro order è facoltativo e può essere asc o desc per specificare l'ordine crescente o decrescente di ogni campo. Il valore predefinito è asc.

Di seguito è riportato un esempio di stringa orderby: orderby=date,market

No
groupby string Istruzione che applica l'aggregazione dei dati solo ai campi specificati. È possibile specificare i campi seguenti del corpo della risposta:

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

Le righe di dati restituite conterranno i campi specificati nel parametro groupby e i seguenti:

  • applicationId
  • date
  • productName
  • deviceCount

No

Esempio di richiesta

L'esempio seguente illustra diverse richieste di recupero dei dati sui blocchi dell'applicazione desktop. Sostituire il valore applicationId con l'ID prodotto dell'applicazione desktop.

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

Corpo della risposta

Valore Tipo Descrizione
Valore matrice Matrice di oggetti che contengono dati aggregati sui blocchi. Per ulteriori informazioni sui dati in ogni oggetto, vedere la tabella seguente.
@nextLink string Se vi sono ulteriori pagine di dati, la stringa conterrà un URI che è possibile usare per richiedere la pagina di dati successiva. Ad esempio, questo valore viene restituito se il parametro top della richiesta è impostato su 10000 ma vi sono più di 10.000 righe di dati sui bocchi per la query.
TotalCount int Numero totale di righe nei risultati di dati per la query.

Gli elementi nella matrice Value contengono i valori seguenti.

Valore Tipo Descrizione
applicationId string ID prodotto dell'applicazione desktop per cui si sono recuperati i dati sui blocchi.
data string Data associata al valore di riscontri di blocchi.
productName string Nome visualizzato dell'applicazione desktop derivato dai metadati dei relativi eseguibili associati.
fileName string Eseguibile bloccato.
applicationVersion string Versione dell'eseguibile dell'applicazione bloccata.
osVersion string Una delle stringhe seguenti che specifica la versione del sistema operativo in cui è attualmente in esecuzione l'applicazione desktop:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string Una delle stringhe seguenti che specifica la release del sistema operativo o l'anello di anteprima (come sottopopolazione all'interno della versione del sistema operativo) in cui è attualmente in esecuzione l'applicazione desktop.

Per Windows 11: versione 2110

Per Windows 10:

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • Version 1709
  • Release Preview
  • Insider Fast
  • Insider Slow

Per Windows Server 1709:

  • RTM

Per Windows Server 2016:

  • Version 1607

Per Windows 8.1:

  • Aggiornamento 1

Per Windows 7:

  • Service Pack 1

Se il rilascio del sistema operativo o l'anello di anteprima è sconosciuto, questo campo ha il valore Unknown.

market string Codice Paese ISO 3166 del mercato in cui l'applicazione desktop è bloccata.
deviceType string Una delle stringhe seguenti che specifica il tipo di dispositivo in cui l'applicazione desktop è bloccata:

  • PC
  • Server
  • Tablet
  • Unknown
blockType string Una delle stringhe seguenti che specifica il tipo di blocco trovato nel dispositivo:

  • Potential Sediment
  • Temporary Sediment
  • Runtime Notification

Per ulteriori informazioni su questi tipi di blocchi e su ciò che significano per sviluppatori e utenti, vedere la descrizione del report sui blocchi delle applicazioni.
architecture string Architettura del dispositivo in cui è presente il blocco:

  • ARM64
  • X86
targetOs string Una delle stringhe seguenti che specifica la versione del sistema operativo Windows 10 o Windows 11 in cui è bloccata l'esecuzione dell'applicazione desktop:

  • Version 1709
  • Version 1803
deviceCount Numero Numero di dispositivi distinti con blocchi al livello di aggregazione specificato.

Risposta di esempio

L'esempio seguente illustra un esempio di corpo della risposta JSON per questa richiesta.

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