Partilhar via

Obter dados de aquisições para os seus jogos e aplicações

Use esse método na API de análise da Microsoft Store para obter dados de aquisição agregados no formato JSON para aplicativos UWP e jogos do Xbox One que foram ingeridos por meio do Xbox Developer Portal (XDP) e disponíveis no painel do XDP Analytics.

Observação

Esta API não fornece dados agregados diários antes de 1 de outubro de 2016.

Pré-requisitos

Para usar esse método, você precisa primeiro fazer o seguinte:

  • Se ainda não tiver feito isso, complete todos os pré-requisitos e 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/acquisitions

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 A identificação do produto do jogo Xbox One para o qual estás a recuperar dados de aquisição. Para obter o ID do produto do seu jogo, navegue para o seu jogo no Programa de Análise XDP e obtenha o ID do produto do URL. Como alternativa, se você baixar os dados de aquisições do relatório de análise do Partner Center, a ID do produto será incluída no arquivo .tsv. Sim
data de início data A data de início no intervalo de datas dos dados 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 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. Cada declaração contém um nome de campo do corpo da resposta e um valor que estão associados aos operadores eq ou ne, e as declarações podem ser combinadas usando e ou ou. Os valores de cadeia de caracteres devem ser cercados por aspas simples no parâmetro filter. Por exemplo, filtro=mercado igual a 'US' e género igual a 'm'.
Você pode especificar os seguintes campos do corpo da resposta:
  • Tipo de Aquisição
  • idade
  • armazenarCliente
  • género
  • mercado
  • osVersão
  • Tipo de dispositivo
  • sandboxId
 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, semanaou mês. Se não for especificado, o valor predefinido é dia. Não
ordenar por corda Uma declaração que ordena os valores dos dados de resultado para cada aquisição. A sintaxe é orderby=field [order],field [order],... O field parâmetro pode ser uma das seguintes strings:
  • data
  • Tipo de Aquisição
  • idade
  • armazenarCliente
  • género
  • mercado
  • osVersão
  • Tipo de dispositivo
  • tipoDeInstrumentoDePagamento
  • sandboxId
  • xboxTitleId
O parâmetro de ordem é opcional e pode ser asc ou desc para especificar a ordem crescente ou decrescente de 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 Aquisição
  • idade
  • armazenarCliente
  • género
  • mercado
  • osVersão
  • Tipo de dispositivo
  • tipoDeInstrumentoDePagamento
  • sandboxId
  • xboxTitleId
As linhas de dados retornadas conterão os campos especificados no parâmetro groupby , bem como o seguinte:
  • data
  • IdDeAplicação
  • quantidade de aquisição
O parâmetro groupby pode ser usado com o parâmetro aggregationLevel. Por exemplo: &groupby=age,market&aggregationLevel=week		 Não

Exemplo de solicitação

O exemplo a seguir demonstra várias solicitações para obter dados de aquisição de jogos do Xbox One. Substitua o valor applicationId pelo ID do produto do seu jogo.

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&skip=0&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 aquisição agregados para o jogo. Para obter mais informações sobre os dados em cada objeto, consulte a seção de valores de aquisição abaixo.
Contagem total número inteiro O número total de linhas no resultado de dados para a consulta.

Valores de aquisição

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

Valor Tipo Descrição
data corda A primeira data no intervalo de datas dos dados de aquisiçã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 A identificação do produto do jogo Xbox One para o qual estás a recuperar dados de aquisição.
Nome da Aplicação corda O nome de exibição do jogo.
Tipo de aquisição corda Uma das seguintes cadeias de caracteres que indica o tipo de aquisição:
  • Grátis
  • Avaliação
  • Pago
  • Código promocional
  • IAP
  • Subscrição Compras In-App
  • Audiência Privada
  • Pré encomenda
  • Xbox Game Pass (ou Game Pass, caso consulte dados anteriores a 23 de março de 2018)
  • Disco
  • Código Pré-pago
  • Pré-encomenda cobrada
  • Pré-encomenda cancelada
  • Falha na pré-encomenda
idade corda Uma das seguintes cadeias de caracteres que indica a faixa etária do usuário que fez a aquisição:
  • Menos de 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • Maior que 55
  • Desconhecido
