Uso básico

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

Instalação

A maneira recomendada de instalar é usando o bundler. Adicione uma linha ao seu Gemfile, substituindo x.y.z pelo número da versão que você quer:

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

Depois, execute:

$ bundle install

Esse comando usa o bundler para atualizar seu 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" faz com que o bundle update instale apenas novas versões na série x.y.*. Portanto, você precisa ativar manualmente as novas versões atualizando o Gemfile novamente.

Outras opções de instalação

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

  1. Instale a biblioteca usando gem: terminal $ [sudo] gem install google-ads-googleads
  2. Faça o download da gem na página "Releases" e instale-a do arquivo local: terminal $ [sudo] gem install google-ads-googleads-[version].gem

Configurar a autenticação

Para autenticar suas chamadas de API, siga as instruções na página de autenticação e autorização.

Uso

Para incluir a gem no seu código:

require 'google/ads/google_ads'

Para buscar um serviço específico, por exemplo, "CampaignService":

client = Google::Ads::GoogleAds::GoogleAdsClient.new
campaign_service = client.service.campaign

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

Depois de conhecer os exemplos, recomendamos que você se familiarize com as fábricas, que oferecem um conjunto de métodos convenientes de alto nível para trabalhar com a API Google Ads.

Tratamento de erros

Nem todas as chamadas de API serão bem-sucedidas. O servidor pode gerar erros se as chamadas de API falharem por algum motivo. É importante capturar erros de API e processá-los de maneira adequada.

Uma instância GoogleAdsException é gerada quando ocorre um erro na API. Ele tem detalhes para ajudar você a descobrir o que deu errado, e é possível configurar uma função auxiliar para processar os erros. Confira um exemplo de processador de erros no GitHub.