Podstawowe użycie

Podstawowe użycie biblioteki klienta wygląda tak:

Instalacja

Zalecany sposób instalacji to użycie bundlera. Dodaj wiersz do pliku Gemfile (zastępując x.y.z numerem wersji, która Cię interesuje):

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

Następnie uruchom polecenie:

$ bundle install

To polecenie używa usługi tworzenia pakietów do zaktualizowania pliku Gemfile.lock, blokując dokładną wersję gema i wszystkie zależności gema, które zostały zainstalowane. Operator pesymistycznej wersji "~> x.y.z" powoduje, że bundle update instaluje tylko nowe wersje z serii x.y.*, więc musisz ręcznie włączyć nowe wersje, ponownie aktualizując Gemfile.

Inne opcje instalacji

Jeśli nie używasz narzędzia do łączenia plików, możesz skorzystać z jednej z tych opcji:

  1. Zainstaluj tę bibliotekę za pomocą gemu:terminal $ [sudo] gem install google-ads-googleads
  2. Pobierz gem ze strony wersji i zainstaluj go z pliku lokalnego: terminal $ [sudo] gem install google-ads-googleads-[version].gem

Konfigurowanie uwierzytelniania

Aby uwierzytelnić wywołania interfejsu API, postępuj zgodnie z instrukcjami na stronie Uwierzytelnianie i autoryzacja.

Wykorzystanie

Aby uwzględnić gem w kodzie:

require 'google/ads/google_ads'

Aby pobrać konkretną usługę, np. CampaignService:

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

Bardziej szczegółowe przykłady użycia biblioteki znajdziesz w GitHubie.

Po zapoznaniu się z przykładami zalecamy też zapoznanie się z fabrykami, które udostępniają zestaw wygodnych metod wysokiego poziomu do pracy z interfejsem Google Ads API.

Obsługa błędów

Nie każde wywołanie interfejsu API zakończy się powodzeniem. Serwer może zgłaszać błędy, jeśli wywołania interfejsu API z jakiegoś powodu się nie powiodą. Ważne jest, aby rejestrować błędy interfejsu API i odpowiednio je obsługiwać.

Gdy wystąpi błąd interfejsu API, zgłaszana jest instancja GoogleAdsException. Zawiera szczegółowe informacje, które pomogą Ci ustalić, co poszło nie tak. Możesz też skonfigurować funkcję pomocniczą do obsługi błędów. Zobacz przykład obsługi błędów w GitHubie.