Esta página foi traduzida pela API Cloud Translation.

API Alfa do Relatório de atividades do Google Ads

O Relatório de atividades do anúncio é uma centralizada do desempenho dos anúncios. Ele combina os dados, as métricas da API Network Report e da API Media Reporting, bem como dados de lances em um relatório unificado.

A API Ads Activity Report oferece outras melhorias da API API Report e API Network Report, conforme a tabela abaixo:

	API Network Report	API Mediation Report	API Ads Activity Report
Desempenho da rede	✅	✅	✅
Performance em cascata		✅	✅
Performance dos lances			✅
Performance do experimento A/B de mediação			✅
Relatórios por hora			✅
Tamanho do relatório	100.000	100.000	500 mil

Métricas, dimensões e filtros de dimensão

As métricas a seguir foram adicionadas à API Ads Activity Report: além de muitas das métricas disponíveis na API de relatórios de rede e a API Mediation Report.

Métrica	Descrição
BID_REQUEST	O número de solicitações feitas à origem de anúncios dos lances.
BIDS_IN_AUCTION	O número de lances enviados pela origem de anúncios que participaram dos leilões do Bidding.
WINNING_BIDS	O número de lances que venceram um leilão do Bidding.

As novas dimensões a seguir foram incluídas na API Ads Activity Report.

Dimensão	Descrição
SEMANA	A data do primeiro dia da semana (de acordo com o idioma mencionado nas configurações de localização) no formato AAAAMMDD (para por exemplo: "20210701"). As solicitações podem especificar apenas um destes: DATE, WEEK ou MONTH dimensão de tempo.
HORA	A hora no formato HH no horário PST. Por exemplo, "05" para 5h PST, "13" às 13h PST. A dimensão DATE também precisa ser especificada na solicitação. Um no máximo 28 dias de dados é retornado quando a dimensão HORA é especificada. Datas de início do período superiores a 28 dias anteriores à data atual retornar um erro.
MEDIATION_AB_TEST (nome do experimento)	Veja a performance por teste A/B de mediação. É obrigatório especificar esta se a dimensão VARIANT for especificada.
MEDIATION_AB_TEST_VARIANT (variante A, variante B)	Confira a performance por variante do teste A/B de mediação.

