客户端库的基本用法如下:
安装
建议使用 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从版本页面下载 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 上的错误处理程序示例。