Notas da versão

Esta página contém notas da versão da API AdSense Management.

Versão 2

Esta versão traz as seguintes mudanças para remover a funcionalidade suspensa e alinhar a API AdSense Management com os padrões atuais da API do Google. De acordo com o esquema de controle de versões da API do Google, esta versão será atualizada ao longo do tempo para incluir outras funcionalidades (compatíveis com versões anteriores), em vez de novas funcionalidades serem lançadas em versões secundárias separadas.

2023-06-19

Pagamentos

  • O payments.list agora retorna detalhes sobre os pagamentos de editores premium.

2023-06-13

Relatórios

  • Adicionamos as métricas FUNNEL_REQUESTS, FUNNEL_IMPRESSIONS, FUNNEL_CLICKS e FUNNEL_RPM, que fornecem informações sobre a performance de blocos que não são de anúncios (por exemplo, blocos de pesquisa relacionada).

2023-03-30

Relatórios

  • Adicionamos a dimensão PAGE_URL, que permite o detalhamento das métricas por URL da página. Com algumas ressalvas, consulte Detalhamento do URL da página.

2022-09-21

AdUnits

  • Adição de métodos de criação e patch. Esses métodos só podem ser usados por projetos ativados para o AdSense for Platforms.

CustomChannels

  • Adição dos métodos create, patch e update. Esses métodos só podem ser usados por projetos ativados para o AdSense for Platforms.
  • O campo ativo foi adicionado ao recurso.

Contas

  • Adição do método getAdBlockingRecoveryTag.

2022-08-25

Relatórios

  • Adicionamos a dimensão HOSTED_AD_CLIENT_ID, que permite que editores de host e plataforma detalhem as métricas por conta de editor (editores host) e subcontas (editores de plataforma).

2022-05-03

AdClient

  • Adição do método get.

Relatórios

  • Adição do método getSaved.

UrlChannels

  • Adição do método get.

2022-03-31

Conta

AdClient

2022-02-24

Pagamento

  • O formato do nome do recurso foi estendido para oferecer suporte a recursos separados para ganhos no YouTube. Essa mudança acontece antes do lançamento gradual da experiência aprimorada do Google AdSense para criadores de conteúdo do YouTube, em que os ganhos do YouTube são separados em uma conta para pagamentos própria. As informações de pagamento do YouTube também serão retornadas do método da lista de pagamentos quando você tiver uma conta para pagamentos dedicada para ganhos do YouTube. Os ganhos do YouTube terão o seguinte formato de nome de recurso:
    • accounts/{account}/payments/youtube-unpaid por ganhos não pagos (atuais) do YouTube.
    • accounts/{account}/payments/youtube-yyyy-MM-dd para ganhos pagos do YouTube.

    Observação:os nomes dos recursos de ganhos do Google AdSense não vão mudar:
    • accounts/{account}/payments/unpaid por ganhos (atuais) do Google AdSense não pagos.
    • accounts/{account}/payments/yyyy-MM-dd para ganhos pagos do Google AdSense.

2021-06-30

Relatório

  • Adicionadas as dimensões AD_FORMAT_NAME e AD_FORMAT_CODE, indicando a forma como um anúncio é exibido para os usuários no seu site (in-page, vinheta etc.). A v1.4 tem dimensões (descontinuadas) com os mesmos nomes, mas com membros diferentes. As duas dimensões adicionadas na v2 são diferentes daquelas que estavam presentes na v1.4.

19/04/2021 (versão inicial)

Geral

  • Todos os métodos descontinuados na v1.4 foram removidos. Isso inclui métodos de recurso que não exigiam uma accountId. Na v2, o accountId é especificado no campo parent.
  • De acordo com os padrões da API do Google, os recursos agora são identificados por um campo name. Por exemplo, o nome de um AdClient seria semelhante a accounts/{accountId}/adclients/{adClientId}. Além disso, na v1.4, o ID do recurso era usado como uma dimensão de relatório, mas na v2 esse valor agora está disponível por meio de um campo reporting_dimension_id em vários recursos.
  • O campo kind foi removido de todos os recursos.

Conta

  • O campo name foi alterado para display_name.
  • O campo timezone foi alterado de uma string para um google.type.TimeZone.
  • O campo creation_time (tipo int64) foi alterado para create_time (tipo google.protobuf.Timestamp).
  • Adicionamos um campo pending_tasks, que é uma lista de tarefas pendentes que precisam ser concluídas como parte do processo de inscrição em uma nova conta. Por exemplo, as tarefas podem estar relacionadas ao seu perfil de faturamento ou à verificação de telefone.
  • O campo sub_accounts foi removido. Uma funcionalidade semelhante pode ser alcançada na v2 com o método personalizado listChildAccounts. A árvore da conta filha completa pode ser gerada na v2 chamando listChildAccounts recursivamente.

AdClient

  • O campo arc_opt_in foi removido porque já foi excluído da IU do Google AdSense.
  • O campo supports_reporting é substituído pelo campo reporting_dimension_id, que representa o ID exclusivo do cliente de anúncios conforme usado na dimensão de relatórios AD_CLIENT_ID. Se reporting_dimension_id estiver vazio, o AdClient não será compatível com a geração de relatórios.

