基本用法

用戶端程式庫的基本用法如下:

安裝

建議使用 bundler 安裝。在 Gemfile 中新增一行 (將 x.y.z 替換成您感興趣的版本號碼):

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

然後執行下列指令:

$ bundle install

這項指令會使用 Bundler 更新 Gemfile.lock,並鎖定 Gem 的確切版本,以及已安裝的 Gem 所有依附元件。悲觀版本運算子 "~> x.y.z" 會導致 bundle update 只安裝 x.y.* 系列中的新版本,因此您必須再次更新 Gemfile,手動選擇新版本。

其他安裝選項

如果未使用 bundler,可以採用下列其中一種方式:

  1. 使用 gem 安裝這個程式庫: terminal $ [sudo] gem install google-ads-googleads
  2. 從「Releases」頁面下載 Gem,然後從本機檔案安裝: terminal $ [sudo] gem install google-ads-googleads-[version].gem

設定驗證

如要驗證 API 呼叫,請按照「驗證和授權」頁面的說明操作。

用量

如要在程式碼中加入 Gem:

require 'google/ads/google_ads'

如要擷取特定服務 (例如 CampaignService):

client = Google::Ads::GoogleAds::GoogleAdsClient.new
campaign_service = client.service.campaign

如需如何使用程式庫的詳細示範,請參閱 GitHub 上的範例

熟悉範例後,我們也建議您瞭解工廠,這組高階便利方法可與 Google Ads API 搭配使用。

處理錯誤

並非每次 API 呼叫都會成功。如果 API 呼叫因故失敗,伺服器可能會擲回錯誤。請務必擷取 API 錯誤並妥善處理。

發生 API 錯誤時,系統會擲回 GoogleAdsException 例項。其中包含詳細資料,可協助您找出錯誤原因,並設定輔助函式來處理錯誤。請參閱 GitHub 上的錯誤處理常式範例