Method: accounts.campaignReport.generate

Gera um relatório de campanha com base nas especificações fornecidas.

Solicitação HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Nome do recurso da conta para gerar o relatório. Exemplo: accounts/pub-9876543210987654

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
Campos
reportSpec

object (CampaignReportSpec)

Especificação do relatório de campanha.

Corpo da resposta

Resposta da API de relatório de campanha.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Campos
rows[]

object (ReportRow)

Os dados do relatório de campanha do publisher especificado. No máximo, 100.000 linhas serão retornadas da API.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

Para mais informações, consulte OAuth 2.0 Overview.

CampaignReportSpec

A especificação para gerar um relatório de campanha. Por exemplo, a especificação para receber IMPRESSIONS e CLICKS segmentados por CAMPAIGN_ID pode ser semelhante ao exemplo a seguir:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
Representação JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
Campos
dateRange

object (DateRange)

É o período em que o relatório é gerado. O período máximo é de 30 dias.
dimensions[]

enum (Dimension)

Lista de dimensões do relatório. A combinação de valores dessas dimensões determina a linha do relatório. Se nenhuma dimensão for especificada, o relatório vai retornar uma única linha de métricas solicitadas para toda a conta.
metrics[]

enum (Metric)

Lista de métricas do relatório. Um relatório precisa especificar pelo menos uma métrica.
languageCode

string

Idioma usado em qualquer texto localizado, como determinados valores de dimensão aplicáveis. A tag de idioma é definida no IETF BCP47. O padrão é "en-US" se não for especificado ou for inválido.

Dimensão

As dimensões do relatório de campanha.

Tipos enumerados
DIMENSION_UNSPECIFIED Valor padrão de uma dimensão não especificada. Não use.
DATE Uma data no formato AAAAMMDD (por exemplo, "20210701").
CAMPAIGN_ID O ID exclusivo da campanha, por exemplo, "123456789", que é consistente com o ID da campanha da API de lista de campanhas.
CAMPAIGN_NAME O nome da campanha.
AD_ID O ID exclusivo do anúncio, por exemplo, "123456789".
AD_NAME O nome do anúncio, que pode não ser exclusivo.
PLACEMENT_ID O ID exclusivo específico do fornecedor do app em que o anúncio é veiculado. Por exemplo, com.goog.bar para Android e 123456789 para apps iOS.
PLACEMENT_NAME O nome do app em que o anúncio é veiculado.
PLACEMENT_PLATFORM A plataforma do app em que o anúncio é veiculado.
COUNTRY O nome do país segmentado.
FORMAT Formato do bloco de anúncios (por exemplo, "banner", "nativo"), uma dimensão de veiculação de anúncios.

Métrica

As métricas do relatório de campanha.

Tipos enumerados
METRIC_UNSPECIFIED Valor padrão para um campo não definido. Não use.
IMPRESSIONS O número de vezes que um anúncio é mostrado ao usuário.
CLICKS O número de vezes que um usuário clica em um anúncio.
CLICK_THROUGH_RATE O número de cliques que um anúncio recebe dividido pelo número de vezes que ele é exibido.
INSTALLS O número de vezes que os apps foram baixados para dispositivos.
ESTIMATED_COST É o custo previsto para veicular um anúncio da campanha em vez de um anúncio que gera receita. A moeda é a de relatório das campanhas.
AVERAGE_CPI É o custo médio por instalação. Isso significa o valor médio gasto para conquistar um novo usuário. A moeda é a de relatório das campanhas.
INTERACTIONS O número de vezes que um usuário interage com um anúncio. Isso consiste em cliques e engajamentos.