Google Ads API Explorer

Google Ads API エクスプローラは、ブラウザから直接ライブ API リクエストを作成して送信できるインタラクティブな実行環境です。リファレンス ドキュメントに埋め込まれており、OAuth 2.0 認証と JSON ペイロード形式の複雑さを処理するため、1 行のコードも記述せずに特定のサービスとメソッドをテストできます。

利点

  • ノーコード テスト: ローカル開発環境をセットアップせずに、ドキュメントから直接ライブ API 呼び出し(読み取りと書き込みの両方)を実行します。
  • プロトコル検出: HTTP リクエストとレスポンスの正確な構造を確認して、API の動作を理解します。
  • 低摩擦プロトタイピング: アプリケーションにロジックを実装する前に、エンドポイントの動作を検証し、未加工の API レスポンスを即座に検査します。
  • 認証の簡素化: このツールは OAuth 2.0 フローを自動的に管理するため、認証情報の管理ではなく API リクエストに集中できます。

スタートガイド

  1. ドキュメントに移動する: リファレンス ドキュメントに移動し、テストするサービスとメソッド(GoogleAdsService/Search など)を選択します。
  2. エクスプローラを開く: ページの右側にある [試してみる] パネルを探します。
  3. リクエストを構成する:
    • developer-tokenlogin-customer-id などの必須のリクエスト パラメータを入力します。
    • メソッドでペイロードが必要な場合(`mutate` オペレーションなど)は、インタラクティブ JSON エディタを使用してリクエスト本文を定義します。
  4. 実行: [実行] をクリックしてリクエストを送信します。このツールには、完全な HTTP リクエストと API からのライブ JSON レスポンスが表示されます。

主な機能

  • ライブ実行: 本番環境またはテスト アカウントに対して、リアルタイムの search オペレーションと mutate オペレーションを実行します。
  • JSON ペイロードの形式設定: ツールで必須フィールドと有効なスキーマ構造がハイライト表示されるため、リクエスト用の複雑な JSON オブジェクトをインタラクティブに作成できます。
  • フィールド マスク: update_mask ロジックをテストして、部分的なリソース更新が実際にどのように動作するかを確認します。
  • エラーの検査: 生のレスポンスで詳細なエラー メッセージとコード(QUERY_ERRORAUTHENTICATION_ERROR など)を確認し、デバッグを迅速に行うことができます。
  • コードのエクスポート: API Explorer の展開ビューから curl コマンド、未加工の HTTP リクエスト、または JavaScript のサンプルコードをエクスポートします。

サンプル ユースケース

  • アカウント設定の監査: get リクエストまたは search リクエストを実行して、アカウント単位の構成またはメタデータをすばやく取得します。
  • テスト ミューテーション: コードを本番環境にデプロイする前に、キャンペーンの作成や予算の更新が成功したことを確認します。
  • GAQL をデバッグする: エクスプローラを使用して Google 広告クエリ言語(GAQL)文字列を実行し、返された JSON 構造がアプリケーションの想定と一致することを確認します。
  • プロトコルの検証: 特定の API バージョンに必要な HTTP ヘッダーと JSON ネストを正確に検査します。