Obter dados de desempenho do anúncio

Use esse método na API de análise da Microsoft Store para obter dados agregados de desempenho de anúncios para seus aplicativos durante um determinado intervalo de datas e outros filtros opcionais. Esse método retorna os dados no formato JSON.

Esse método retorna os mesmos dados fornecidos pelo relatório de desempenho de Advertising 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.

Para obter mais informações, consulte acesso a dados analíticos usando os serviços da Microsoft Store.

Pedido

Sintaxe da solicitação

Cabeçalho da solicitação

Parâmetros de solicitação

Para recuperar dados de desempenho de anúncios para um aplicativo específico, use o parâmetro applicationId. Para recuperar dados de desempenho de anúncios para todos os aplicativos associados à sua conta de desenvolvedor, omita o parâmetro applicationId.

Filtrar campos

O parâmetro de filtro do corpo 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. Aqui está um exemplo filtro parâmetro:

• filtro=mercado eq 'US' e tipoDeDispositivo eq 'phone'

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&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/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Resposta

Corpo da resposta

Valores de desempenho do anúncio

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

Exemplo de resposta

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

{
  "Value": [
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10765920",
      "adUnitName":"TestAdUnit",
      "revenueInAccountCurrency": 10.0,
      "impressions": 1000,
      "requests": 10000,
      "clicks": 1,
      "accountCurrencyCode":"USD"
    },
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10795110",
      "adUnitName":"TestAdUnit2",
      "revenueInAccountCurrency": 20.0,
      "impressions": 2000,
      "requests": 20000,
      "clicks": 3,
      "accountCurrencyCode":"USD"
    },
  ],
  "@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
  "TotalCount": 191753
}

Tópicos relacionados

• Relatório de desempenho publicitário
• Acessar dados analíticos usando os serviços da Microsoft Store