Compartilhar via

Obtenha 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, 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/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
ID do aplicativo corda O ID da loja Store do aplicativo para o qual você deseja obter 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 de funil de aquisição a serem recuperados. O padrão é a data atual. Não
data de término data A data de término no intervalo de datas dos dados de 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 de filtro 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 que estão associados aos operadores eq ou ne, e as instruções podem ser combinadas usando e ou ou.

Há suporte para os campos de filtro a seguir. Os valores de cadeia de caracteres devem ser cercados por aspas simples no parâmetro de 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 em que 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
  • Telefone
  • Console-Xbox Um
  • SérieConsole-Xbox X
  • Muito
  • Holográfico
  • Desconhecido
faixa etária Uma das seguintes cadeias de caracteres que especifica a faixa etária do usuário que concluiu a aquisição:
  • 0 a 17
  • 18 – 24
  • 25 – 34
  • 35 a 49
  • 50 ou mais de
  • Desconhecido
Gênero Uma das seguintes cadeias de caracteres 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 para obter dados de funil de aquisição para um aplicativo. Substitua o valor applicationId pelo Store ID do 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 Tipo Descrição
Valor conjunto 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 valores de funil abaixo.
ContagemTotal 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 Tipo Descrição
Tipo de Métrica corda Uma das seguintes cadeias de caracteres que especifica o tipo de dados de funil incluídos neste objeto:
  • ExibiçãoDePágina
  • Aquisição de
  • Instalar
  • Uso
ContagemDeUsuarios corda O número de usuários que executaram a etapa de funil especificada pelo valor de 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>

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
}
  • Last updated on