Primeiros passos

Este documento é destinado a desenvolvedores que querem usar a API de gerenciamento do Google AdSense para obter informações sobre sua conta do Google AdSense. Para acompanhar este documento, é necessário ter familiaridade com conceitos de programação e formatos de dados da Web.

Antes de começar

Criar uma conta do Google AdSense

Inscreva-se ou faça login na sua conta do Google AdSense para começar.

Familiarize-se com o Google AdSense

Se você não tem familiaridade com os conceitos do Google AdSense, leia as informações introdutórias sobre o Google AdSense e teste a interface do Google AdSense antes de começar a programar.

Escolher sua biblioteca de cliente

Na página Bibliotecas de cliente e amostras, você encontra informações sobre bibliotecas e amostras disponíveis. Clique na guia do idioma escolhido e siga os links para fazer o download da fonte. As bibliotecas de cliente cuidam do seguinte para você:

  • authentication
  • descoberta de serviços
  • criar as solicitações para a API
  • análise de resposta

Leia as instruções para instalar e configurar a biblioteca de cliente escolhida, normalmente encontrada no arquivo README no diretório raiz do repositório.

Caso a implementação tenha necessidades especiais, como o uso de um idioma sem suporte, faça solicitações diretas à API em vez de usar uma biblioteca de cliente.

Registrar seu aplicativo

Para usar a AdSense Management API, é necessário registrar o aplicativo que você está desenvolvendo criando um projeto e gerando um Client-ID.

Registrar o app

Edite os arquivos de configuração do projeto da biblioteca de cliente com as novas credenciais que você acabou de criar. Consulte a documentação da biblioteca de cliente para mais detalhes.

Observação:a Conta do Google usada para registro deve ser sua conta de desenvolvedor, ou seja, a conta que você quer que os usuários do seu aplicativo vejam como o desenvolvedor dele. Essa conta não precisa estar vinculada a um login do Google AdSense, já que os usuários concederão acesso às próprias contas ao usar o aplicativo.

Tutorial de início rápido

Siga as etapas abaixo para fazer as primeiras solicitações. Elas podem variar um pouco dependendo da biblioteca ou linguagem que você está usando:

  1. Use o exemplo apropriado para recuperar uma lista de clientes de anúncio de uma conta do Google AdSense. Essa solicitação inicia um processo único em que o usuário do Google AdSense autentica e autoriza seu projeto.

    Clientes de anúncio representam uma associação entre uma conta do Google AdSense e um produto do Google AdSense, como anúncios de conteúdo ou anúncios de pesquisa. Uma conta do Google AdSense pode ter um ou vários clientes de anúncio.

    1. Em aplicativos da Web, os usuários serão redirecionados a um site em que poderão optar por conceder acesso. Depois de autorizados, eles serão redirecionados para o URL de retorno de chamada definido no Console de APIs do Google.
    2. Os aplicativos instalados funcionam de forma semelhante. A biblioteca de cliente tentará abrir uma janela do navegador e usar um código de autorização. Para aplicativos Android, Chrome e iOS, esse método é específico da plataforma.
  2. Use o APIs Explorer do Google para reports.generate e solicite o seguinte relatório:
    • date_range: YESTERDAY
    • dimensions: DATE
    • metrics: ESTIMATED_EARNINGS

    Os relatórios oferecem insights sobre seus ganhos, bem como o que está afetando esses ganhos. Eles podem ser exibidos em uma conta inteira ou em um subconjunto de blocos de anúncios por meio do uso de canais.

  3. Tente solicitar o mesmo relatório pelo seu aplicativo.
  4. É possível filtrar os relatórios por blocos de anúncios. Busque a lista de blocos de anúncios usando adunits.list. É necessário um ID do cliente de anúncios (consiga-o na etapa 1). Depois de escolher um bloco de anúncios, use o ID dele no parâmetro filter para reports.generate:

    Blocos de anúncios são marcadores de posição para anúncios configurados pelo usuário que definem algumas propriedades dos anúncios mostrados (como tamanho e formato).

    • date_range: YESTERDAY
    • dimensions: DATE
    • metrics: ESTIMATED_EARNINGS
    • filter: AD_UNIT_ID==ca-pub-123456789:987654321
  5. Filtre por critérios personalizados ou de URL ou misture vários filtros.

    Canais são ferramentas que permitem acompanhar o desempenho de um subconjunto de blocos de anúncios. Há dois tipos de canais: de URL e personalizado. O primeiro permite acompanhar o desempenho em uma página ou um domínio específico, enquanto o segundo ajuda a acompanhar o desempenho de grupos de blocos de anúncios específicos selecionados pelo usuário.

Você está pronto para iniciar sua implementação explorando o restante das chamadas e recursos disponíveis na documentação de referência.