Compartilhar via


Obtenha dados de insights para seu aplicativo desktop

Use este método na API de análise da Microsoft Store para obter dados analíticos relacionados às métricas de saúde de um aplicativo de desktop que você adicionou ao programa Aplicativos de Desktop do Windows. Esses dados também estão disponíveis no relatório Health para aplicativos 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/insights

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 do produto do aplicativo desktop para o qual você deseja obter dados de insights. Para obter a identificação do produto de um aplicativo da área de trabalho, abra qualquer relatório de análise de para seu aplicativo da área de trabalho no Partner Center (como o relatório Health) e recupere a identificação do produto da 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
Data de Início data A data de início dentro do intervalo de datas dos dados de insights que devem ser recuperados. O padrão é 30 dias antes da data atual. Não
data de término data A data de término no intervalo de datas dos dados de insights a serem obtidos. O padrão é a data atual. 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 . Por exemplo, filter=dataType eq 'acquisition'.

Atualmente, esse método dá suporte apenas ao filtro de saúde.

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 Tipo Descrição
Valor conjunto 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 de Insight abaixo.
ContagemTotal int O número total de linhas no resultado dos dados da consulta.

Valores de percepção

Os elementos na matriz Value contêm os valores a seguir.

Valor Tipo Descrição
ID do aplicativo corda A ID do produto do aplicativo da área de trabalho para o qual você recuperou dados de insights.
Data de insight corda A data em que identificamos a alteração em uma métrica específica. Essa data representa o final da semana em que detectamos um aumento ou redução significativo em uma métrica em comparação com a semana anterior.
Datatype corda Uma cadeia de caracteres que especifica a área de análise geral que esse insight informa. Atualmente, este método só dá suporte a saúde.
insightDetalhe conjunto Um ou mais valores InsightDetail que representam os detalhes do insight atual.

Valores de InsightDetail

Valor Tipo Descrição
Nome do Fato corda Uma cadeia de caracteres que indica a métrica que o insight atual ou a dimensão atual descreve. Atualmente, esse método dá suporte apenas ao valor HitCount.
SubDimensões conjunto Um ou mais objetos que descrevem uma única métrica para uma análise.
Variação Percentual corda A porcentagem que a métrica alterou em toda a sua base de clientes.
Nome da Dimensão corda O nome da métrica descrita na dimensão atual. Os exemplos incluem EventType, Market, DeviceType e PackageVersion.
ValorDimensão corda O valor da métrica descrita na dimensão atual. Por exemplo, se DimensionName for EventType, DimensionValue poderá ser crash ou hang.
Valor de fato corda O valor absoluto da métrica na data em que o insight foi detectado.
Direção corda A direção da alteração ( positiva ou negativa).
Data (calendário) corda A data em que identificamos a alteração 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
}