Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Use esse método na API de análise da Microsoft Store para obter dados de uso agregados (não incluindo o Xbox multiplayer) no formato JSON para um aplicativo durante um determinado intervalo de datas (somente nos últimos 90 dias) e outros filtros opcionais. Essas informações também estão disponíveis no Relatório de uso no Partner Center.
A telemetria para aplicativos PWA baseados em Anaheim é coletada no nível do dispositivo. Portanto, as métricas relacionadas aos usuários não estarão disponíveis para esses produtos. Consulte a seção Valores de uso abaixo para obter mais detalhes sobre a validade dos campos.
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/usagedaily |
Cabeçalho da solicitação
Cabeçalho | Tipo | Descrição |
---|---|---|
Autorização | cordão | 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 | cordão | O ID da Loja da aplicação para a qual pretende recuperar informações sobre avaliações. | Sim |
data de início | data | A data de início no intervalo de datas dos dados de revisão a serem recuperados. O padrão é a data atual. | Não |
data de término | data | A data final no intervalo de datas dos dados de revisão 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 | cordão | 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 que estão associados aos operadores eq ou ne, e as instruções podem ser combinadas usando "e" ou "ou". Os valores de cadeia de caracteres devem ser cercados por aspas simples no parâmetro filter. Você pode especificar os seguintes campos do corpo da resposta:
|
Não |
ordenar por | cordão | Uma instrução que ordena os valores de dados resultantes. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes strings:
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 | cordão | 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:
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 uma solicitação para obter dados de uso diário do aplicativo. Substitua o valor applicationId pela ID da Loja do seu aplicativo.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagedaily?applicationId=XXXXXXXXXXXX&startDate=2018-08-10&endDate=2018-08-14 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 uso agregados. Para obter mais informações sobre os dados em cada objeto, consulte a tabela a seguir. |
@nextLink | cordão | 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 revisões para a consulta. |
Contagem total | Int | O número total de linhas no resultado de dados para a consulta. |
Valores de utilização
Os elementos na matriz Value contêm os seguintes valores.
Valor | Tipo | Descrição | Disponibilidade da UWP | Disponibilidade do PWA sediado em Anaheim | Disponibilidade do Xbox |
---|---|---|---|---|---|
data | cordão | A primeira data do intervalo de datas dos dados de utilização. Se a solicitação especificou um único dia, esse valor será essa data. Se a solicitação especificou uma semana, mês ou outro intervalo de datas, esse valor será a primeira data nesse intervalo de datas. | Sim | Sim | Sim |
applicationId | cordão | O ID da loja da aplicação para a qual está a recuperar dados de utilização. | Sim | Sim | Sim |
Nome da Aplicação | cordão | O nome de exibição da aplicação. | Sim | Sim | Sim |
Tipo de dispositivo | cordão | Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo onde o uso ocorreu:
|
Sim | Sim | Sim |
Versão do pacote | cordão | A versão do pacote onde ocorreu o uso. | Sim | Sim | Não |
mercado | cordão | O código de país ISO 3166 do mercado onde o cliente usou seu aplicativo. | Sim | Sim | Sim |
nome da subscrição | cordão | Indica se o uso foi por meio do Xbox Game Pass. | Sim | Não | Não |
contagemDiáriaDeSessões | longo | O número de sessões de usuários nesse dia. | Sim | Sim | Sim |
engajamentoDuraçãoMinutos | duplo | Os minutos em que os usuários estão usando ativamente seu aplicativo medidos por um período de tempo distinto, começando quando o aplicativo é iniciado (início do processo) e terminando quando ele termina (fim do processo) ou após um período de inatividade. | Sim | Sim | Sim |
utilizadores ativos diários | longo | O número de clientes que usaram o aplicativo naquele dia. | Sim | Não | Sim |
dailyActiveDevices | longo | O número de dispositivos diários usados para interagir com seu aplicativo por todos os usuários. | Sim | Sim | Sim |
utilizadoresNovosDiários | longo | O número de clientes que usaram seu aplicativo pela primeira vez naquele dia. | Sim | Não | Sim |
utilizadoresAtivosMensais | longo | O número de clientes que usam o aplicativo naquele mês. | Sim | Não | Sim |
dispositivosAtivosMensalmente | longo | O número de dispositivos que executam seu aplicativo por um período de tempo distinto, começando quando o aplicativo é iniciado (início do processo) e terminando quando ele termina (término do processo) ou após um período de inatividade. | Sim | Sim | Sim |
Novos Utilizadores Mensais | longo | O número de clientes que usaram seu aplicativo pela primeira vez naquele mês. | Sim | Não | Sim |
dispositivosNovosDiários | longo | O número de dispositivos que usaram o aplicativo pela primeira vez naquele dia. | Não | Sim | Não |
dispositivosNovosMensalmente | longo | O número de dispositivos que usaram o aplicativo pela primeira vez nos últimos 30 dias. | Não | Sim | Não |
Observação
Se um campo não for válido para um produto específico, o valor para esses campos será enviado como 0 ou nulo na resposta. O cálculo de novos usuários e novos dispositivos é feito com a janela contínua de 3 anos, ou seja, se um usuário/dispositivo não usar o aplicativo por 3 anos ou mais, ele será tratado como novo usuário/dispositivo após 3 anos.
Exemplo de solicitação e resposta
Os trechos de código a seguir demonstram alguns exemplos de solicitação e corpo de resposta JSON para essas solicitações.
Pedido de amostra
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagedaily?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
Exemplo de resposta
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"deviceType": "All",
"packageVersion": "All",
"market": "All",
"dailySessionCount": 6102,
"engagementDurationMinutes": 75801.0,
"dailyActiveUsers": 3866,
"dailyActiveDevices": 3855,
"dailyNewUsers": 2041,
"monthlyActiveUsers": 85206,
"monthlyActiveDevices": 88995,
"monthlyNewUsers": 63184,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
}
],
"TotalCount": 1
}
Pedido de amostra
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/usagedaily?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date
HTTP/1.1
Authorization: Bearer <your access token>
Exemplo de resposta
{
"Value": [
{
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "1.4.0.17837",
"market": "BR",
"dailySessionCount": 1,
"engagementDurationMinutes": 35.2,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 1,
"monthlyActiveDevices": 1,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-07-04",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AD",
"dailySessionCount": 1,
"engagementDurationMinutes": 2.7,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 1,
"monthlyActiveDevices": 1,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-24",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AE",
"dailySessionCount": 2,
"engagementDurationMinutes": 2.9,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 2,
"monthlyActiveDevices": 2,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-07-08",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AE",
"dailySessionCount": 1,
"engagementDurationMinutes": 0.5,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 2,
"monthlyActiveDevices": 2,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-26",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AO",
"dailySessionCount": 1,
"engagementDurationMinutes": 1.2,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 1,
"monthlyActiveDevices": 1,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-19",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AR",
"dailySessionCount": 1,
"engagementDurationMinutes": 1.0,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 40,
"monthlyActiveDevices": 40,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-20",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AR",
"dailySessionCount": 2,
"engagementDurationMinutes": 10.9,
"dailyActiveUsers": 2,
"dailyActiveDevices": 2,
"dailyNewUsers": 0,
"monthlyActiveUsers": 42,
"monthlyActiveDevices": 42,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-21",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AR",
"dailySessionCount": 6,
"engagementDurationMinutes": 32.8,
"dailyActiveUsers": 3,
"dailyActiveDevices": 3,
"dailyNewUsers": 0,
"monthlyActiveUsers": 44,
"monthlyActiveDevices": 43,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AR",
"dailySessionCount": 1,
"engagementDurationMinutes": 0.1,
"dailyActiveUsers": 1,
"dailyActiveDevices": 1,
"dailyNewUsers": 0,
"monthlyActiveUsers": 43,
"monthlyActiveDevices": 42,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
},
{
"date": "2022-06-23",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"subscriptionName": "null",
"deviceType": "PC",
"packageVersion": "2.5.2.34894",
"market": "AR",
"dailySessionCount": 2,
"engagementDurationMinutes": 0.3,
"dailyActiveUsers": 2,
"dailyActiveDevices": 2,
"dailyNewUsers": 0,
"monthlyActiveUsers": 42,
"monthlyActiveDevices": 42,
"monthlyNewUsers": 0,
"dailyNewDevices": 0,
"monthlyNewDevices": 0
}
],
"@nextLink": "usagedaily?applicationId=9NBLGGGZ5QDR&startDate=2022/06/19&endDate=2022/07/21&groupby=applicationName,subscriptionName,deviceType,packageVersion,market,date&top=10&skip=10",
"TotalCount": 765
}