Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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 desktop no Partner Center.
Para obter detalhes sobre blocos de dispositivo para um executável específico no seu aplicativo de desktop, veja Obter detalhes do bloco de atualização para o seu aplicativo de desktop.
Pré-requisitos
Para usar esse 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. Depois de obter um token de acesso, você terá 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 | URI de solicitação |
|---|---|
| OBTER | 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 |
|---|---|---|---|
| ID do aplicativo | corda | O ID do produto do aplicativo da área de trabalho para o qual você deseja recuperar dados de bloqueio. Para obter a identificação do produto de um aplicativo de desktop, abra qualquer relatório de análise para o seu aplicativo de desktop no Partner Center (como o relatório Blocos) e recupere a identificação do produto a partir da URL. | Sim |
| Data de Início | data | A data de início do intervalo de datas dos dados de bloco a serem recuperados. O padrão é 90 dias antes da data atual. | Não |
| data de término | data | A data de término do intervalo de datas dos dados de bloco a serem recuperados. O padrão é a data atual. | Não |
| Início | int | O número de linhas de dados a serem retornados na solicitação. O valor máximo e o valor padrão se não especificado for 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 esse 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 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 cadeia de caracteres devem ser cercados por aspas simples no parâmetro de filtro . Você pode especificar os seguintes campos do corpo da resposta:
|
Não |
| pedido por | corda | Uma instrução que ordena os valores de dados de resultado para cada bloco. A sintaxe é orderby=field [order],field [order],.... 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. Aqui está um exemplo de string orderby: orderby=date,market |
Não |
| groupby | 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:
As linhas de dados retornadas conterão os campos especificados no parâmetro groupby , bem como o seguinte:
|
Não |
Exemplo de solicitação
O exemplo a seguir demonstra várias solicitações para se obter dados de bloqueio de aplicativos da área de trabalho. Substitua o valor applicationId pela ID do produto para seu aplicativo 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 agregados de bloco. 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 for definido como 10000, mas houver mais de 10.000 linhas de dados de bloco para a consulta. |
| ContagemTotal | 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 |
|---|---|---|
| ID do aplicativo | corda | O ID do produto da aplicação de desktop para o qual você obteve dados de bloqueio. |
| data | corda | A data associada ao valor de hits do bloco. |
| nomeDoProduto | corda | O nome de exibição do aplicativo de desktop derivado dos metadados do(s) executável(is) associado(s). |
| nome do arquivo | corda | O executável que foi bloqueado. |
| versão do aplicativo | corda | A versão do executável do aplicativo que foi bloqueada. |
| osVersion | corda | 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:
|
| osRelease | corda | Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional ou o anel 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 Para Windows 10:
Para Windows Server 1709:
Para Windows Server 2016:
Para Windows 8.1:
Para Windows 7:
Se a versão do sistema operacional ou o anel de lançamento de software for desconhecido, este campo terá valor Desconhecido. |
| mercado | corda | O código de país ISO 3166 do mercado no qual o aplicativo de desktop está bloqueado. |
| 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:
|
| tipo de bloco | corda | Uma das seguintes cadeias de caracteres que especifica o tipo de bloco encontrado no dispositivo:
|
| arquitetura | corda | A arquitetura do dispositivo no qual o bloco existe:
|
| targetOs | 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á impedido de ser executado:
|
| quantidadeDeDispositivos | 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
}