Method: accounts.networkReport.generate

Gera um relatório da rede da AdMob com base na especificação fornecida. Retorna o resultado de uma RPC de streaming do lado do servidor. O resultado é retornado em uma sequência de respostas.

Solicitação HTTP

POST https://admob.googleapis.com/v1/{parent=accounts/*}/networkReport:generate

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

Parâmetros de caminho

Parâmetros
parent

string

Nome do recurso da conta para o qual o relatório será gerado. 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 (NetworkReportSpec)
  }
}
Campos
reportSpec

object (NetworkReportSpec)

Especificação do relatório de rede.

Corpo da resposta

A resposta de streaming do relatório da rede da AdMob em que a primeira resposta contém o cabeçalho do relatório, um fluxo de respostas de linha e, por fim, um rodapé como a última mensagem de resposta.

Exemplo:

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         displayLabel: "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

Representação JSON 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
Campos
Campo de união payload. Cada mensagem de resposta de stream contém um tipo de payload. payload pode ser apenas de um dos tipos a seguir:
header

object (ReportHeader)

Configurações de geração de relatório que descrevem o conteúdo, como período e configurações de localização.
row

object (ReportRow)

Dados reais do relatório.
footer

object (ReportFooter)

Informações adicionais sobre o relatório gerado, como avisos sobre os dados.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

NetworkReportSpec

A especificação para gerar um relatório da rede da AdMob. Por exemplo, a especificação para obter cliques e ganhos estimados apenas para os países "EUA" e "CN" pode ser semelhante ao seguinte exemplo:

