Google Ads API Developer Assistant をインストールして使用する

前提条件

Firebase を追加する前に、次の準備をしてください。

  1. Google Ads API へのアクセス:

  2. ソフトウェア:

    • Python 3.10 以降。Python はデフォルトの言語であるため、インストールしてパスに設定する必要があります。
    • Google Antigravity コマンドライン ツールがインストールされている。
    • jq(コマンドライン JSON プロセッサ)。インストール スクリプトは、これが存在しない場合にインストールを試みます。
  3. リポジトリ:

始める

  1. プロジェクト ディレクトリに移動します。

    cd <full path>/google-ads-api-developer-assistant
    

    (注: Antigravity シェル統合が有効になっている場合、このディレクトリに入ると、アシスタント セッションが自動的に初期化されます)。

  2. インストール スクリプトを実行します。 このスクリプトは、開発環境を初期化し、必要な Google Ads クライアント ライブラリを複製します(Python はデフォルトでインストールされます)。

    ./install.sh
    

    Windows を使用している場合は、install.ps1 PowerShell スクリプトを実行します。

  3. 認証情報を構成する: google-ads.yaml(または言語の同等のもの)がホーム ディレクトリに配置されていることを確認します。

  4. アシスタントを操作する: セッションがアクティブになったら、ターミナルで自然言語を使用してアシスタントを直接操作できます。

主な機能

  • 自然言語による Q&A: Google Ads API の機能、ベスト プラクティス、特定のリソースについて質問します。

    • 「提供されているキャンペーン タイプの組み合わせは、次のうちどれですか?」
    • 「GAQL で日付でフィルタするにはどうすればよいですか?」
    • 「click_view と impression_view の違いを説明してください。」
  • コード生成: GAQL クエリと実行可能な Python コード スニペットを生成します。

    • 「過去 30 日間でコンバージョン数が最も多いキャンペーンを表示して。」
    • 「キャンペーン ID 12345 の有効な広告グループ名をすべて取得します。」
    • 「すべてのキャンペーンで不承認の広告を見つける」 生成されたコードは ruff を使用して自動的にリントされ、saved/code/ ディレクトリに保存されます。
  • API の直接実行: 生成された読み取り専用の Python スクリプトを分離された仮想環境(.venv)内で直接実行し、フォーマットされた結果をターミナルの表として表示します。

    • アシスタントに「コードを実行して」または「スクリプトを実行して」と話しかけるだけです。
    • 安全のため、変更オペレーション(作成、更新、削除)は生成されますが、実行されることはありません。
  • CSV エクスポート: API 呼び出しからの表形式の結果を CSV ファイルに保存します。

    • 「結果を CSV ファイルに保存します。」 ファイルは saved/csv/ ディレクトリに保存されます。
  • 高度な診断とトラブルシューティング: エラー メッセージ、予期しない API の動作、オフライン コンバージョンに関する問題についてサポートを受けられます。

    • 「クエリの結果が表示されないのはなぜですか?」
    • 「お客様 123-456-7890 のコンバージョンに関する問題を解決して。」saved/data/ に詳細な診断レポートが生成されます)。
  • 追加のコンテキスト: コンテキストとして独自のコードベースまたはカスタム ライブラリを追加します。

    • --context_path オプションを指定して update.sh スクリプトを使用し、プロジェクト ファイルを登録します。 none ./update.sh --context_path /path/to/your/codebase
    • これにより、アシスタントは、応答を作成したり、任意の言語でコードを生成したりする際に、アプリケーション ロジックを推論に含めることができます。

サンプル ユースケース

  • レポート:
    • 「顧客 12345678 の先月の費用上位 5 個のキーワードを取得して。」
  • アカウントの構成:
    • 「すべてのキャンペーン名とその ID を一覧表示します。」
  • トラブルシューティング:
    • 「100 件のコンバージョンをアップロードしましたが、UI には 78 件しか表示されません。API を使用してこの問題をデバッグするにはどうすればよいですか?」
  • 学習中:
    • 「共有セットとは何かを説明して」
  • コード生成:
    • company name の P-MAX キャンペーンを作成するコードを記述してください。」

コミュニティとサポート

コード提供に関するガイドライン

皆様からの貢献をお待ちしております。ガイドラインについては、GitHub リポジトリの CONTRIBUTING.md ファイルをご覧ください。