設定

設定是透過 Config 類別完成。您可以透過多種方式存取這個類別，例如編寫設定檔、在建立時指定值，或從環境變數載入值。

設定檔

您可以在例項化用戶端時，指定要使用的 google_ads_config.rb 檔案。

如果您在例項化 GoogleAdsClient 物件時未使用任何引數，程式庫會尋找 GOOGLE_ADS_CONFIGURATION_FILE_PATH 環境變數中指定的位置。如果未設定該變數，程式庫會在 HOME 目錄中尋找檔案。

或者，您可以在例項化 GoogleAdsClient 物件時指定路徑，如下所示，這樣用戶端就會在該路徑尋找檔案。

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

產生這個檔案最簡單的方法，就是從 GitHub 存放區複製 google_ads_config.rb，然後修改檔案，加入更新權杖、用戶端 ID 和用戶端密鑰。

動態設定

您可以在例項化程式庫時動態設定設定，甚至在之後進行設定：

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

您甚至可以在例項化後修改設定：

client.configure do |config|
  config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'

# ... more configuration
end

設定欄位

Config 物件支援下列欄位。

一般欄位：

  • refresh_token：您的 OAuth 更新權杖。
  • client_id：您的 OAuth 用戶端 ID。
  • client_secret：您的 OAuth 用戶端密鑰。
  • login_customer_id：請參閱登入客戶 ID 說明文件。

記錄欄位。詳情請參閱記錄指南。

  • log_level：要記錄的最低記錄檔層級訊息。舉例來說，指定 'DEBUG' 可確保您看到所有記錄訊息，而指定 'INFO' 則會排除 DEBUG 訊息，但顯示所有其他訊息。
  • log_target：要記錄的位置，例如 STDERR。
  • logger：指定您自己的自訂記錄器。指定這項設定會覆寫 log_level 和 log_target。

環境變數

您可以使用環境變數設定用戶端程式庫。這些函式不會預設載入，因此在例項化用戶端後，還需要額外呼叫才能載入。如要查看所有語言支援的環境變數完整清單，請參閱這篇文章。

如要將環境變數載入 Config，請呼叫 load_environment_config：

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

每次呼叫時，環境變數的目前狀態都會覆寫 Config 中已有的任何內容。舉例來說，您可以使用這個機制設定預設設定，但透過環境變數覆寫特定值，也可以完全透過環境變數設定。

除了所有程式庫都支援的環境變數外，Ruby 程式庫還有兩個額外變數：

  • GOOGLE_ADS_RUBY_LOG_LEVEL：如先前所述的 log_level。
  • GOOGLE_ADS_RUBY_HTTP_PROXY：指定 HTTP Proxy。