Partilhar via

Obter dados do funil de aquisição de aplicativos

Use esse método na API de análise da Microsoft Store para obter dados de funil de aquisição 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, 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/funnel

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
applicationId corda O ID da loja da aplicação para a qual pretender recuperar dados do funil de aquisição. Um exemplo de ID de loja é 9WZDNCRFJ3Q8. Sim
data de início data A data de início no intervalo de datas dos dados do funil de aquisiçã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 do funil de aquisição a serem recuperados. O padrão é a data atual. Não
filtro corda Uma ou mais declarações que filtram as linhas da resposta. Para obter mais informações, consulte a seção de campos de filtro abaixo. Não

 

Filtrar campos

O parâmetro do filtro da solicitação contém uma ou mais declarações que filtram as linhas na 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 e ou ou.

Os seguintes campos de filtro são suportados. Os valores de cadeia de caracteres devem estar entre aspas simples no parâmetro do filtro .

Campos Descrição
ID de campanha A cadeia de caracteres de ID de uma campanha de promoção de aplicativo personalizada associada à aquisição.
mercado Uma cadeia de caracteres que contém o código de país ISO 3166 do mercado onde a aquisição ocorreu.
Tipo de dispositivo Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo no qual a aquisição ocorreu:
  • Computador pessoal
  • Telefone
  • Console-Xbox Um
  • Console-Xbox Série X
  • Internet das coisas
  • Holográfico
  • Desconhecido
grupo etário Uma das seguintes cadeias de caracteres que especifica a faixa etária do usuário que concluiu a aquisição:
  • 0 – 17
  • 18 – 24
  • 25 – 34
  • 35 – 49
  • 50 anos ou mais
  • Desconhecido
Género Uma das seguintes cadeias de caracteres que especifica o sexo do usuário que concluiu a aquisição:
  • M
  • F
  • Desconhecido

Exemplo de solicitação

O exemplo a seguir demonstra várias solicitações para obter dados de funil de aquisição para um aplicativo. Substitua o valor applicationId pelo Store ID da sua aplicação.

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 Tipo Descrição
Valor conjunto Uma matriz de objetos que contêm dados de funil de aquisição para a aplicação. Para obter mais informações sobre os dados em cada objeto, consulte a seção valores do funil abaixo.
Contagem total Int O número total de objetos na matriz Value .

Valores do funil

Os objetos na matriz Value contêm os seguintes valores.

Valor Tipo Descrição
Tipo de Métrica corda Uma das seguintes cadeias de caracteres que especificam o tipo de dados de funil incluído neste objeto:
  • VisãoDePágina
  • Aquisição
  • Instalar
  • Utilização
Contagem de usuários corda O número de usuários que executaram a etapa do funil especificada pelo valor MetricType .

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

Exemplo de resposta

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

Pedido de amostra

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": "Acquisition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}
  • Last updated on