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 da campanha publicitária promocional 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 no Centro 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 de Gerenciar campanhas publicitárias na API de promoções Microsoft Store.

Pré-requisitos

Para usar esse 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. Depois de obter um token de acesso, você terá 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	URI de solicitação
OBTER	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion`

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

Para recuperar dados de desempenho de campanha publicitária 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.

Parâmetro	Tipo	Descrição	Obrigatório
ID do aplicativo	corda	A ID da Store do aplicativo para o qual você deseja recuperar dados de desempenho da campanha publicitária.	Não
Data de Início	data	A data de início no intervalo de datas dos dados de desempenho da campanha publicitária a serem recuperados, no formato YYYY/MM/DD. O padrão é a data atual menos 30 dias.	Não
data de término	data	A data de término no intervalo de datas dos dados de desempenho da campanha publicitária a serem recuperados, no formato YYYY/MM/DD. O padrão é a data atual menos um dia.	Não
Início	int	O número de linhas de dados a serem retornados na solicitação. O valor máximo e o valor padrão se não especificado for 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um próximo link que você pode usar para solicitar a próxima página de dados.	Não
pular	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 10000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10000 linhas de dados e assim por diante.	Não
filtro	corda	Uma ou mais declarações que filtram as linhas da 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 e ou ou. Aqui está um exemplo filtro parâmetro: `filter=campaignId eq '100023'`.	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, semana ou mês. Se não for especificado, o padrão será dia.	Não
pedido por	corda	Uma instrução que ordena os valores de 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 strings: data campanhaId O parâmetro order é opcional e pode ser asc ou desc para especificar ordem ascendente ou descendente para cada campo. O padrão é asc. Aqui está um exemplo orderby cadeia de caracteres: orderby=date,campaignId	Não
groupby	corda	Uma instrução que aplica a agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos: campanhaId ID do aplicativo data código da moeda 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 campanha publicitária.

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	Tipo	Descrição
Valor	conjunto	Uma matriz de objetos que contêm dados de desempenho de campanha de anúncios agregados. Para obter mais informações sobre os dados em cada objeto, consulte a seção do objeto de desempenho de campanha abaixo.
@nextLink	corda	Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você pode usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro superior da solicitação for definido como 5, mas houver mais de 5 itens de dados para a consulta.
ContagemTotal	int	O número total de linhas no resultado dos dados da consulta.

Objeto de performance da campanha

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

Valor	Tipo	Descrição
data	corda	A primeira data no intervalo de datas para os 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 especificou uma semana, um mês ou outro intervalo de datas, este valor é a primeira data nesse intervalo.
ID do aplicativo	corda	O ID da Loja do aplicativo para o qual você está obtendo dados de desempenho da campanha publicitária.
Id de campanha	corda	A ID da campanha publicitária.
lineId	corda	O ID da linha de entrega da campanha publicitária que gerou esses dados de desempenho.
código de moeda	corda	O código de moeda do orçamento da campanha.
gastar	corda	O valor do orçamento gasto para a campanha publicitária.
Impressões	Longas	O número de impressões publicitárias da campanha.
Instala	Longas	O número de instalações de aplicativo relacionadas à campanha.
Cliques	Longas	O número de cliques de anúncios para a campanha.
iapInstalls	Longas	O número de instalações de complemento (também chamado de compra no aplicativo ou IAP) relacionadas à campanha.
usuários ativos	Longas	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
}

Comentários

Esta página foi útil?

Last updated on 2025-06-10