Compartilhar via

Obter dados de funil de aquisição do aplicativo

  • Artigo

Use esse método na API de análise da Microsoft Store para obter dados do 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 de aquisições na Central de Parceiros.

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/funnel

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 O ID da loja do aplicativo para o qual você deseja recuperar os dados do funil de aquisição. Um exemplo de ID da Store é 9WZDNCRFJ3Q8. Sim
startDate date 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
endDate date A data de término no intervalo de datas dos dados do funil de aquisição a serem recuperados. O padrão é a data atual. Não
filtro string Uma ou mais instruções que filtram as linhas na resposta. Para obter mais informações, consulte a seção sobre campos de filtro abaixo. Não

 

Filtrar campos

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

Os campos de filtro a seguir são suportados. Os valores de sequência devem estar entre aspas simples no parâmetro filter.

Campos Descrição
campaignId A string de ID de uma campanha de promoção de aplicativo personalizada associada à aquisição.
market Uma sequência que contém o código do país ISO 3166 do mercado no qual a aquisição ocorreu.
deviceType Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo no qual a aquisição ocorreu:
  • Computador
  • Telefone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holográfico
  • Desconhecido
ageGroup 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 ou mais
  • Desconhecido
gender 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 do funil de aquisição de um aplicativo. Substitua o valor applicationId pela ID da Store para seu aplicativo.

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

Valores de funil

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

Valor Type Descrição
Tipo de métrica string Uma das seguintes cadeias de caracteres que especifica o tipo de dados de funil incluídos neste objeto:
  • Visualização de página
  • Aquisição
  • Instalar
  • Uso
Contagem de usuários string O número de usuários que executaram a etapa do funil especificada pelo valor MetricType .

Exemplo de solicitação e resposta

Os snippets de código a seguir demonstram alguns exemplos de solicitações e o corpo da resposta JSON para estas 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>

Resposta de exemplo

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acquisition",
            "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>

Resposta de exemplo

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