Uso básico

O uso básico da biblioteca de cliente é o seguinte:

Instalação

A maneira recomendada de instalar a biblioteca é usando o Bundler. Adicione uma linha ao Gemfile (substituindo x.y.z pelo número da versão que você quer usar):

gem 'google-ads-googleads', '~> x.y.z'

Depois, execute:

bundle install

Esse comando usa o Bundler para atualizar o Gemfile.lock, bloqueando a versão exata da gem e todas as dependências dela que foram instaladas. O operador de versão pessimista "~> x.y.z" garante que bundle install ou bundle update instale apenas novas versões de patch na série x.y.*. Portanto, você precisa ativar manualmente as novas versões secundárias ou principais atualizando seu Gemfile.

Outras opções de instalação

Se você não estiver usando o Bundler, use uma destas opções:

  1. Instale esta biblioteca usando RubyGems:

    gem install google-ads-googleads

  2. Faça o download da gem na página de versões e instale-a do arquivo local:

    gem install google-ads-googleads-[version].gem

Configurar a autenticação

Para autenticar as chamadas de API, configure o arquivo google_ads_config.rb e siga as instruções na página Autenticação e autorização.

Uso

A partir da versão 41.1.0 do google-ads-googleads, a gem é compatível com o autorequire do Bundler (Bundler.require). Em versões anteriores à 41.1.0 (ou quando não estiver usando Bundler.require), exija explicitamente a gem no código:

require 'google/ads/google_ads'

Inicialize o cliente (que carrega a configuração de ~/google_ads_config.rb por padrão) e busque um serviço específico, como CampaignService:

# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Fetch the CampaignService client.
campaign_service = client.service.campaign

Confira os exemplos no GitHub para ver demonstrações mais detalhadas de como usar a biblioteca.

Depois de se familiarizar com os exemplos, conheça as fábricas, que oferecem um conjunto de métodos de conveniência de alto nível para trabalhar com a API Google Ads.

Tratamento de erros

Nem todas as chamadas de API são bem-sucedidas. O servidor gera exceções se as chamadas de API falharem. É importante capturar erros de API e lidar com eles de maneira adequada.

Uma instância Google::Ads::GoogleAds::Errors::GoogleAdsError é gerada quando ocorre um erro de API. Ele contém detalhes para ajudar você a determinar o que deu errado, e é possível configurar uma função auxiliar para lidar com os erros. Veja um exemplo de gerenciador de erros no GitHub.