用戶端程式庫的基本用法如下:
安裝
建議使用 Bundler 安裝程式庫。在 Gemfile 中新增一行 (將 x.y.z 替換為要使用的版本號碼):
gem 'google-ads-googleads', '~> x.y.z'
然後執行下列指令:
bundle install
這項指令會使用 Bundler 更新 Gemfile.lock,鎖定 Gem 的確切版本,以及已安裝的 Gem 所有依附元件。悲觀版本運算子 "~> x.y.z" 可確保 bundle install 或 bundle update 只會安裝 x.y.* 系列的新修補程式版本,因此您必須更新 Gemfile,手動選擇要使用新的次要或主要版本。
其他安裝選項
如果未使用 Bundler,可以採用下列其中一種方式:
使用 RubyGems 安裝這個程式庫:
gem install google-ads-googleads從「Releases」頁面下載 Gem,然後從本機檔案安裝:
gem install google-ads-googleads-[version].gem
設定驗證方法
如要驗證 API 呼叫,請設定 google_ads_config.rb 檔案,並按照「驗證和授權」頁面的說明操作。
用量
從 google-ads-googleads v41.1.0 開始,這個 Gem 支援 Bundler 自動要求 (Bundler.require)。在 v41.1.0 之前的版本中 (或未使用 Bundler.require 時),請在程式碼中明確要求這個 Gem:
require 'google/ads/google_ads'
初始化用戶端 (預設會從 ~/google_ads_config.rb 載入設定),並擷取特定服務,例如 CampaignService:
# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Fetch the CampaignService client.
campaign_service = client.service.campaign
如需如何使用程式庫的詳細示範,請參閱 GitHub 上的範例。
熟悉範例後,請探索工廠,這組高階便利方法可與 Google Ads API 搭配使用。
處理錯誤
並非每次 API 呼叫都會成功。如果 API 呼叫失敗,伺服器會引發例外狀況。請務必擷取 API 錯誤並妥善處理。
發生 API 錯誤時,系統會引發 Google::Ads::GoogleAds::Errors::GoogleAdsError 例外狀況。其中包含的詳細資料有助於判斷問題所在,您也可以設定輔助函式來處理錯誤。如需錯誤處理常式的範例,請參閱 GitHub。