AdUnit

  • O campo status foi renomeado como state. Além disso, o estado ACTIVE não indica mais se houve atividade nesse bloco de anúncios nos últimos sete dias. Na v2, isso significa que o bloco de anúncios foi ativado pelo usuário e pode veicular anúncios.
  • O campo code foi removido. Esse valor ainda é encontrado no final do campo name (após a última barra).
  • O campo contentAdsSettings.backupOption foi removido.
  • O campo type foi restrito aos valores TYPE_UNSPECIFIED, DISPLAY, FEED, ARTICLE, MATCHED_CONTENT e LINK.
  • Outros campos que já foram removidos na IU do Google AdSense também são removidos: custom_style, saved_style_id, mobile_content_ads_settings, feed_ads_settings.

Alerta

  • O método delete foi removido.
  • O campo is_dismissible foi removido.
  • O campo locale foi renomeado como language_code.

CustomChannel

  • O campo code foi removido. Esse valor ainda é encontrado no final do campo name (após a última barra).
  • O campo targeting_info foi removido porque já foi excluído da IU do Google AdSense.

Pagamento

  • O campo payment_date foi renomeado como date e alterado do tipo de string para o tipo google.type.Date.
  • Os campos payment_amount e payment_amount_currency_code foram combinados em um único campo payment (por exemplo, "JPY 1.235", "US$ 1.234,57", "£ 87,65").

Relatório

  • Com a v2, os dados de relatórios da API AdSense Management agora se alinham à interface do Google AdSense. Isso significa que as propriedades da AdMob e do YouTube não são mais compatíveis. Além disso, a API só é compatível com dados de relatórios de três anos atrás.
  • Os recursos Metadata.dimensions e Metadata.metrics foram removidos.
  • Novos métodos foram adicionados para gerar uma versão em CSV do relatório, substituindo os parâmetros de consulta na v1.4. Observação: para compactação, ainda é possível usar o cabeçalho HTTP "Accept-Encoding: gzip".
  • Alguns campos foram alterados na geração de relatórios ad-hoc.
    • O campo account_id foi renomeado como account.
    • O campo dimension foi renomeado como dimensions.
    • O campo metric foi renomeado como metrics.
    • O campo filter foi renomeado como filters.
    • O campo sort foi renomeado como order_by.
    • O campo locale foi renomeado como language_code.
    • O campo currency foi renomeado como currency_code.
    • Agora é possível especificar vários intervalos comuns com date_range (por exemplo, TODAY, YESTERDAY, MONTH_TO_DATE, YEAR_TO_DATE, LAST_7_DAYS e LAST_30_DAYS), ou você pode especificar um start_date e um end_date definindo date_range como CUSTOM.
    • Os campos start_date e end_date foram alterados do tipo string para o tipo google.type.Date. Observação: por isso, as palavras-chave de data relativa (por exemplo, "hoje-6d") não são mais compatíveis.
    • O campo booleano use_timezone_reporting foi substituído por reporting_time_zone, que pode ter um de dois valores: ACCOUNT_TIME_ZONE ou GOOGLE_TIME_ZONE (o que significa PST/PDT). O padrão na v2 é ACCOUNT_TIME_ZONE, que é diferente do padrão na v1.4.
    • O campo start_index foi removido.
    • O campo max_results foi renomeado como limit.
  • Alguns campos foram alterados na geração de relatórios salvos.
    • Campos de data adicionados (date_range, start_date, end_date, reporting_time_zone).
    • Adicionamos um campo currency_code.
    • O campo locale foi renomeado como language_code.
    • O campo start_index foi removido.
    • O campo max_results foi removido.

SavedAdStyle

  • SavedAdStyle foi removido porque já foi removido da interface do Google AdSense.

Site

  • Sites foram adicionadas para buscar dados sobre sites que você adicionou à sua conta do Google AdSense.
  • O campo state representa se o site tem um dos seguintes estados: REQUIRES_REVIEW, GETTING_READY, READY, NEEDS_ATTENTION.
  • O campo auto_ads_enabled é um booleano que representa se os anúncios automáticos foram ativados em um determinado site.

Versão 1.4

Esta versão apresenta as seguintes funcionalidades:

  • Agora você pode listar os pagamentos da sua conta do Google AdSense na moeda correspondente.
  • Agora você pode dispensar um alerta chamando o método delete, que vai ocultar o alerta na API e na interface da Web do Google AdSense.
  • A resposta do relatório agora inclui datas de início e término. Isso é importante se você usa datas relativas ao gerar relatórios (como today, yesterday, firstDayOfMonth-1m). A resposta agora inclui o período solicitado.

Problemas conhecidos

O campo currency nos relatórios não é compatível com esta versão.

Versão 1.3

Esta versão apresenta as seguintes funcionalidades:

  • A capacidade de recuperar alertas.
  • A capacidade de recuperar metadados de métricas e dimensões.
  • A capacidade de gerar relatórios no fuso horário local da conta.

Problemas conhecidos

O campo currency nos relatórios não é compatível com esta versão.

Versão 1.2

Esta versão apresenta as seguintes funcionalidades:

  • Capacidade de recuperar estilos de anúncio.
  • Capacidade de recuperar e executar os relatórios salvos definidos no front-end.

Problemas conhecidos

O campo currency nos relatórios não é compatível com esta versão.

Versão 1.1

Esta versão apresenta as seguintes funcionalidades:

Além disso, agora você pode acessar dados em sua conta padrão ou em uma conta específica.

Problemas conhecidos

O campo currency nos relatórios não é compatível com esta versão.

Versão 1

Esta é a primeira versão da API. Ela inclui suporte para recuperação de clientes de anúncios, blocos de anúncios, canais personalizados, critérios de URL e geração de relatórios.

Problemas conhecidos

O campo currency nos relatórios não é compatível com esta versão.