Obtenha aquisições adicionais

Use esse método na API de análise da Microsoft Store para obter dados de aquisição agregados para complementos para seu aplicativo no formato JSON 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 de complementos 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

Cabeçalho da solicitação

Parâmetros de solicitação

O parâmetro applicationId ou inAppProductId é necessário. Para recuperar dados de aquisição para todos os complementos registrados no aplicativo, especifique o parâmetro applicationId . Para recuperar dados de aquisição para um único complemento, especifique o parâmetro inAppProductId . Se você especificar ambos, o parâmetro applicationId será ignorado.

Filtrar campos

O parâmetro do filtro da solicitação contém uma ou mais declaraçõ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. Aqui estão alguns exemplos de parâmetros de filtro :

• filter=mercado eq 'EUA' e sexo eq 'm'
• filter=(mercado ne «US») e (género ne «Desconhecido») e (género ne «m») e (mercado ne «NO») e (grupo etário ne «superior a 55» ou grupo etário ne «inferior a 13»)

Para obter uma lista dos campos suportados, consulte a tabela a seguir. Os valores de cadeia de caracteres devem estar entre aspas simples no parâmetro do filtro .

Exemplo de solicitação

Os exemplos a seguir demonstram várias solicitações para a obtenção de dados de aquisição de complementos. Substitua os valores inAppProductId e applicationId pela ID da Loja apropriada para seu complemento ou aplicativo.

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>

Resposta

Corpo da resposta

Valores de aquisição de complementos

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

Exemplo de solicitação e resposta

O trecho de código a seguir demonstra uma solicitação de exemplo e um corpo de resposta JSON para essas solicitações.

Pedido de amostra

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Exemplo de resposta

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NBLGGAAGZDQ",
            "date": "2022-07-29",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 18.12,
            "purchasePriceLocalAmount": 18.12,
            "purchaseTaxUSDAmount": 1.13,
            "purchaseTaxLocalAmount": 1.13
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Episode 4",
            "addonProductId": "9NAAAAAAAAAQ",
            "date": "2017-01-07",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 4.147206,
            "purchasePriceLocalAmount": 3.99,
            "purchaseTaxUSDAmount": 0.686004,
            "purchaseTaxLocalAmount": 0.66
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NALGGGZ5QDQ",
            "date": "2018-04-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.99,
            "purchasePriceLocalAmount": 1.99,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Strategy Guide Episode 4",
            "addonProductId": "9NBLGGGZ5QDQ",
            "date": "2021-11-25",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.31902922876179,
            "purchasePriceLocalAmount": 150.0,
            "purchaseTaxUSDAmount": 0.114315866492689,
            "purchaseTaxLocalAmount": 13.0
        },
    ],
    "TotalCount": 4,
    "DataFreshnessTimestamp": "2022-07-29T05:54:00"
}

Tópicos relacionados

• Relatório de aquisições adicionais
• Acessar dados analíticos usando os serviços da Microsoft Store
• Obtenha conversões adicionais por canal
• Obter aquisições de aplicações
• Obter dados do funil de aquisição de aplicativos
• Obter conversões de aplicativos por canal