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 esta URI REST para obter dados de instalação agregados no formato JSON para um aplicativo da área de trabalho que você adicionou ao programa Aplicativo da Área de Trabalho do Windows. Esse URI permite que você obtenha dados de instalação durante um determinado intervalo de datas e outros filtros opcionais. Essas informações também estão disponíveis no relatório Instalações para aplicativos de desktop no Partner Center.
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/installbasedaily |
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 | A ID do produto do aplicativo da área de trabalho para o qual você deseja recuperar dados de instalação. 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 Instalações) e recupere a ID do produto da URL passando o mouse sobre o link para revelar os detalhes. | Sim |
| Data de Início | data | A data de início no intervalo de datas dos dados de instalação a serem recuperados. O padrão é 90 dias antes da data atual. | Não |
| data de término | data | A data de término no intervalo de datas dos dados de instalação 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 instalação. A sintaxe é orderby=field [order],field [order],.... O parâmetro do 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 obter dados de instalação do aplicativo 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/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&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 instalação 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 for definido como 10000, mas houver mais de 10.000 linhas de dados de instalação 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 |
|---|---|---|
| data | corda | A data associada ao valor base da instalação. |
| ID do aplicativo | corda | A ID do produto do aplicativo da área de trabalho para o qual você recuperou os dados de instalação. |
| nomeDoProduto | corda | O nome de exibição do aplicativo de desktop derivado dos metadados do(s) executável(is) associado(s). |
| versão do aplicativo | corda | A versão do executável do aplicativo que foi instalado. |
| 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á instalado:
|
| mercado | corda | O código de país ISO 3166 do mercado no qual o aplicativo da área de trabalho está instalado. |
| 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á instalado:
|
| 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á instalado. 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. |
| installBase | número | O número de dispositivos distintos que tinham o produto instalado 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": [
{
"date": "2018-01-24",
"applicationId": "123456789",
"productName": "Contoso Demo",
"applicationVersion": "1.0.0.0",
"deviceType": "PC",
"market": "All",
"osVersion": "Windows 10",
"osRelease": "Version 1709",
"installBase": 348218.0
}
],
"@nextLink": "desktop/installbasedaily?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
"TotalCount": 23012
}