必要條件
開始之前,請確認您具備以下項目:
Google Ads API 存取權:
- Google Ads API 開發人員權杖。
- Google Ads 設定檔,其中已設定開發人員權杖、OAuth 2.0 憑證和客戶 ID,位於主目錄中。請參閱用戶端程式庫設定指南。
- 熟悉 Google Ads API 概念和驗證。
軟體:
- Python 3.10 以上版本。Python 是預設語言,因此您必須安裝這個語言並設定路徑。
- 已安裝 Google Antigravity 指令列工具。
- jq (指令列 JSON 處理器)。如果缺少這項工具,安裝指令碼會嘗試安裝。
存放區:
- 從 GitHub 複製的本機
google-ads-api-developer-assistant存放區。
- 從 GitHub 複製的本機
開始使用
前往專案目錄:
cd <full path>/google-ads-api-developer-assistant(注意:如果已啟用 Antigravity Shell 整合功能,進入這個目錄就會自動啟動助理工作階段)。
執行安裝指令碼: 這個指令碼會初始化開發環境,並複製必要的 Google Ads 用戶端程式庫 (預設會安裝 Python)。
./install.sh如果您使用 Windows,請執行
install.ps1PowerShell 指令碼。設定憑證: 請確認
google-ads.yaml(或語言等效項目) 位於主目錄中。與 Google 助理互動: 工作階段啟動後,您就能直接在終端機中使用自然語言與 Google 助理互動。
主要功能與特色
自然語言問答:詢問 Google Ads API 功能、最佳做法或特定資源。
- 「下列哪些是可用的廣告活動類型?」
- 「如何在 GAQL 中依日期篩選?」
- 「說明 click_view 和 impression_view 的差異。」
程式碼生成:生成 GAQL 查詢和可執行的 Python 程式碼片段。
- 「顯示過去 30 天內轉換次數最多的廣告活動。」
- 「Get all enabled ad group names for campaign ID 12345.」(取得廣告活動 ID 12345 的所有已啟用廣告群組名稱)。
- 「找出所有廣告活動中遭拒登的廣告」。
系統會使用
ruff自動檢查產生的程式碼,並儲存在saved/code/目錄中。
直接執行 API:在隔離的虛擬環境 (
.venv) 中直接執行產生的唯讀 Python 指令碼,並在終端機中以表格形式查看格式化結果。- 只要對 Google 助理說出「執行程式碼」或「執行指令碼」即可。
- 為確保安全,系統會產生變動作業 (建立、更新、刪除),但絕不會執行這些作業。
匯出 CSV 檔案:將 API 呼叫傳回的表格結果儲存為 CSV 檔案。
- 「將結果儲存為 CSV 檔案。」
檔案會儲存在
saved/csv/目錄中。
- 「將結果儲存為 CSV 檔案。」
檔案會儲存在
進階診斷與疑難排解:取得錯誤訊息、非預期的 API 行為或離線轉換問題的相關協助。
- 「為什麼我的查詢沒有任何結果?」
- 「為客戶 123-456-7890 解決轉換問題。」(產生詳細的診斷報表,並以
saved/data/格式儲存)。
其他情境:新增您自己的程式碼集或自訂程式庫,提供情境資訊。
- 使用
update.sh指令碼和--context_path選項註冊專案檔案:none ./update.sh --context_path /path/to/your/codebase - 這樣一來,Google 助理在以慣用語言建立回覆或生成程式碼時,就能將應用程式邏輯納入推論考量。
- 使用
應用實例
- 報表:
- 「請提供上個月客戶 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 檔案。