Obter dados de desempenho da campanha publicitária
Use esse método na API de análise da Microsoft Store para obter um resumo agregado dos dados de desempenho de campanhas publicitárias promocionais 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 campanha publicitária na Central de Parceiros. Para obter mais informações sobre campanhas publicitárias, consulte Criar uma campanha publicitária para seu aplicativo.
Para criar, atualizar ou recuperar detalhes de campanhas publicitárias, você pode usar os métodos Gerenciar campanhas publicitárias na API de promoções da Microsoft Store.
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/promotion |
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
Para recuperar dados de desempenho de campanhas publicitárias de um aplicativo específico, use o parâmetro applicationId. Para recuperar dados de desempenho do anúncio de todos os aplicativos associados à sua conta de desenvolvedor, omita o parâmetro applicationId.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| applicationId | string | A ID da Store do aplicativo cujos dados de desempenho da campanha publicitária você deseja recuperar. | Não |
| startDate | date | A data de início no intervalo de datas dos dados de desempenho da campanha publicitária a serem recuperados, no formato AAAA/MM/DD. O padrão é a data atua menos 30 dias. | Não |
| endDate | date | A data de término no intervalo de datas dos dados de desempenho da campanha publicitária a serem recuperados, no formato AAAA/MM/DD. O padrão é a data atual menos um dia. | 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 as linhas na resposta. O único filtro com suporte é campaignId. Cada instrução pode usar os operadores eq ou ne e as instruções podem ser combinadas usando and ou or. Este é um exemplo de parâmetro filter: filter=campaignId eq '100023'. |
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 os dados de desempenho da campanha publicitária. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes sequências:
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,campaignId |
Não |
| groupby | string | Uma instrução que aplica agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos:
O parâmetro groupby pode ser usado com o parâmetro aggregationLevel. Por exemplo: &groupby=applicationId&aggregationLevel=week |
Não |
Exemplo de solicitação
O exemplo a seguir demonstra várias solicitações para obter dados de desempenho de campanhas publicitárias.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' 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 agregados de desempenho de campanhas publicitárias. Para obter mais informações sobre os dados em cada objeto, consulte a seção Objeto de desempenho da campanha a seguir. |
| @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 5, mas houver mais de 5 itens de dados para a consulta. |
| TotalCount | int | O número total de linhas no resultado de dados da consulta. |
Objeto de desempenho da campanha
Os elementos na matriz Value contêm os valores a seguir.
| Valor | Type | Descrição |
|---|---|---|
| date | string | A primeira data no intervalo de datas dos dados de desempenho da campanha publicitária. 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 | A ID da Store do aplicativo cujos dados de desempenho da campanha publicitária você está recuperando. |
| campaignId | string | A ID da campanha publicitária. |
| lineId | string | A ID da linha de veiculação da campanha publicitária que gerou esses dados de desempenho. |
| currencyCode | string | O código de moeda do orçamento da campanha. |
| spend | string | O valor do orçamento que foi gasto para a campanha publicitária. |
| impressions | longo | O número de impressões de anúncios para a campanha. |
| instalações | longo | O número de instalações de aplicativos relacionadas à campanha. |
| clicks | longo | O número de cliques no anúncio da campanha. |
| iapInstalls | longo | O número de instalações de complemento (também chamado de compra realizada em aplicativo ou IAP) relacionadas à campanha. |
| activeUsers | longo | O número de usuários que clicaram em um anúncio que faz parte da campanha e retornaram ao aplicativo. |
Exemplo de resposta
Veja a seguir um exemplo de corpo de resposta JSON para essa solicitação.
{
"Value": [
{
"date": "2015-04-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "4568",
"lineId": "0001",
"currencyCode": "USD",
"spend": 700.6,
"impressions": 200,
"installs": 30,
"clicks": 8,
"iapInstalls": 0,
"activeUsers": 0
},
{
"date": "2015-05-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "1234",
"lineId": "0002",
"currencyCode": "USD",
"spend": 325.3,
"impressions": 20,
"installs": 2,
"clicks": 5,
"iapInstalls": 0,
"activeUsers": 0
}
],
"@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
"TotalCount": 1917
}