安裝及使用 Google Ads API 開發人員助理

必要條件

開始之前,請確認您具備以下項目:

  1. Google Ads API 存取權:

  2. 軟體:

    • Python 3.10 以上版本。Python 是預設語言,因此您必須安裝 Python 並將其加入路徑。
    • 已安裝 gemini-cli
    • jq (指令列 JSON 處理器)。如果缺少這項工具,安裝指令碼會嘗試安裝。
  3. 存放區:

開始使用

  1. 前往專案目錄:

    cd <full path>/google-ads-api-developer-assistant
    
  2. 執行設定指令碼: 這段指令碼會設定 gemini-cli,以便使用助理的GEMINI.md 內容檔案和必要工具。

    ./install.sh
    

    如果您使用 Windows,請執行 setup.ps1 PowerShell 指令碼。

  3. 啟動 gemini-cli:

    gemini
    
  4. 與 Google 助理互動: 現在可以透過自然語言提問或下達指令。

主要功能與特色

  • 自然語言問答:詢問 Google Ads API 功能、最佳做法或特定資源。

    • 「下列哪些是可用的廣告活動類型?」
    • 「如何在 GAQL 中依日期篩選?」
    • 「說明 click_view 和 impression_view 的差異。」
  • 程式碼生成:生成 GAQL 查詢和可執行的 Python 程式碼片段。

    • 「顯示過去 30 天內轉換次數最多的廣告活動。」
    • 「取得廣告活動 ID 12345 的所有已啟用廣告群組名稱。」
    • 「找出所有廣告活動中遭拒登的廣告。」產生的程式碼會儲存在 saved_code/ 目錄中。
  • 直接執行 API:直接從 gemini-cli 執行產生的唯讀 Python 指令碼,並在終端機中查看格式化結果。Google 助理產生驗證碼後,畫面上會顯示提示:

To run this script, you will need to replace YOUR_CUSTOMER_ID with your actual
Google Ads customer ID and execute the following command in
your shell: <command>

輸入 run,如果預設語言是 Python、Ruby 或 PHP,指令碼就會在 Assistant 環境中執行。由於安全政策,編譯語言不會執行。

  • 匯出 CSV 檔案:將 API 呼叫傳回的表格結果儲存為 CSV 檔案。

    • 「將結果儲存為 CSV 檔案。」 檔案會儲存在 saved_csv/ 目錄中。
  • 疑難排解協助:取得錯誤訊息或 API 異常行為的相關說明。

    • 「我收到『AuthenticationError.OAUTH_TOKEN_INVALID』錯誤,該怎麼辦?」
    • 「為什麼我的查詢沒有任何結果?」
  • 其他情境:新增程式碼集做為情境。

    • 從 2.3.0 版開始,請使用 context_dir 旗標加入專案檔案: ./update.sh --context_dir /path/to/your/codebase 這樣一來,助理在產生回覆時,就能將應用程式邏輯納入推論考量。
    • 這項功能可讓 Google 助理以您選擇的語言產生已儲存的程式碼範例,即使沒有官方用戶端程式庫,也能提供支援。
    • 要求輸出程式碼前,請先告知 Google 助理: write saved code examples in <language of your application>

應用實例

  • 報表:
    • 「請提供客戶 12345678 上個月費用最高的 5 個關鍵字。」
  • 帳戶結構:
    • 「列出所有廣告活動名稱和 ID。」
  • 疑難排解:
    • 「我上傳了 100 筆轉換資料,但使用者介面只顯示 78 筆。如何使用 API 偵錯?"
  • 學習:
    • "/explain what a shared set is"
  • 程式碼生成:
    • 「撰寫程式碼來為 company name 建立最高成效廣告活動。」

社群與支援

  • GitHub 問題:在存放區的「問題」分頁標籤 中回報錯誤、建議功能或尋求協助。
  • Discord:加入 Google 廣告與評估社群 Discord 伺服器#ads-api-ai-tools 頻道,與其他成員一起討論。
  • 意見回饋:請透過這份問卷表單分享您的意見。

參與規定

歡迎貢獻心力!如需相關指南,請參閱 GitHub 存放區中的 CONTRIBUTING.md 檔案。