{
  'dateRange': {
    'startDate': {'year': 2021, 'month': 9, 'day': 1},
    'endDate': {'year': 2021, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimensionFilters': [
    {
      'dimension': 'COUNTRY',
      'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sortConditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localizationSettings': {
    'currencyCode': 'USD',
    'languageCode': 'en-US'
  }
}

Para entender melhor, trate a especificação anterior como o seguinte pseudoSQL:

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
Representação JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Campos
dateRange

object (DateRange)

O período para o qual o relatório é gerado.
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.
dimensionFilters[]

object (DimensionFilter)

Descreve quais linhas do relatório devem ser correspondidas com base nos valores de dimensão.
sortConditions[]

object (SortCondition)

Descreve a classificação das linhas do relatório. A ordem da condição na lista define sua precedência; quanto mais cedo a condição, maior será sua precedência. Se nenhuma condição de classificação for especificada, a ordem das linhas será indefinida.
localizationSettings

object (LocalizationSettings)

Configurações de localização do relatório.
maxReportRows

integer

Número máximo de linhas de dados do relatório a serem retornadas. Se o valor não for definido, a API vai retornar o maior número possível de linhas, até 100.000. Os valores aceitáveis são de 1 a 100.000, inclusive. Valores maiores que 100.000 retornam um erro.
timeZone

string

Fuso horário do relatório. Aceita valores de nome IANA TZ, como "America/Los_Angeles". Se nenhum fuso horário for definido, o padrão da conta vai entrar em vigor. Verifique o valor padrão com a ação "Receber conta".

Aviso: "EUA/Los_Angeles" é o único valor aceito no momento.

Dimensão

As dimensões do relatório da rede. As dimensões são atributos de dados para detalhar ou refinar as medições quantitativas (métricas) por determinados atributos, como o formato do anúncio ou a plataforma em que um anúncio foi visualizado.

Enums
DIMENSION_UNSPECIFIED Valor padrão para um campo não definido. Não use.
DATE Uma data no formato AAAAMMDD (por exemplo, "20210701"). As solicitações podem especificar no máximo uma dimensão de tempo.
MONTH Um mês no formato AAAAMM (por exemplo, "202107"). As solicitações podem especificar no máximo uma dimensão de tempo.
WEEK A data do primeiro dia de uma semana no formato AAAAMMDD (por exemplo, "20210701"). As solicitações podem especificar no máximo uma dimensão de tempo.
AD_UNIT O ID exclusivo do bloco de anúncios (por exemplo, "ca-app-pub-1234/1234"). Se a dimensão AD_UNIT for especificada, APP será incluído automaticamente.
APP O ID exclusivo do aplicativo para dispositivos móveis (por exemplo, "ca-app-pub-1234~1234").
AD_TYPE

O tipo do anúncio (por exemplo, "texto" ou "imagem"), uma dimensão de exibição do anúncio.

Aviso:a dimensão é incompatível com as métricas AD_REQUESTS, MATCH_RATE e IMPRESSION_RPM.
COUNTRY Código do país CLDR do local onde ocorrem os cliques/visualizações do anúncio (por exemplo, "US" ou "FR"). Essa é uma dimensão geográfica.
FORMAT Formato do bloco de anúncios (por exemplo, "banner", "nativo"), uma dimensão de exibição de anúncios.
PLATFORM É a plataforma de SO para dispositivos móveis do app (por exemplo, "Android" ou "iOS").
MOBILE_OS_VERSION Versão do sistema operacional do dispositivo móvel, por exemplo, "iOS 13.5.1".
GMA_SDK_VERSION Versão do SDK do GMA, por exemplo, "iOS 7.62.0".
APP_VERSION_NAME Para Android, o nome da versão do app pode ser encontrado em versionName, em PackageInfo. Para iOS, o nome da versão do app pode ser encontrado em CFBundleShortVersionString.
SERVING_RESTRICTION Modo de restrição para veiculação de anúncios (por exemplo, "anúncios não personalizados").

Métrica

As métricas do relatório da rede. As métricas são avaliações quantitativas que indicam a performance dos negócios do editor. Eles são agregados de eventos de anúncios individuais e agrupados pelas dimensões do relatório. O valor da métrica é um número inteiro ou decimal (sem arredondamento).

Enums
METRIC_UNSPECIFIED Valor padrão para um campo não definido. Não use.
AD_REQUESTS

O número de solicitações de anúncios. O valor é um número inteiro.

Aviso:a métrica é incompatível com a dimensão AD_TYPE.
CLICKS Número de vezes que um usuário clica em um anúncio. O valor é um número inteiro.
ESTIMATED_EARNINGS Os ganhos estimados do editor da AdMob. A unidade monetária (USD, EUR ou outra) das métricas de ganhos é determinada pela configuração de localização da moeda. O valor está em micros. Por exemplo, US$ 6,50 seria representado como 6500000.
IMPRESSIONS O número total de anúncios exibidos aos usuários. O valor é um número inteiro.
IMPRESSION_CTR A proporção entre cliques e impressões. O valor é um valor decimal de dupla precisão (aproximado).
IMPRESSION_RPM

Os ganhos estimados por mil impressões de anúncios. O valor está em micros. Por exemplo, US$ 1,03 seria representado como 1030000. Equivalente ao eCPM na interface da AdMob.

Aviso:a métrica é incompatível com a dimensão AD_TYPE.
MATCHED_REQUESTS O número de vezes que os anúncios são retornados em resposta a uma solicitação. O valor é um número inteiro.
MATCH_RATE

A proporção de solicitações de anúncios correspondentes em relação ao total de solicitações de anúncios. O valor é um valor decimal de dupla precisão (aproximado).

Aviso:a métrica é incompatível com a dimensão AD_TYPE.
SHOW_RATE A proporção de anúncios que são exibidos em relação aos anúncios retornados, definida como impressões / solicitações correspondentes. O valor é um valor decimal de dupla precisão (aproximado).

DimensionFilter

Descreve quais linhas do relatório devem ser correspondidas com base nos valores de dimensão.

Representação JSON 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
Campos
dimension

enum (Dimension)

Aplica o critério de filtro à dimensão especificada.
Campo de união operator. Operador de filtro a ser aplicado. operator pode ser apenas de um dos tipos a seguir:
matchesAny

object (StringList)

Corresponde a uma linha se o valor dela para a dimensão especificada estiver em um dos valores especificados nesta condição.

SortCondition

Direção de classificação a ser aplicada a uma dimensão ou métrica.

Representação JSON 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
Campos
order

enum (SortOrder)

Ordem de classificação da dimensão ou métrica.
Campo de união sort_on. Identifica em quais valores classificar. sort_on pode ser apenas de um dos tipos a seguir:
dimension

enum (Dimension)

Classifique pela dimensão especificada.
metric

enum (Metric)

Classifique pela métrica especificada.