Konfiguracja

Konfigurację wykonuje się za pomocą klasy Config. Dostęp do tej klasy możesz uzyskać na wiele sposobów, np. za pomocą pliku konfiguracji, określenia wartości podczas tworzenia lub wczytywania wartości ze zmiennych środowiskowych.

Plik konfiguracji

Możesz wskazać plik google_ads_config.rb, którego chcesz użyć podczas tworzenia instancji klienta.

Jeśli podczas tworzenia wystąpienia nie używasz żadnych argumentów:

client = Google::Ads::GoogleAds::GoogleAdsClient.new

biblioteka będzie szukać w lokalizacji określonej w zmiennej środowiskowej GOOGLE_ADS_CONFIGURATION_FILE_PATH. Jeśli ta zmienna nie jest ustawiona, biblioteka szuka pliku w katalogu HOME.

Możesz też określić ścieżkę:

client = Google::Ads::GoogleAds::GoogleAdsClient.new("path/to/file.rb")

w tym przypadku klient będzie szukać pliku pod tą ścieżką.

Najprostszym sposobem wygenerowania tego pliku jest skopiowanie google_ads_config.rb z repozytorium GitHub i zmodyfikowanie go, tak aby zawierał token odświeżania, identyfikator klienta i tajny klucz klienta.

Konfiguracja dynamiczna

Konfigurację możesz skonfigurować dynamicznie podczas tworzenia wystąpienia biblioteki, a nawet później:

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  # ... more configuration
end

Konfigurację możesz nawet zmienić po utworzeniu instancji:

client.configure do |config|
  config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
  # ... more configuration
end

Pola konfiguracji

Obiekt Config obsługuje poniższe pola.

Pola ogólne:

  • refresh_token: token odświeżania protokołu OAuth.
  • client_id: identyfikator klienta OAuth.
  • client_secret: tajny klucz klienta OAuth.
  • developer_token: Twój token programisty umożliwiający dostęp do interfejsu API.
  • login_customer_id: zapoznaj się z dokumentacją identyfikatora klienta loginu.

Pola logowania. Szczegółowe informacje znajdziesz w przewodniku dotyczącym rejestrowania.

  • log_level: minimalny poziom logu, który chcesz zarejestrować. Jeśli na przykład określisz 'DEBUG', zobaczysz wszystkie komunikaty logu, a określenie parametru 'INFO' spowoduje wykluczenie wiadomości DEBUG, ale spowoduje wyświetlanie wszystkich innych komunikatów.
  • log_target: miejsce, w którym chcesz się zalogować, np. STDERR.
  • logger: określ własny rejestrator niestandardowych. Jeśli określisz tę wartość, zastąpią one właściwości log_level i log_target.

Zmienne środowiskowe

Bibliotekę klienta możesz skonfigurować za pomocą zmiennych środowiskowych. Nie są one wczytywane domyślnie i wymagają dodatkowego wywołania po utworzeniu wystąpienia klienta w celu ich załadowania. Zobacz pełną listę zmiennych środowiskowych obsługiwanych we wszystkich językach.

Aby wczytać zmienne środowiskowe do Config, wywołaj load_environment_config:

client = Google::Ads::GoogleAds::GoogleAdsClient.new
client.load_environment_config

Przy każdym wywołaniu bieżący stan zmiennych środowiskowych zastąpi wszystko, co występuje już w elemencie Config. Dzięki temu mechanizmowi możesz na przykład mieć domyślną konfigurację, ale zastąpić określone wartości za pomocą zmiennych środowiskowych lub całkowicie skonfigurować zmienne środowiskowe.

Oprócz zmiennych środowiskowych obsługiwanych przez wszystkie biblioteki biblioteka Ruby zawiera 2 dodatkowe zmienne:

  • GOOGLE_ADS_RUBY_LOG_LEVEL: jak powyżej w kolumnie log_level.
  • GOOGLE_ADS_RUBY_HTTP_PROXY: określ serwer proxy HTTP.