Google Ads APIのバージョンアップにクライアントライブラリを活用

ごあいさつ

初めまして。価格.com基盤システム部の社内業務推進担当の佐藤と申します。

入社当初はアプリケーション開発を担当していましたが、現在の業務は価格.comの社内向けのシステム開発を担当しています。
本記事では、Google Ads APIを使ったキーワード検索のバージョンアップ対応について紹介いたします。

Google Ads APIを使ってキーワード検索数を確認

マーケティングツールとして、キーワードの検索数を調べるのにGoogle Ads APIを使用しています。
そのGoogle Ads APIを呼び出すのに使用している動作環境は、GCPのCloud Pub/Sub、Cloud Functions、Cloud SQL、Cloud Storageです。

Google Ads APIのv12からv14への対応

こちらの対応をしたのは2023年7月～8月頃になります。
Google Ads APIのv12の廃止が迫っていたため、v14への対応を行ないました。

・バージョンアップ変更点の確認

Google Ads API v14のお知らせをみて変更点を確認しました。

・既存モジュールへの影響確認

マーケティングツールのなかでバージョンアップによる影響を受けるものがないか調べたところ
過去の指標データを取得するために使用していた KeywordPlanService.GenerateHistoricalMetrics が
お知らせページに書かれている KeywordPlanService で削除された複数のメソッド に含まれていることがわかりました。
記載されていた KeywordPlanIdeaService から代替となるメソッドを探して対応することにしました。

・クライアントライブラリとは

こちらのページには、各言語に対応するクライアントライブラリへのリンクが用意されています。
クライアントライブラリにはGoogle Ads APIの機能を呼び出すために使う基本的な構成要素が用意されています。
そのおかげでパラメータや例外処理はどうするかなどが把握できました。

・クライアントライブラリの使い方

使用したい言語のクライアントライブラリのコードをGitHubからダウンロードして使います。今回はPythonを対象としています。
GitHubからクローン、もしくはダウンロードしてきます。
ローカルのクライアントライブラリをVS Codeで開きます。
google-ads.yamlファイルに必要な設定値を記載します。
examplesフォルダ配下にさまざまなサンプルがあるので、デバッグしたいサンプルを探して開きます。今回はplanningフォルダのなかのganerate_historical_metrics.pyファイルが対象です。
止めたい場所にブレイクポイントを設定して、RunメニューからStart Debuggingを選択してデバッグ開始です。
ローカルデバッグすることでAPIがどのような挙動をするのか
パラメータを変えることで、結果がどう変わるのかが簡単にわかりました。
このクライアントライブラリのおかげで、v12からv14へ対応するために必要なことを理解できました。

・バージョンアップでの運用改善点

v14に対応することでv12では必要だった手順が不要となり
そのおかげで実装がシンプルになり、例外処理もわかりやすくなりました。
これは、運用にもいい効果がありました。

Google Ads APIのサポートの終了と廃止について

Google Ads APIは早い周期でバージョンアップが行なわれます。バージョンのサポート期間や廃止についてはこちらに記載されています。

この記事を書いている現在(2024年1月)、すでにv14はサポート終了しており2024年5月には廃止される予定です。
メジャーバージョンアップされてからそのバージョンがサポート終了するまでが4か月ほどとなっていて、廃止されるまでは約1年です。
バージョンアップに対応するのは大変なときもありますが、対応することで使いやすくなる面もあります。

さいごに

今回は、Google Ads APIのバージョンアップ対応の話をさせていただきました。
今後はバージョンアップ対応をしながら、GCPで使用している言語をPythonからC#に変更し誰でも対応ができるようにしたいと考えています。
この内容が何かのお役に立てばうれしいです。最後まで読んでいただきありがとうございました。