Nome da dimensão na API Mediation Report	Nome da dimensão na API Ads Activity Report	Descrição
BLOCO DE ANÚNCIOS¹	AD_UNIT_ID	O ID exclusivo do bloco de anúncios (por exemplo, "123456789").
BLOCO DE ANÚNCIOS¹	AD_UNIT_NAME	Nome do bloco de anúncios.
APP¹	APP_ID	O ID exclusivo do aplicativo para dispositivos móveis (por exemplo, "1234567890").
APP¹	APP_NAME	O nome do app.
ORIGEM_DO_ANÚNCIO¹	AD_SOURCE_ID	O ID exclusivo da origem de anúncios (por exemplo, "1234567890123456789".
ORIGEM_DO_ANÚNCIO¹	AD_SOURCE_NAME	O nome da origem de anúncios (por exemplo, "rede da AdMob").
AD_SOURCE_INSTANCE¹	AD_SOURCE_INSTANCE_ID	O ID exclusivo da instância da origem de anúncios (por exemplo, "123456789012").
AD_SOURCE_INSTANCE¹	AD_SOURCE_INSTANCE_NAME	O nome da instância da origem do anúncio (por exemplo, "AdMob (padrão)").
MEDIATION_GROUP¹ (link em inglês)	MEDIATION_GROUP_ID	O ID exclusivo do grupo de mediação (por exemplo, "1234567890").
MEDIATION_GROUP¹ (link em inglês)	MEDIATION_GROUP_NAME	O ID exclusivo do grupo de mediação (por exemplo, "AdMob (padrão)").

¹: consulte Scalars para mais informações.

As dimensões a seguir têm um formato atualizado.

Nome da dimensão na API Mediation Report	Descrição na API Mediation Report	Descrição na API Ads Activity Report
ESTIMATED_EARNINGS	Os ganhos estimados do editor da AdMob. A unidade monetária (USD, EUR ou outros) das métricas de ganho são determinadas pela localização. para moeda. O valor está em micros. Por exemplo, R$ 6,50 seria representada como 6.500.000. 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 exibir 0 para datas anteriores a 20 de outubro de 2019.	Os ganhos estimados do editor da AdMob. A unidade monetária (USD, EUR ou outros) das métricas de ganho são determinadas pela localização. para moeda.
OBSERVED_ECPM	O eCPM médio estimado da rede de anúncios de terceiros. A unidade monetária (USD, EUR ou outros) das métricas de ganho são determinadas pela localização. para moeda. O valor está em micros. Por exemplo, US$ 2,30 seria representada como 2.300.000. O eCPM médio estimado por grupo de mediação e por instância de origem de anúncios. é compatível desde 20 de outubro de 2019. Média estimada de terceiros O eCPM será exibido como 0 para datas anteriores a 20 de outubro de 2019.	O eCPM médio de todos os anúncios. A unidade monetária (USD, EUR ou outra) de As métricas de ganho são determinadas pela configuração de localização de moeda. O eCPM médio por grupo de mediação e por nível de instância de origem de anúncios é de compatíveis desde 20 de outubro de 2019. OBSERVED_ECPM exibirá 0 para datas antes de 20 de outubro de 2019.

Escalares

As dimensões abaixo foram atualizadas na API Ads Activity Report para serem valores escalares em vez de objetos. Isso vai simplificar a resposta e reduzir complexidade.

Dimensões afetadas na API Mediation Report e na API Network Report:

AD_UNIT
APP
AD_SOURCE
AD_SOURCE_INSTANCE
MEDIATION_GROUP

Dados de resposta de relatório de amostra
Formato de dimensão da API de mediação / de rede	"AD_UNIT": { "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY", "displayLabel": "Test ad unit name" }
Formato de dimensão da API AAR	"AD_UNIT_NAME": "Test ad unit name", "AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

Relatórios por hora

Agora você pode conferir a performance por hora na API AdMob. Os relatórios por hora são disponíveis por até 28 dias.

A dimensão DATE também precisa ser especificada na solicitação para recuperar por hora dados. Um máximo de 28 dias de dados é retornado quando a dimensão HORA é especificado. Datas de início superiores a 28 dias anteriores à a data atual retorne um erro.

Maior tamanho de relatório

A API Ads Activity Report permite recuperar um total de 500.000 linhas. Para Para saber mais, consulte o guia de cotas.

Fazer uma solicitação

Siga estas etapas para fazer uma solicitação.

curl (linha de comando)

Solicitações usando curl

Carregue o arquivo de chaves secretas do cliente e gere credenciais de autorização.

Na primeira vez que você realizar essa etapa, será solicitado que você aceite uma prompt de autorização do navegador. Antes de aceitar, confirme se fez login com uma Conta do Google que tem acesso à API AdMob. Seu será autorizada a acessar os dados em nome de qualquer está conectado no momento.

Para autenticação e autorização, recomendamos usar oauth2l, uma ferramenta de linha de comando simples para que funcionam com o Google OAuth 2.0. Instale o oauth2l e execute o comando abaixo, substituindo path_to_credentials_json por um caminho para um arquivo credentials.json, que pode ser baixado ao registrar sua aplicativo na nuvem. Na primeira execução, o comando mostra Fluxo de autorização do OAuth 2.0. As execuções subsequentes atualizam o token automaticamente.
```
~/go/bin/oauth2l header --json path_to_credentials_json \
        https://www.googleapis.com/auth/admob.readonly
```

Gerar um Relatório de atividades do anúncio.

curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
     -H "Content-Type: application/json" \
     -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
      {
        "report_spec": {
        "date_range": {
          "start_date": {"year": 2023, "month": 1, "day": 1},
          "end_date": {"year": 2023, "month": 1, "day": 2}
        },
        "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
        "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
        "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
        "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
        "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
        }
      }
EOF

Exemplo de resposta:

{
"rows": [
  {
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant A"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 0
      },
      "BID_REQUEST": {
        "integerValue": "27"
      },
      "WINNING_BIDS": {
        "doubleValue": 0.1111111111111111
      },
      "IMPRESSIONS": {
        "integerValue": "2"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0
      }
    }
  },
{
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant B"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 1
      },
      "BID_REQUEST": {
        "integerValue": "6"
      },
      "WINNING_BIDS": {
        "doubleValue": 1
      },
      "IMPRESSIONS": {
        "integerValue": "3"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0.000427519
      }
    }
  }
]}