Partilhar via

Obter blocos de atualização para a sua aplicação de ambiente de trabalho

Use este 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 Windows Desktop Application. Essas informações também estão disponíveis no relatório Blocos de aplicativos para aplicativos de desktop no Partner Center.

Para obter detalhes sobre blocos de dispositivos 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 esse método, você precisa primeiro fazer o seguinte:

  • Se ainda não o fez, preencha todos os pré-requisitos para a API de análise da Microsoft Store.
  • Obtenha um token de acesso do Azure AD para usar no cabeçalho da solicitação para esse método. Depois de obter um token de acesso, você tem 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.

Solicitação

Sintaxe da solicitação

Método Solicitar URI
Obtém https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização corda Obrigatório O token de acesso do Azure AD no formato Bearer<token>.

Parâmetros de solicitação

Parâmetro Tipo Descrição Obrigatório
applicationId corda O ID do produto da aplicação de ambiente de trabalho para a qual você deseja obter blocos de dados. Para obter o ID do produto de uma aplicação de ambiente de trabalho, abra qualquer relatório de análise para a sua aplicação de ambiente de trabalho no Partner Center (tal como o relatório Blocks) e obtenha o ID do produto a partir do URL. Sim
data de início data A data de início no intervalo de datas dos dados do bloco a serem recuperados. O padrão é 90 dias antes da data atual. Não
data de término data A data final no intervalo de dados do bloco a serem recuperados. O padrão é a data atual. Não
Início 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 especificado, é 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um próximo link que você pode usar para solicitar a próxima página de dados. Não
pular 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 recupera as primeiras 10000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10000 linhas de dados e assim por diante. Não
filtro corda Uma ou mais declarações que filtram as linhas da resposta. Cada declaração contém um nome de campo do corpo da resposta e um valor que estão associados aos operadores eq ou ne, e as declarações podem ser combinadas usando e ou ou. Os valores de cadeia de caracteres devem estar entre aspas simples no parâmetro do filtro . Você pode especificar os seguintes campos do corpo da resposta:

  • applicationVersion
  • arquitetura
  • tipoDeBloco
  • Tipo de dispositivo
  • nome_do_arquivo
  • mercado
  • osLançamento
  • osVersão
  • Nome do produto
  • alvoOs
 Não
ordenar por corda Uma instrução que ordena os valores dos dados de resultado para cada bloco. A sintaxe é orderby=field [order],field [order],.... O parâmetro campo pode ser um dos seguintes itens do corpo da resposta:

  • applicationVersion
  • arquitetura
  • tipoDeBloco
  • data
  • Tipo de dispositivo
  • nome_do_arquivo
  • mercado
  • osLançamento
  • osVersão
  • Nome do produto
  • alvoOs
  • contadorDeDispositivos

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

Aqui está um exemplo orderby string: orderby=date,market

 Não
agrupar por corda Uma instrução que aplica a agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos do corpo da resposta:

  • applicationVersion
  • arquitetura
  • tipoDeBloco
  • Tipo de dispositivo
  • nome_do_arquivo
  • mercado
  • osLançamento
  • osVersão
  • alvoOs

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

  • applicationId
  • data
  • Nome do produto
  • contadorDeDispositivos

 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 da sua aplicação de desktop.

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 conjunto 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 corda Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você pode usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro superior da solicitação estiver definido como 10000, mas houver mais de 10000 linhas de dados de bloco para a consulta.
Contagem total Int O número total de linhas no resultado de dados para a consulta.

Os elementos na matriz Value contêm os seguintes valores.

Valor Tipo Descrição
applicationId corda O identificador do produto da aplicação de desktop para o qual você recuperou dados de bloco.
data corda A data associada ao bloco atinge o valor.
Nome do produto corda O nome de apresentação da aplicação de ambiente de trabalho tal como derivado dos metadados do(s) ficheiro(s) executável(eis) associado(s).
nome do ficheiro corda O executável que foi bloqueado.
versãoDaAplicação corda A versão do executável do aplicativo que foi bloqueada.
osVersão corda 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:

  • Janelas 7
  • Windows 8.1
  • Janelas 10
  • Janelas 11
  • Windows Server 2016
  • Windows Server 1709
  • Desconhecido
osLançamento do sistema operativo corda Uma das seguintes cadeias de caracteres que especifica a versão do sistema operativo ou anel de distribuição (como uma subpopulação dentro da versão do sistema operativo) na qual a aplicação de ambiente de trabalho está atualmente a ser executada.

Para Windows 11: Versão 2110

Para o Windows 10:

  • Versão 1507
  • Versão 1511
  • Versão 1607
  • Versão 1703
  • Versão 1709
  • Pré-visualização de Lançamento
  • Insider Rápido
  • Insider Lento

Para o Windows Server 1709:

  • RTM

Para o Windows Server 2016:

  • Versão 1607

Para Windows 8.1:

  • Atualização 1

Para o Windows 7:

  • Pacote de serviço 1

Se a versão do SO ou o anel de lançamento for desconhecido, este campo terá o valor Desconhecido.
mercado corda O código de país ISO 3166 do mercado em que a aplicação de ambiente de trabalho está bloqueada.
Tipo de dispositivo corda Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo no qual o aplicativo da área de trabalho está bloqueado:

  • Computador pessoal
  • Servidor
  • Comprimido
  • Desconhecido
Tipo de bloco corda Uma das seguintes cadeias de caracteres que especifica o tipo de bloco encontrado no dispositivo:

  • Sedimentos Potenciais
  • Sedimentos Temporários
  • Notificação de Tempo de Execução

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 corda A arquitetura do dispositivo no qual o bloco existe:

  • ARM64
  • X86
sistema operativo alvo corda 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á bloqueado de ser executado:

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

Exemplo de resposta

O exemplo a seguir demonstra um corpo de resposta JSON de exemplo 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
}
  • Last updated on