Partilhar via

Obter conversões de aplicativos por canal

Use esse método na API de análise da Microsoft Store para obter conversões agregadas por canal para um aplicativo durante um determinado intervalo de datas e outros filtros opcionais.

  • Uma conversão significa que um cliente, ao iniciar sessão com uma conta da Microsoft, obteve recentemente uma licença para a sua aplicação (quer tenha cobrado dinheiro ou oferecido gratuitamente).
  • O canal é o método pelo qual um cliente chegou à página de listagem da sua aplicação (por exemplo, por meio da Loja ou de uma campanha de promoção personalizada de aplicações ).

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

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 Store do aplicativo para o qual você deseja recuperar dados de conversã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 conversão a serem recuperados. O padrão é 1/1/2016. Não
data de término data A data final no intervalo de datas dos dados de conversão a serem recuperados. O padrão é a data atual. Não
Início Int O número de linhas de dados a serem retornadas na solicitação. O valor máximo e o valor padrão, se não especificado, é 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um próximo link que você pode usar para solicitar a próxima página de dados. Não
pular Int O número de linhas a serem ignoradas na consulta. Use este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recupera as primeiras 10000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10000 linhas de dados e assim por diante. Não
filtro corda Uma ou mais declarações que filtram o corpo da resposta. Cada afirmação pode usar os operadores eq ou ne, e as afirmações podem ser combinadas usando e ou ou. Você pode especificar as seguintes cadeias de caracteres nas instruções de filtro. Para obter descrições, consulte a seção valores de conversão neste artigo.
  • nome_do_aplicativo
  • tipo de aplicação
  • customCampaignId
  • domínioDeReferênciaURI
  • tipoDeCanal
  • storeClient
  • Tipo de dispositivo
  • mercado

Aqui está um exemplo filtro parâmetro: filter=deviceType eq 'PC'.

 Não
Nível de Agregação corda Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: dia, semana ou mês. Se não for especificado, o padrão é dia. Não
ordenar por corda Uma instrução que ordena os valores dos dados de resultado para cada conversão. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes strings:
  • data
  • nome_do_aplicativo
  • tipo de aplicação
  • customCampaignId
  • domínioDeReferênciaURI
  • tipoDeCanal
  • storeClient
  • Tipo de dispositivo
  • mercado

O parâmetro order é opcional e pode ser asc ou desc para especificar a ordem crescente ou decrescente para cada campo. O padrão é asc.

Aqui está um exemplo orderby string: orderby=date,market

 Não
agrupar por corda Uma instrução que aplica a agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos:
  • data
  • nome_do_aplicativo
  • tipo de aplicação
  • customCampaignId
  • domínioDeReferênciaURI
  • tipoDeCanal
  • storeClient
  • Tipo de dispositivo
  • mercado

As linhas de dados retornadas conterão os campos especificados no parâmetro groupby , bem como o seguinte:

  • data
  • applicationId
  • contagemDeConversão
  • contagemDeCliques

O parâmetro groupby pode ser usado com o parâmetro aggregationLevel . Por exemplo: groupby=ageGroup,market&aggregationLevel=week

 Não

Exemplo de solicitação

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  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 conversão agregados para o aplicativo. Para obter mais informações sobre os dados em cada objeto, consulte a seção valores de conversão abaixo.
@nextLink corda Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você pode usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro superior da solicitação estiver definido como 10, mas houver mais de 10 linhas de dados de conversão para a consulta.
Contagem total Int O número total de linhas no resultado de dados para a consulta.

Valores de conversão

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

Valor Tipo Descrição
data corda A primeira data no intervalo de datas para os dados de conversão. Se a solicitação especificou um único dia, esse valor será essa data. Se a solicitação especificou uma semana, mês ou outro intervalo de datas, esse valor será a primeira data nesse intervalo de datas.
applicationId corda O ID da loja da aplicação para a qual estás a recuperar dados de conversão.
Nome da Aplicação corda O nome para exibição do aplicativo para o qual você está recuperando dados de conversão.
tipo de aplicação corda O tipo do produto para o qual você está recuperando dados de conversão. Para este método, o único valor suportado é App.
ID de Campanha Personalizada corda A sequência de ID para uma campanha de promoção de aplicação personalizada que está associada à aplicação.
referrerUriDomain corda Especifica o domínio onde a listagem de aplicativos com o ID da campanha de promoção de aplicativo personalizada foi ativada.
Tipo de canal corda Uma das seguintes cadeias de caracteres que especifica o canal para a conversão:
  • CustomCampaignId
  • Tráfego da loja
  • Outros
storeClient corda A versão da Loja onde ocorreu a conversão. Atualmente, o único valor suportado é SFC.
Tipo de dispositivo corda Uma das seguintes cadeias de caracteres:
  • Computador pessoal
  • Telefone
  • Console-Xbox Um
  • Console-Xbox Série X
  • Internet das coisas
  • Holográfico
  • Desconhecido
mercado corda O código de país ISO 3166 do mercado onde ocorreu a conversão.
contagemDeCliques número O número de cliques de clientes no link da listagem da sua aplicação.
contagemDeConversões número O número de conversões de clientes.

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/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/23/2022&endDate=07/21/2022&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Exemplo de resposta

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 3089,
            "conversionCount": 14
        }
    ],
    "@nextLink": "",
    "TotalCount": 1
}

Pedido de amostra

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/21/2022&skip=0&groupby=date,applicationName,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market&filter=market eq 'US'
HTTP/1.1
Authorization: Bearer <your access token>

Exemplo de resposta

{
    "Value": [
        {
            "date": "2022-06-19",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 13,
            "conversionCount": 0
        },
        {
            "date": "2022-06-20",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 6,
            "conversionCount": 0
        },
        {
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "",
            "referrerUriDomain": "Universal Client Store",
            "channelType": "Store Traffic",
            "storeClient": "SFC",
            "deviceType": "PC",
            "market": "US",
            "clickCount": 4,
            "conversionCount": 0
        },
    ],
    "@nextLink": "",
    "TotalCount": 4
}
  • Last updated on