Compartilhar via

Obter instalações de aplicativo

Use esse método na API de análise da Microsoft Store para obter dados de instalação agregados no 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 Aquisições 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/installs

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 da Store do aplicativo para o qual você deseja recuperar dados de instalação. 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 é a 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:

  • mercado
  • OSVersion
  • tipoDeDispositivo
  • Versão do pacote
 Não
nível de agregação corda Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: dia, semana ou mês. Se não for especificado, o padrão será dia. 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:

  • nome_do_aplicativo
  • data
  • tipoDeDispositivo
  • mercado
  • OSVersion
  • Versão do pacote
  • contagemDeInstalaçõesBemSucedidas

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:

  • nome_do_aplicativo
  • data
  • tipoDeDispositivo
  • mercado
  • OSVersion
  • Versão do pacote

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

  • data
  • ID do aplicativo
  • contagemDeInstalaçõesBemSucedidas

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 obter dados de instalação do aplicativo. Substitua o valor applicationId pelo Store ID do 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 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 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 especificou uma semana, um mês ou outro intervalo de datas, este valor é a primeira data nesse intervalo.
ID do aplicativo corda O ID da loja do aplicativo para o qual você está recuperando dados de instalação.
Nome do aplicativo corda O nome de exibição do aplicativo.
tipo de dispositivo corda Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo que concluiu a instalação:

  • Computador
  • Telefone
  • Console-Xbox Um
  • SérieConsole-Xbox X
  • Muito
  • Holográfico
  • Desconhecido
versão do pacote corda A versão do pacote que foi instalado.
osVersion corda Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional na qual a instalação ocorreu:

  • Windows Phone 7.5
  • Telefone Windows 8
  • Windows Phone 8.1
  • Telefone Windows 10
  • janelas 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Desconhecido
mercado corda O código do país ISO 3166 do mercado em que a instalação ocorreu.
contagemDeInstalaçõesBemSucedidas 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ção e corpo de resposta JSON para essas 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
}
  • Last updated on