客户端库的基本用法如下:
安装
建议使用 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,可以使用以下任一选项:
- 使用 gem 安装此库:
terminal $ [sudo] gem install google-ads-googleads - 从“版本”页面下载 gem,然后从本地文件安装该 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 上的错误处理程序示例,请点击此处。