Compartilhar via

Obter instalações do aplicativo

  • Artigo

Use esse método na API de análise da Microsoft Store para obter dados de instalação agregados em formato JSON para um aplicativo durante um determinado intervalo de datas e outros filtros opcionais. Essas informações também estão disponíveis no Relatório de aquisições na Central de Parceiros.

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/installs

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 da Store do aplicativo cujos dados de instalação você deseja recuperar. Sim
startDate date A data de início no intervalo de datas dos dados de instalação a serem recuperados. O padrão é a data atual. Não
endDate date 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
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:

  • market
  • osVersion
  • deviceType
  • packageVersion
 Não
aggregationLevel string Especifica o intervalo de tempo cujos dados agregados serão recuperados. Pode ser uma das seguintes sequências: dia, semana ou mês. Se não for especificado, o padrão será dia. Não
orderby string Uma instrução que ordena os valores dos dados de resultado para cada instalação. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser um dos seguintes campos do corpo da resposta:

  • applicationName
  • date
  • deviceType
  • market
  • osVersion
  • packageVersion
  • successfulInstallCount

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:

  • applicationName
  • date
  • deviceType
  • market
  • osVersion
  • packageVersion

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

  • date
  • applicationId
  • successfulInstallCount

O parâmetro groupby pode ser usado com o parâmetro aggregationLevel. Por exemplo: &groupby=ageGroup,market&aggregationLevel=week

 Não

 

Exemplo de solicitação

O exemplo a seguir demonstra várias solicitações para a obtenção de dados de instalação de aplicativos. Substitua o valor applicationId pela ID da Store para seu aplicativo.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&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 instalação 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 se existirem mais de 10000 linhas de dados de instalação 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
date string A primeira data no intervalo de datas para os dados de instalação. Se a solicitação tiver especificado um único dia, esse valor será essa data. Se a solicitação tiver especificado uma semana, um mês ou outro intervalo de datas, esse valor será a primeira data nesse intervalo de datas.
applicationId string O ID da Store do aplicativo para o qual você está recuperando os dados de instalação.
applicationName string O nome de exibição do aplicativo.
deviceType string Uma das seguintes sequências que especifica o tipo de dispositivo que concluiu a instalação:

  • Computador
  • Telefone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holográfico
  • Desconhecido
packageVersion string A versão do pacote que foi instalada.
osVersion string Uma das seguintes sequências que especifica a versão do SO em que a instalação ocorreu:

  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Desconhecido
market string O código de país ISO 3166 do mercado no qual a instalação ocorreu.
successfulInstallCount número O número de instalações bem-sucedidas que ocorreram durante o nível de agregação especificado.

Exemplo de solicitação e resposta

Os snippets de código a seguir demonstram alguns exemplos de solicitações e o corpo da resposta JSON para estas solicitações.

Solicitação de Exemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9WZDNCRFJB4P
HTTP/1.1
Authorization: Bearer <your access token>

Resposta de exemplo

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "successfulInstallCount": 100053
        }
    ],
    "TotalCount": 1
}

Solicitação de Exemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=06/19/2022&endDate=07/21/2022&top=10&skip=0&groupby=applicationName,date,deviceType,market,osVersion,packageVersion&orderby=date desc
HTTP/1.1
Authorization: Bearer <your access token>

Resposta de exemplo

{
    "Value": [
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "AU",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BD",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BG",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BO",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 10",
            "successfulInstallCount": 6
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "BR",
            "osVersion": "Windows 11",
            "successfulInstallCount": 3
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CA",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "CN",
            "osVersion": "Windows 11",
            "successfulInstallCount": 1
        },
        {
            "date": "2022-07-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "packageVersion": "2013.1206.10.2936",
            "deviceType": "PC",
            "market": "MX",
            "osVersion": "Windows 10",
            "successfulInstallCount": 1
        }
    ],
    "TotalCount": 10
}