Google Ads API 統合を構築するうえで、テストは重要なステップです。初めて統合を構築する場合も、アプリを維持する場合も、既存の統合に新機能を追加する場合も同様です。このガイドでは、Google Ads API 統合をテストする際のベスト プラクティスについて説明します。
テスト アカウントと本番環境アカウント
テスト アカウントは開発目的で使用できます。テスト アカウントを使用すると、アプリケーション コードと構成が意図したとおりに動作していることを検証できます。
ただし、テスト アカウントではすべての機能をテストできるわけではありません 。
テスト アカウントの制限により、統合の一部の機能をテストできない場合は、代わりに本番環境アカウントを開発に使用できます。本番環境アカウントを呼び出すには、
Google Cloud プロジェクトに少なくとも
エクスプローラ アクセスレベル(エクスプローラ、ベーシック、スタンダード)が必要です。エクスプローラ アクセスでは、請求(BillingSetupService
と AccountBudgetProposalService)、
プランニング、アカウントの作成、ユーザーの招待など、ベーシックまたはスタンダード
アクセスが必要な特定の
サービスが制限されます(エクスプローラ機能
の制限を参照)。テスト アクセスレベルのプロジェクトから本番環境アカウントを呼び出そうとすると、
v25 以降では AuthorizationError.CLOUD_PROJECT_NOT_APPROVED_FOR_PRODUCTION が返され、
v24 以前では AuthorizationError.ACTION_NOT_PERMITTED が返されます。
開発用の本番環境アカウントは、次の点でテスト アカウントと異なります。
- ユーザーに表示される広告を配信する
- 有効な URL が必要
- 広告掲載のポリシーに準拠している必要がある
本番環境アカウントは広告を配信するため、指標が生成され、パフォーマンス レポートをテストできます。また、Google Ads API の他のすべての機能も利用できます。 ただし、開発に使用する場合は注意が必要です。次の対策を講じることをおすすめします。
- 開発に必要なユーザーにのみアクセス権を付与する。
- 1 日の固定の低いアカウントの予算を設定する。
- テスト アカウントを使用できない場合にのみ、開発に本番環境アカウントを使用する。
したがって、統合を完全にテストするには、テスト用認証情報と本番環境用認証情報の両方が必要になる可能性があります。
テスト用認証情報
開発アカウントを変更しようとしたときに本番環境アカウントを誤って変更するリスクを最小限に抑えるため、本番環境アプリケーションの認証情報とは別のテスト用認証情報のセットを保持することをおすすめします。
テスト用認証情報のセットを作成する手順は次のとおりです。
- テスト目的でのみ使用するメール アカウント(
api.test@example.comなど)またはサービス アカウントを作成します。 - このユーザーまたはサービス アカウントを、テストを実行する Google 広告アカウントの有効なユーザーとして追加します。このユーザーまたはサービス アカウントに適切なアクセス レベルを付与してください。このユーザーまたはサービス アカウントに本番環境アカウントへのアクセス権を付与しないでください。
- サービス アカウント フローではなく OAuth 2.0 ユーザー認証フローを使用している場合は、 テスト ユーザー アカウントの更新トークンを生成します。
- アプリケーションをテストする際は、この新しい認証情報を使用します。クライアント ID とクライアント シークレットは、アクセスできる Google 広告アカウントの決定に影響しないため、テスト目的で再利用できます。すべての認証情報と更新トークンを安全に保存し、ソース管理にコミットしないでください。
リクエストの検証
リクエストが有効かどうかをテストするだけでよい場合(リクエストが正しく構造化され、ポリシーに違反していないことを確認する場合など)は、validate_only フィールドを使用できます。このフィールドは、GoogleAdsService.Search リクエスト(GoogleAdsService.SearchStream は validate_only をサポートしていません)とほとんどの変更リクエストで使用できます。このフィールドが特定のメソッドで使用できるかどうかを確認するには、
リファレンス ドキュメントをご覧ください。
REST API
リクエストが期待どおりの出力を生成するかどうかを検証する場合など、アドホック テストには REST API を使用するのが最も簡単な方法です。REST API にリクエストを行う際に curl を使用する方法については、REST の例をご覧ください。また、REST エクスプローラでテストすることもできます。