Podstawowe użycie biblioteki klienta wygląda tak:
Instalacja
Zalecamy instalację za pomocą narzędzia Bundler. 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 narzędzia Bundler do zaktualizowania pliku Gemfile.lock, blokując dokładną wersję gemu i wszystkie zależności gemu, które zostały zainstalowane. Operator wersji pesymistycznej "~> x.y.z" powoduje, że bundle update instaluje tylko nowe wersje z serii x.y.*, więc musisz ręcznie wybrać nowe wersje, ponownie aktualizując plik Gemfile.
Inne opcje instalacji
Jeśli nie używasz narzędzia Bundler, możesz skorzystać z jednej z tych opcji:
- Zainstaluj tę bibliotekę za pomocą gemu:
terminal $ [sudo] gem install google-ads-googleads - Pobierz gem ze strony
Releases 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
Więcej szczegółowych przykładów użycia biblioteki znajdziesz w GitHubie.
Gdy zapoznasz się z przykładami, zalecamy też zapoznanie się z fabrykami, które udostępniają zestaw metod wysokiego poziomu ułatwiających pracę z interfejsem Google Ads API.
Obsługa błędów
Nie każde wywołanie interfejsu API zakończy się powodzeniem. Jeśli wywołania interfejsu API nie powiodą się z jakiegoś powodu, serwer może zgłosić błędy. Ważne jest, aby przechwytywać błędy interfejsu API i odpowiednio je obsługiwać.
Gdy wystąpi błąd interfejsu API, zgłaszana jest instancja GoogleAdsException. Zawiera ona szczegóły, które pomagają ustalić, co poszło nie tak. Możesz też skonfigurować funkcję pomocniczą do obsługi błędów. Przykład obsługi błędów znajdziesz w GitHubie
.