Podstawowe użycie

Podstawowe użycie biblioteki klienta wygląda tak:

Instalacja

Zalecany sposób instalacji biblioteki to użycie Bundlera. Dodaj wiersz do pliku Gemfile (zastępując x.y.z numerem wersji, której chcesz używać):

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

Następnie uruchom:

bundle install

To polecenie używa narzędzia Bundler do zaktualizowania pliku Gemfile.lock, blokując dokładną wersję gema i wszystkie zainstalowane zależności gema. Operator wersji pesymistycznej "~> x.y.z" zapewnia, że bundle install lub bundle update instaluje tylko nowe wersje poprawek z serii x.y.*, więc musisz ręcznie włączyć nowe wersje podrzędne lub główne, aktualizując Gemfile.

Inne opcje instalacji

Jeśli nie używasz Bundlera, możesz skorzystać z jednej z tych opcji:

  1. Zainstaluj tę bibliotekę za pomocą RubyGems:

    gem install google-ads-googleads

  2. Pobierz gem ze strony z wersjami i zainstaluj go z pliku lokalnego:

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

Konfigurowanie uwierzytelniania

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

Wykorzystanie

Od wersji google-ads-googleads 41.1.0 gem obsługuje automatyczne wymaganie Bundlera (Bundler.require). W wersjach wcześniejszych niż 41.1.0 (lub gdy nie używasz Bundler.require) musisz jawnie wymagać gem w kodzie:

require 'google/ads/google_ads'

Zainicjuj klienta (który domyślnie wczytuje konfigurację z ~/google_ads_config.rb) i pobierz konkretną usługę, np. CampaignService:

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

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

Więcej szczegółowych przykładów użycia biblioteki znajdziesz w przykładach na GitHubie.

Po zapoznaniu się z przykładami możesz przejść do fabryk, 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 kończy się powodzeniem. Jeśli wywołania interfejsu API zakończą się niepowodzeniem, serwer zgłosi wyjątki. Ważne jest, aby rejestrować błędy interfejsu API i odpowiednio je obsługiwać.

Instancja Google::Ads::GoogleAds::Errors::GoogleAdsError jest zgłaszana, gdy wystąpi błąd interfejsu API. Zawiera szczegóły, które pomogą Ci określić, co poszło nie tak, i umożliwia skonfigurowanie funkcji pomocniczej do obsługi błędów. Przykład obsługi błędów znajdziesz na GitHubie.