設定

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

設定檔

您可以指定一個執行個體化時要使用的 google_ads_config.rb 檔案。

如果您在執行個體化時不使用引數:

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

然後程式庫會查詢 GOOGLE_ADS_CONFIGURATION_FILE_PATH 環境變數中指定的位置。如果未設定該變數,程式庫將在您的 HOME 目錄中尋找該檔案。

或者,您也可以指定路徑:

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 用戶端密鑰。
  • developer_token:用來存取 API 的開發人員權杖。
  • login_customer_id:請參閱 login-customer-id 說明文件

記錄欄位。如需完整詳細資料,請參閱記錄指南

  • log_level:您要記錄的最低記錄層級訊息。例如,指定 'DEBUG' 可確保您查看所有記錄訊息,指定 'INFO' 則會排除 DEBUG 訊息,但顯示所有其他訊息。
  • log_target:您要登入的位置,例如 STDERR
  • logger:指定您的自訂記錄工具。指定這項設定會覆寫 log_levellog_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。