Partilhar via

Obter conversões de aplicativo por canal

  • Artigo

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 (conectado a uma conta da Microsoft) obteve recentemente uma licença para o seu aplicativo (independentemente de você ter cobrado ou oferecido gratuitamente).
  • O canal é o método pelo qual um cliente chegou à sua página de lista de aplicativos (por exemplo, por meio da Store ou de uma campanha de promoção de aplicativos personalizados).

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

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 A ID da Store do aplicativo cujos dados de conversão você deseja recuperar. Um exemplo de ID da Store é 9WZDNCRFJ3Q8. Sim
startDate date 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
endDate date A data de término no intervalo de datas dos dados de conversão a serem recuperados. O padrão é a data atual. Não
top int O número de linhas de dados a serem retornadas na solicitação. O valor máximo e padrão, se não for especificado, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um proximo link que você poderá usar para solicitar a próxima página de dados. Não
skip int O número de linhas a serem ignoradas na consulta. Use esse parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recupera as primeiras 10.000 mil linhas de dados, top=10000 e skip=10000 recupera as próximas dez mil linhas de dados, e assim por diante. Não
filtro string Uma ou mais instruções que filtram o corpo da resposta. Cada instrução pode usar os operadores eq ou ne e as instruções podem ser combinadas usando and ou or. Você pode especificar as sequências a seguir nas instruções do filtro. Para obter descrições, consulte a seção valores de conversão neste artigo.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

Este é um exemplo de parâmetro filter: filter=deviceType eq 'PC'.

 Não
aggregationLevel string Especifica o intervalo de tempo cujos dados agregados serão recuperados. Pode ser uma das seguintes sequências: dia, semana ou mês. Se não for especificado, o padrão será dia. Não
orderby string 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 sequências:
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

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

Este é um exemplo de sequência orderby: orderby=date,market

 Não
groupby string Uma instrução que aplica agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos:
  • date
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

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

  • date
  • applicationId
  • conversionCount
  • clickCount

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 a obtenção de dados de conversão de aplicativos. Substitua o valor applicationId pela ID da Store para seu aplicativo.

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 Type Descrição
Valor matriz 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 string Se houver páginas adicionais de dados, essa sequência conterá um URI que você poderá usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro top da solicitação estiver definido como 10, mas se existirem mais de 10 linhas de dados de classificações para a consulta.
TotalCount int O número total de linhas no resultado de dados da consulta.

Valores de conversão

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

Valor Type Descrição
date string A primeira data no intervalo de datas para os dados de conversão. Se a solicitação tiver especificado um único dia, esse valor será essa data. Se a solicitação tiver especificado uma semana, um mês ou outro intervalo de datas, esse valor será a primeira data nesse intervalo de datas.
applicationId string O ID da Store do aplicativo para o qual você está recuperando os dados de conversão.
applicationName string O nome de exibição do aplicativo para o qual você está recuperando os dados de conversão.
appType string O tipo do produto para o qual você está recuperando os dados de conversão. Para este método, o único valor com suporte é App.
customCampaignId string A sequência de ID de uma campanha de promoção de aplicativo personalizada associada ao aplicativo.
referrerUriDomain string Especifica o domínio em que a lista de aplicativos com o ID da campanha de promoção de aplicativo personalizada foi ativada.
channelType string Uma das seguintes sequências que especifica o canal para a conversão:
  • CustomCampaignId
  • Store Traffic
  • Outras
storeClient string A versão da Store em que ocorreu a conversão. Atualmente, o único valor aceito é SFC.
deviceType string Uma das cadeias de caracteres a seguir:
  • Computador
  • Telefone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holográfico
  • Desconhecido
market string O código de país ISO 3166 do mercado no qual a conversão ocorreu.
clickCount número O número de cliques do cliente no link da lista do seu aplicativo.
conversionCount número O número de conversões de clientes.

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

Resposta de exemplo

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

Solicitação de Exemplo

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>

Resposta de exemplo

{
    "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
}