前提条件
在开始之前,请确保满足以下条件:
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 Ads API 特性、最佳 实践或特定资源的问题。
- “可供使用的广告系列类型有哪些?”
- “如何在 GAQL 中按日期过滤?”
- “解释 click_view 和 impression_view 之间的区别。”
代码生成: 生成 GAQL 查询和可执行的 Python 代码段。
- “显示过去 30 天内转化次数最多的广告系列。”
- “获取广告系列 ID 12345 的所有已启用广告组名称。”
- “查找所有广告系列中状态为‘已拒登’的广告。”
生成的代码会自动使用
ruff进行 lint,并保存在saved/code/目录中。
直接执行 API: 直接在隔离的虚拟环境 (
.venv) 中运行生成的只读 Python 脚本,并在终端中以表格形式查看格式化后的结果。- 只需告诉助理:“运行代码”或“执行脚本”。
- 为确保安全,系统会生成更改操作(创建、更新、删除),但绝不会 执行这些操作。
CSV 导出: 将 API 调用中的表格结果保存到 CSV 文件。
- “将结果保存到 CSV 文件。”
文件保存在
saved/csv/目录中。
- “将结果保存到 CSV 文件。”
文件保存在
高级诊断和问题排查: 获取有关错误消息、意外 API 行为或线下转化问题的帮助。
- “为什么我的查询没有显示任何结果?”
- “为客户 123-456-7890 排查转化问题。”(在
saved/data/中生成详细的诊断报告)。
其他上下文: 添加您自己的代码库或自定义库以提供上下文。
- 使用带有
--context_path选项的update.sh脚本注册 您的项目文件:none ./update.sh --context_path /path/to/your/codebase - 这样,助理在创建回复或以您首选的语言生成代码时,就可以将您的应用逻辑纳入推理过程。
- 使用带有
应用场景示例
- 报告:
- “获取客户 12345678 上个月费用最高的前 5 个关键字。”
- 账号结构:
- “列出所有广告系列名称及其 ID。”
- 问题排查:
- “我上传了 100 次转化,但界面中只显示了 78 次。如何使用 API 调试此问题?”
- 学习:
- “/explain 什么是共享集”
- 代码生成:
- “编写代码以创建company name的效果最大化广告系列。”
社区和支持
- GitHub 问题: 在代码库的 “问题”标签页 中报告 bug、提出功能建议或寻求帮助。
- Discord: 加入
Google 广告和效果衡量社区 Discord 服务器上的
#ads-api-ai-tools频道中的讨论。 - 反馈: 通过此 调查表单分享您的反馈。
贡献指南
欢迎您做出贡献!如需了解相关指南,请参阅 GitHub 代码库中的 CONTRIBUTING.md 文件。