Obter dados de funil de aquisição do aplicativo

Use este método na API de análise da Microsoft Store para obter os dados de funil de aquisição de 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 este método, primeiro você precisa do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a 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 este 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.

Solicitação

Sintaxe da solicitação

Método URI da solicitação
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< de formulário.

Parâmetros da solicitação

Parâmetro Type Descrição Obrigatório
applicationId string A ID da Loja do aplicativo para o qual você deseja recuperar dados de funil de aquisição. Uma ID da Store de exemplo é 9WZDNCRFJ3Q8. Sim
startDate date A data de início no intervalo de datas de dados de funil de aquisição a serem recuperados. O padrão é a data atual. Não
endDate date A data final no intervalo de datas de dados de funil de aquisição a serem recuperados. O padrão é a data atual. Não
filter string Uma ou mais instruções que filtram as linhas na resposta. Para saber mais, consulte a seção campos de filtro a seguir. Não

 

Campos de filtro

O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas da resposta. Cada instrução contém um campo e um valor que estão associados aos operadores eq ou ne, e as instruções podem ser combinadas usando-se and ou or.

Há suporte para os campos de filtro a seguir. Os valores de sequência devem estar entre aspas simples no parâmetro filter.

Campos Descrição
campaignId A cadeia de caracteres de ID para uma campanha de promoção de apps personalizados associada à aquisição.
market Uma cadeia de caracteres que contém o código de país ISO 3166 do mercado onde ocorreu a aquisição.
deviceType Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo no qual ocorreu a aquisição:
  • PC
  • Telefone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Desconhecido
ageGroup Uma das cadeias de caracteres a seguir que especifica a faixa etária do usuário que concluiu a aquisição:
  • 0 a 17
  • 18 a 24
  • 25 a 34
  • 35 a 49
  • 50 ou mais
  • Desconhecido
gender Uma das cadeias de caracteres a seguir que especifica o gênero do usuário que concluiu a aquisição:
  • M
  • F
  • Desconhecido

Exemplo de solicitação

O exemplo a seguir demonstra várias solicitações de obtenção de dados de funil de aquisição para um app. Substitua o valor de applicationId pela ID da Store de seu app.

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Resposta

Corpo da resposta

Valor Type Descrição
Valor array Uma matriz de objetos que contém dados de funil de aquisição para o app. Para saber mais sobre os dados em cada objeto, consulte a seção de valores de funil abaixo.
TotalCount INT O número total de objetos da matriz Valor.

Valores de funil

Os objetos na matriz Valor contêm os valores a seguir.

Valor Type Descrição
MetricType string Uma das cadeias de caracteres a seguir que especifica o tipo de dados de funil incluído nesse objeto:
  • PageView
  • Aquisição
  • Instalar
  • Usage
UserCount string O número de usuários que executou a etapa de funil especificada pelo valor MetricType.

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/funnel?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Exemplo de Resposta

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 1502
        },
        {
            "MetricType": "Usage",
            "UserCount": 606
        },
        {
            "MetricType": "Install",
            "UserCount": 977
        }
    ],
    "TotalCount": 4
}

Solicitação de Exemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/21/2021&filter=market eq 'US' and gender eq 'm'
HTTP/1.1
Authorization: Bearer <your access token>

Exemplo de Resposta

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 10
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}