Obter bloqueios de atualização para seu aplicativo da área de trabalho
Use esse URI REST para obter informações sobre dispositivos Windows 10 e Windows 11 nos quais seu aplicativo da área de trabalho está bloqueando a execução de uma atualização do Windows 10 ou Windows 11. Você pode usar esse URI somente para aplicativos da área de trabalho que você adicionou ao programa Aplicativo da Área de Trabalho do Windows. Essas informações também estão disponíveis no relatório de blocos de aplicativos para aplicativos da área de trabalho no Partner Center.
Para obter detalhes sobre blocos de dispositivo para um executável específico em seu aplicativo da área de trabalho, consulte Obter detalhes do bloco de atualização para seu aplicativo da área de trabalho.
Pré-requisitos
Para usar este método, primeiro você precisa fazer o seguinte:
- Se você ainda não fez isso, conclua todos os pré-requisitos da API de análise da Microsoft Store.
- Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para esse método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.
Solicitar
Sintaxe da solicitação
| Método | URI da solicitação |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits |
Cabeçalho da solicitação
| Cabeçalho | Tipo | Descrição |
|---|---|---|
| Autorização | string | Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário. |
Parâmetros da solicitação
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| applicationId | string | A ID do produto do aplicativo da área de trabalho para o qual você deseja recuperar dados de bloco. Para obter a ID do produto de um aplicativo da área de trabalho, abra qualquer relatório de análise para seu aplicativo da área de trabalho no Partner Center (como o relatório Blocos) e recupere a ID do produto da URL. | Sim |
| startDate | date | A data de início no intervalo de datas dos dados de bloco a serem recuperados. O padrão é de 90 dias antes da data atual. | Não |
| endDate | date | A data de término no intervalo de datas dos dados de bloco a serem recuperados. O padrão é a data atual. | Não |
| top | int | O número de linhas de dados a serem retornadas na solicitação. O valor máximo e padrão, se não for especificado, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um proximo link que você poderá usar para solicitar a próxima página de dados. | Não |
| skip | int | O número de linhas a serem ignoradas na consulta. Use esse parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recupera as primeiras 10.000 mil linhas de dados, top=10000 e skip=10000 recupera as próximas dez mil linhas de dados, e assim por diante. | Não |
| filtro | string | Uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um nome de campo do corpo da resposta e um valor associados aos operadores eq ou ne, e as instruções podem ser combinadas usando and ou or. Os valores de sequência devem estar entre aspas simples no parâmetro filter. Você pode especificar os seguintes campos no corpo da resposta:
|
Não |
| orderby | string | Uma instrução que ordena os valores de dados de resultado para cada bloco. A sintaxe é orderby=field [ordem],campo [ordem],.... O parâmetro de campo pode ser um dos seguintes campos do corpo da resposta:
O parâmetro order é opcional e pode ser asc ou desc para especificar ordem ascendente ou descendente para cada campo. O padrão é asc. Este é um exemplo de sequência orderby: orderby=date,market |
Não |
| groupby | string | Uma instrução que aplica agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos no corpo da resposta:
As linhas de dados retornadas conterão os campos especificados no parâmetro groupby, bem como:
|
Não |
Exemplo de solicitação
O exemplo a seguir demonstra várias solicitações para obter dados de bloco de aplicativos da área de trabalho. Substitua o valor applicationId pelo ID do Produto do aplicativo da área de trabalho.
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>
Resposta
Corpo da resposta
| Valor | Type | Descrição |
|---|---|---|
| Valor | matriz | Uma matriz de objetos que contêm dados de bloco agregados. Para obter mais informações sobre os dados em cada objeto, consulte a tabela a seguir. |
| @nextLink | string | Se houver páginas adicionais de dados, essa sequência conterá um URI que você poderá usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro top da solicitação estiver definido como 10000, mas houver mais de 10000 linhas de dados de bloco para a consulta. |
| TotalCount | int | O número total de linhas no resultado de dados da consulta. |
Os elementos na matriz Value contêm os valores a seguir.
| Valor | Type | Descrição |
|---|---|---|
| applicationId | string | A ID do produto do aplicativo da área de trabalho para o qual você recuperou os dados do bloco. |
| date | string | A data associada ao valor de ocorrências do bloco. |
| productName | string | O nome de exibição do aplicativo da área de trabalho como derivado dos metadados dos seus executáveis associados. |
| fileName | string | O executável que foi bloqueado. |
| applicationVersion | string | A versão do executável do aplicativo que foi bloqueada. |
| osVersion | string | Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional na qual o aplicativo da área de trabalho está sendo executado no momento:
|
| osRelease | string | Uma das cadeias de caracteres a seguir que especifica a versão do sistema operacional ou o anel de pré-lançamento (como uma subpopulação dentro da versão do sistema operacional) no qual o aplicativo da área de trabalho está sendo executado no momento. Para Windows 11: Versão 2110 Para Windows 10:
Para o Windows Server 1709:
Para o Windows Server 2016:
Para Windows 8.1:
Para Windows 7:
Se a versão do SO ou a versão de pré-lançamento for desconhecida, esse campo terá o valor Desconhecido. |
| market | string | O código de país ISO 3166 do mercado no qual o aplicativo de desktop está bloqueado. |
| deviceType | string | Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo no qual o aplicativo da área de trabalho está bloqueado:
|
| blockType | string | Uma das seguintes cadeias de caracteres que especifica o tipo de bloco encontrado no dispositivo:
|
| arquitetura | string | A arquitetura do dispositivo no qual o bloco existe:
|
| Os alvos | string | Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional Windows 10 ou Windows 11 na qual o aplicativo da área de trabalho está impedido de ser executado:
|
| deviceCount | número | O número de dispositivos distintos que têm blocos no nível de agregação especificado. |
Exemplo de resposta
Veja a seguir um exemplo de corpo de resposta JSON para essa solicitação.
{
"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
}