Obter bloqueios de atualização para seu aplicativo da área de trabalho

Use esse URI REST para obter informações sobre o Windows 10 e Windows 11 dispositivos 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 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 do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a 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 este 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.

Solicitação

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

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< do formulário.

Parâmetros da solicitação

Parâmetro Type 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 é 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 o valor padrão; se não forem especificados, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um 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 este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recuperam as primeiras 10.000 linhas de dados, top=10000 e skip=10000 recuperam as próximas 10.000 linhas de dados e assim por diante. Não
filter string Uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um nome de campo do corpo de resposta e um valor que estão associados aos operadores eq ou ne, e as instruções podem ser combinadas usando-se and ou or. Os valores de sequência devem estar entre aspas simples no parâmetro filter. Você pode especificar os campos a seguir do corpo da resposta:

  • applicationVersion
  • Arquitetura
  • blockType
  • Devicetype
  • fileName
  • Mercado
  • osRelease
  • Osversion
  • Productname
  • targetOs
Não
orderby string Uma instrução que ordena os valores de dados de resultado para cada bloco. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser um dos seguintes campos do corpo da resposta:

  • applicationVersion
  • Arquitetura
  • blockType
  • date
  • Devicetype
  • fileName
  • Mercado
  • osRelease
  • Osversion
  • Productname
  • targetOs
  • deviceCount

O parâmetro order é opcional e pode ser asc ou desc para especificar a ordem crescente ou decrescente de cada campo. O padrão é asc.

Aqui está um exemplo de cadeia de caracteres orderby : orderby=date,market

Não
groupby string Uma instrução que aplica a agregação de dados apenas aos campos especificados. Você pode especificar os campos a seguir do corpo da resposta:

  • applicationVersion
  • Arquitetura
  • blockType
  • Devicetype
  • fileName
  • Mercado
  • osRelease
  • Osversion
  • targetOs

As linhas de dados retornados conterão os campos especificados no parâmetro groupby, bem como o seguinte:

  • applicationId
  • date
  • Productname
  • deviceCount

Não

Exemplo de solicitação

O exemplo a seguir demonstra várias solicitações para obter dados de bloco de aplicativo da área de trabalho. Substitua o valor applicationId pela ID do produto para seu 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 Tipo Descrição
Valor array 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 cadeia de caracteres 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 superior da solicitação for definido como 10000, mas houver mais de 10.000 linhas de dados de bloco para a consulta.
TotalCount INT O número total de linhas no resultado dos dados da consulta.

Os elementos na matriz Value contêm os valores a seguir.

Valor Tipo Descrição
applicationId string A ID do produto do aplicativo da área de trabalho para o qual você recuperou dados de 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 de 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á em execução no momento:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Desconhecido
osRelease string Uma das cadeias de caracteres a seguir que especifica a versão do sistema operacional ou o anel de versão de pré-lançamento (como uma subpopulação na versão do sistema operacional) na qual o aplicativo da área de trabalho está em execução no momento.

Para Windows 11: Versão 2110

No Windows 10:

  • Versão 1507
  • Versão 1511
  • Versão 1607
  • Versão 1703
  • Versão 1709
  • Versão prévia de lançamento
  • Participante do Programa Windows Insider - Modo Rápido
  • Participante do Programa Windows Insider - Modo Lento

Para o Windows Server 1709:

  • RTM

Para o Windows Server 2016:

  • Versão 1607

No Windows 8.1:

  • Atualização 1

No Windows 7:

  • Service Pack 1

Se a versão do sistema operacional ou anel de liberação de versão de pré-lançamento for desconhecida, este campo terá o valor Desconhecido.

market string O código de país ISO 3166 do mercado no qual o aplicativo da área de trabalho 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:

  • PC
  • Servidor
  • Tablet
  • Desconhecido
blockType string Uma das seguintes cadeias de caracteres que especifica o tipo de bloco encontrado no dispositivo:

  • Sedimentos potenciais
  • Sedimentos temporários
  • Notificação de runtime

Para obter mais informações sobre esses tipos de bloco e o que eles significam para desenvolvedores e usuários, consulte a descrição do relatório Blocos de aplicativos.
Arquitetura string A arquitetura do dispositivo no qual o bloco existe:

  • ARM64
  • X86
targetOs 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:

  • Versão 1709
  • Versão 1803
deviceCount número O número de dispositivos distintos que têm blocos no nível de agregação especificado.

Exemplo de resposta

O código a seguir demonstra 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
}