Tipo de dispositivo corda Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo que concluiu a aquisição:
  • Computador Pessoal
  • Telefone
  • Console-Xbox Um
  • Console-Xbox Série X
  • Internet das coisas
  • Servidor
  • Comprimido
  • Holográfico
  • Desconhecido
Género corda Uma das seguintes cadeias de caracteres que especifica o gênero do usuário que fez a aquisição:
  • m
  • f
  • Desconhecido
mercado corda O código de país ISO 3166 do mercado onde ocorreu a aquisição.
osVersão corda A versão do SO em que ocorreu a aquisição. Para esse método, esse valor é sempre Windows 10 ou Windows 11.
tipo de instrumento de pagamento corda Uma das seguintes cadeias de caracteres que indica a instrução de pagamento usada para a aquisição:
  • Cartão de Crédito
  • Cartão de Débito Direto
  • Compra Inferida
  • Saldo MS
  • Operador Móvel
  • Transferência Bancária Online
  • PayPal
  • Transação Dividida
  • Resgate de Tokens
  • Zero Valor Pago
  • Carteira Eletrónica
  • Desconhecido
sandboxId corda O ID da sandbox criado para o jogo. Pode ser o valor RETAIL ou um ID de sandbox privado.
storeClient corda Uma das seguintes cadeias de caracteres que indica a versão da Loja onde ocorreu a aquisição:
  • Windows Phone Store (cliente)
  • Microsoft Store (cliente) (ou Windows Store (cliente) se estiver consultando dados antes de 23 de março de 2018)
  • Microsoft Store (web) (ou Windows Store (web) se estiver consultando dados antes de 23 de março de 2018)
  • Compra em volume por organizações
  • Outros
xboxTitleId corda A ID de título do Xbox Live (representada em valor hexadecimal) atribuída pelo Xbox Developer Portal (XDP) para jogos habilitados para Xbox Live.
quantidade de aquisição número O número de aquisições que ocorreram durante o nível de agregação especificado.
compraPreçoUSDAmount número O valor pago pelo cliente pela aquisição, convertido em USD, usando a taxa de câmbio mensal.
MontanteImpostoCompraUSD número O valor do imposto aplicado à aquisição, convertido em USD.
localCurrencyCode corda Código de moeda local com base no país/região da conta do Partner Center.
xboxProductId corda ID do Produto Xbox do XDP, se aplicável.
Id de disponibilidade corda ID de disponibilidade do produto do XDP, se aplicável.
skuId corda ID de SKU do produto do XDP, se aplicável.
skuDisplayName corda Nome de apresentação do SKU do produto do XDP, se aplicável.
xboxParentProductId corda Identificador do Produto Pai Xbox do XDP, se aplicável.
nomeDoProdutoPai corda Nome do Produto Principal do produto do XDP, se aplicável.
nomeDoTipoDeProduto corda Tipo de produto Nome do produto de XDP, se aplicável.
tipoDeImpostoDeCompra corda Tipo de imposto de compra do produto do XDP, se aplicável.
Montante do preço de compra local número Preço de Compra e Montante Local do produto da XDP, se aplicável.
valorLocalImpostoDeCompra número Valor Local do Imposto de Compra do produto do XDP, se aplicável.

Exemplo de resposta

O exemplo a seguir demonstra um corpo de resposta JSON de exemplo para essa solicitação.

{ 
    "Value": [ 
        { 
            "date": "2019-01-15T01:00:00.0000000Z", 
            "applicationId": "9WZDNCRFHXHT", 
            "applicationName": null, 
            "acquisitionType": "Paid", 
            "age": null, 
            "deviceType": "Phone", 
            "gender": null, 
            "market": "US", 
            "osVersion": "Windows 11", 
            "paymentInstrumentType": null, 
            "sandboxId": "RETAIL", 
            "storeClient": "Microsoft Store (client)", 
            "xboxTitleId": null, 
            "localCurrencyCode": "USD", 
            "xboxProductId": null, 
            "availabilityId": "B42LRTSZ2MCJ", 
            "skuId": "0010", 
            "skuDisplayName": null, 
            "xboxParentProductId": null, 
            "parentProductName": null, 
            "productTypeName": "Game", 
            "purchaseTaxType": "TaxesNotIncluded", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 3.08, 
            "purchasePriceLocalAmount": 3.08, 
            "purchaseTaxUSDAmount": 0.09, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null,
    
    "TotalCount": 12221 
}

 

  • Last updated on