- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- MediationReportSpec
- Dimensão
- Métrica
- DimensionFilter
- SortCondition
- Exemplos
- Faça um teste
Gera um Relatório de mediação da AdMob com base na especificação de relatório 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/*}/mediationReport:generate
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
parent |
Nome do recurso da conta para a qual 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 ( |
Campos | |
---|---|
reportSpec |
Especificação do relatório de rede. |
Corpo da resposta
É a resposta de streaming do Relatório de mediação da AdMob em que a primeira resposta contém o cabeçalho do relatório, um fluxo de respostas das linhas e 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": {"decimal_value": "1324746"}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ // Union field |
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 |
Configurações de geração de relatórios que descrevem o conteúdo do relatório, como o período e as configurações de localização. |
row |
Dados reais do relatório. |
footer |
Informações adicionais sobre o relatório gerado, como avisos sobre os dados. |
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 a Visão geral do OAuth 2.0.
MediationReportSpec
A especificação para gerar um Relatório de mediação da AdMob. Por exemplo, a especificação para observar o CPM (custo por mil impressões) dividido por origem de anúncios e app para os "EUA" e "CN" podem ter a seguinte aparência:
{
"dateRange": {
"startDate": {"year": 2021, "month": 9, "day": 1},
"endDate": {"year": 2021, "month": 9, "day": 30}
},
"dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
"metrics": ["OBSERVED_ECPM"],
"dimensionFilters": [
{
"dimension": "COUNTRY",
"matchesAny": {"values": [{"value": "US", "value": "CN"}]}
}
],
"sortConditions": [
{"dimension":"APP", order: "ASCENDING"}
],
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
Para entender melhor, trate a especificação anterior como este pseudoSQL:
SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
Representação JSON |
---|
{ "dateRange": { object ( |
Campos | |
---|---|
dateRange |
O período para o qual o relatório é gerado. |
dimensions[] |
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 mostrará uma única linha de métricas solicitadas para toda a conta. |
metrics[] |
Lista de métricas do relatório. Um relatório precisa especificar pelo menos uma métrica. |
dimensionFilters[] |
Descreve quais linhas do relatório devem ser correspondidas com base nos valores de dimensão. |
sortConditions[] |
Descreve a classificação das linhas do relatório. A ordem da condição na lista define a precedência. quanto mais cedo for a condição, maior será a precedência. Se nenhuma condição de classificação for especificada, a ordenação da linha será indefinida. |
localizationSettings |
Configurações de localização do relatório. |
maxReportRows |
Número máximo de linhas de dados do relatório a serem retornadas. Se o valor não for definido, a API 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 |
O fuso horário de um relatório. Aceita valores de nome IANA TZ, como "America/Los_Angeles". Se nenhum fuso horário for definido, o padrão da conta entrará em vigor. Verifique o valor padrão pela ação get account. Aviso: América/Los_Angeles é o único valor aceito no momento. |
Dimensão
As dimensões do relatório de mediação. Dimensões são atributos de dados para detalhar ou refinar medidas 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 de 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_SOURCE |
O ID exclusivo da origem de anúncios (por exemplo, "5450213213286189855" e "Rede da AdMob" como valor do rótulo). |
AD_SOURCE_INSTANCE |
O ID exclusivo da instância da origem do anúncio (por exemplo, "ca-app-pub-1234:asi:5678" e "AdMob (padrão)" como valor do rótulo). |
AD_UNIT |
O ID exclusivo do bloco de anúncios (por exemplo, "ca-app-pub-1234/8790"). 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"). |
MEDIATION_GROUP |
O ID exclusivo do grupo de mediação (por exemplo, "ca-app-pub-1234:mg:1234" e "AdMob (padrão)" como valor do rótulo). |
COUNTRY |
Código do país CLDR do local onde ocorrem as visualizações/cliques 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 |
Plataforma de SO para dispositivos móveis do app (por exemplo, "Android" ou "iOS"). |
MOBILE_OS_VERSION |
A versão do sistema operacional para dispositivos móveis, 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 do PackageInfo. No 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 de mediação. As métricas são medidas quantitativas que indicam o desempenho do negócio do editor. Eles são agregados dos eventos de anúncios individuais e agrupados de acordo com as dimensões do relatório. O valor da métrica é um número inteiro ou decimal (sem arredondamento).
Enums | |
---|---|
METRIC_UNSPECIFIED |
Valor padrão de um campo não definido. Não use. |
AD_REQUESTS |
O número de solicitações. O valor é um número inteiro. |
CLICKS |
O 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 ganho é determinada pela configuração de localização de moeda. O valor está em micros. Por exemplo, US$ 6,50 seria representado como 6500000. Os ganhos estimados por grupo de mediação e por nível de instância da origem do anúncio são compatíveis desde 20 de outubro de 2019. Os ganhos estimados de terceiros vão mostrar "0" para datas anteriores a 20 de outubro de 2019. |
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 número decimal de precisão dupla (aproximada). |
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 entre as solicitações de anúncios correspondentes e o total de solicitações de anúncios. O valor é um número decimal de precisão dupla (aproximada). |
OBSERVED_ECPM |
O eCPM médio estimado da rede de anúncios de terceiros. A unidade monetária (USD, EUR ou outra) das métricas de ganho é determinada pela configuração de localização de moeda. O valor está em micros. Por exemplo, US$ 2,30 seria representado como 2.300.000. O eCPM médio estimado por grupo de mediação e por nível de instância de origem de anúncios é compatível desde 20 de outubro de 2019. O eCPM médio estimado de terceiros será zero para datas anteriores a 20 de outubro de 2019. |
DimensionFilter
Descreve quais linhas do relatório devem ser correspondidas com base nos valores de dimensão.
Representação JSON |
---|
{ "dimension": enum ( |
Campos | |
---|---|
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 |
Corresponde a uma linha se o valor da dimensão especificada está em um dos valores especificados na condição. |
SortCondition
Direção de classificação a ser aplicada a uma dimensão ou métrica.
Representação JSON |
---|
{ "order": enum ( |
Campos | |
---|---|
order |
Ordem de classificação da dimensão ou métrica. |
Campo de união sort_on . Identifica quais valores serão classificados. sort_on pode ser apenas de um dos tipos a seguir: |
|
dimension |
Ordenar pela dimensão especificada. |
metric |
Ordenar pela métrica especificada. |