基本的な使い方

クライアント ライブラリの基本的な使用方法は次のとおりです。

インストール

ライブラリをインストールする推奨の方法は、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 を使用していない場合は、次のいずれかのオプションを使用できます。

  1. このライブラリは RubyGems を使用してインストールします。

    gem install google-ads-googleads

  2. リリース ページから 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 のエラー ハンドラの例をご覧ください。