クライアント ライブラリの基本的な使用方法は次のとおりです。
インストール
インストールには 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 をダウンロードし、ローカル ファイルからインストールします。
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 のエラー ハンドラの例をご覧ください。