Obter dados de insights do seu aplicativo da área de trabalho
Use esse método na API de análise da Microsoft Store para obter dados de insights relacionados às métricas de integridade de um aplicativo da área de trabalho que você adicionou ao programa Aplicativo da Área de Trabalho do Windows. Esses dados também estão disponíveis no relatório de integridade para aplicativos da área de trabalho no Partner Center.
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/desktop/insights |
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 do produto do aplicativo da área de trabalho para o qual você deseja obter dados de insights. Para obter o ID do produto (product ID) de um aplicativo da área de trabalho, abra um relatório de análise para o aplicativo da área de trabalho na Central de Parceiros (como o relatório de integridade) e recupere o ID do produto (product ID) na URL. Se você não especificar esse parâmetro, o corpo da resposta conterá dados de insights para todos os aplicativos registrados em sua conta. | Não |
| startDate | date | A data de início no intervalo de datas dos dados do insights a serem recuperados. O padrão é 30 dias antes da data atual. | Não |
| endDate | date | A data de término no intervalo de datas dos dados do insights a serem recuperados. O padrão é a data atual. | 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. Por exemplo, filter=dataType eq 'acquisition'. Atualmente, esse método dá suporte apenas à integridade do filtro. |
Não |
Exemplo de solicitação
O exemplo a seguir demonstra uma solicitação para obter dados de insights. Substitua o valor applicationId pelo valor apropriado para seu aplicativo da área de trabalho.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/insights?applicationId=10238467886765136388&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'health' 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 insights para o aplicativo. Para obter mais informações sobre os dados em cada objeto, consulte a seção Valores do Insight abaixo. |
| TotalCount | int | O número total de linhas no resultado de dados da consulta. |
Valores do Insight
Os elementos na matriz Value contêm os valores a seguir.
| Valor | Type | Descrição |
|---|---|---|
| applicationId | string | O ID do produto do aplicativo da área de trabalho para o qual você recuperou dados de insights. |
| Data de insight | string | A data em que identificamos a mudança em uma métrica específica. Essa data representa o final da semana em que detectamos um aumento ou diminuição significativa em uma métrica em comparação com a semana anterior. |
| dataType | string | Uma cadeia de caracteres que especifica a área de análise geral informada por esse insight. Atualmente, esse método só dá suporte à integridade. |
| insightDetalhe | matriz | Um ou mais valores InsightDetail que representam os detalhes do insight atual. |
Valores InsightDetail
| Valor | Type | Descrição |
|---|---|---|
| Nome do Fato | string | Uma string que indica a métrica que o insight atual ou a dimensão atual descreve. Atualmente, esse método só dá suporte ao valor HitCount. |
| Subdimensões | matriz | Um ou mais objetos que descrevem uma única métrica para o insight. |
| Variação percentual | string | A porcentagem em que a métrica mudou em toda a sua base de clientes. |
| DimensionName | string | O nome da métrica descrita na dimensão atual. Os exemplos incluem EventType, Market, DeviceType e PackageVersion. |
| DimensionValue | string | O valor da métrica descrita na dimensão atual. Por exemplo, se DimensionName for EventType, DimensionValue poderá falhar ou travar. |
| Valor de fato | string | O valor absoluto da métrica na data em que o insight foi detectado. |
| Direção | string | A direção da mudança (Positiva ou Negativa). |
| Data | string | A data em que identificamos a mudança relacionada ao insight atual ou à dimensão atual. |
Exemplo de resposta
Veja a seguir um exemplo de corpo de resposta JSON para essa solicitação.
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"insightDate": "2018-06-03T00:00:00",
"dataType": "health",
"insightDetail": [
{
"FactName": "HitCount",
"SubDimensions": [
{
"FactName:": "HitCount",
"PercentChange": "21",
"DimensionValue:": "DE",
"FactValue": "109",
"Direction": "Positive",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "Market"
}
],
"DimensionValue": "crash",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "EventType"
},
{
"FactName": "HitCount",
"SubDimensions": [
{
"FactName:": "HitCount",
"PercentChange": "71",
"DimensionValue:": "JP",
"FactValue": "112",
"Direction": "Positive",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "Market"
}
],
"DimensionValue": "hang",
"Date": "6/3/2018 12:00:00 AM",
"DimensionName": "EventType"
},
],
"insightId": "9CY0F3VBT1AS942AFQaeyO0k2zUKfyOhrOHc0036Iwc="
}
],
"@nextLink": null,
"TotalCount": 2
}