介绍
# Google Ads
通过托管的 OAuth 身份验证访问 Google Ads API。使用 GAQL 查询广告系列、广告组、关键字和效果指标。
## 快速开始
```bash # List accessible customers python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/google-ads/v23/customers:listAccessibleCustomers') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
## 基础 URL
``` https://gateway.maton.ai/google-ads/{native-api-path} ```
将 `{native-api-path}` 替换为实际的 Google Ads API 端点路径。网关将请求代理到 `googleads.googleapis.com` 并自动注入 OAuth 和开发者令牌。
## 身份验证
所有请求都需要在 Authorization 头中包含 Maton API 密钥：
``` Authorization: Bearer $MATON_API_KEY ```
**环境变量：** 将您的 API 密钥设置为 `MATON_API_KEY`：
```bash export MATON_API_KEY="YOUR_API_KEY" ```
### 获取 API 密钥
1. 在 [maton.ai](https://maton.ai) 登录或创建账户 2. 前往 [maton.ai/settings](https://maton.ai/settings) 3. 复制您的 API 密钥
## 连接管理
在 `https://ctrl.maton.ai` 管理您的 Google Ads OAuth 连接。
### 列出连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections?app=google-ads&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 创建连接
```bash python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'google-ads'}).encode() req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 获取连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
**响应：** ```json { "connection": { "connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80", "status": "ACTIVE", "creation_time": "2025-12-08T07:20:53.488460Z", "last_updated_time": "2026-01-31T20:03:32.593153Z", "url": "https://connect.maton.ai/?session_token=...", "app": "google-ads", "metadata": {} } } ```
在浏览器中打开返回的 `url` 以完成 OAuth 授权。
### 删除连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 指定连接
如果您有多个 Google Ads 连接，请使用 `Maton-Connection` 头指定要使用的连接：
```bash python <<'EOF' import urllib.request, os, json data = json.dumps({'query': 'SELECT campaign.id, campaign.name FROM campaign'}).encode() req = urllib.request.Request('https://gateway.maton.ai/google-ads/v23/customers/1234567890/googleAds:search', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
如果省略，网关将使用默认（最早创建的）活动连接。
## API 参考
### 列出可访问的客户
```bash GET /google-ads/v23/customers:listAccessibleCustomers ```
### 搜索 (GAQL 查询)
```bash POST /google-ads/v23/customers/{customerId}/googleAds:search Content-Type: application/json
{ "query": "SELECT campaign.id, campaign.name, campaign.status FROM campaign ORDER BY campaign.id" } ```
### 搜索流 (用于大量结果)
```bash POST /google-ads/v23/customers/{customerId}/googleAds:searchStream Content-Type: application/json
{ "query": "SELECT campaign.id, campaign.name FROM campaign" } ```
## 常用 GAQL 查询
### 列出广告系列
```sql SELECT campaign.id, campaign.name, campaign.status, campaign.advertising_channel_type FROM campaign WHERE campaign.status != 'REMOVED' ORDER BY campaign.name ```
### 广告系列效果
```sql SELECT campaign.id, campaign.name, metrics.impressions, metrics.clicks, metrics.cost_micros, metrics.conversions FROM campaign WHERE segments.date DURING LAST_30_DAYS ORDER BY metrics.impressions DESC ```
### 列出广告组
```sql SELECT ad_group.id, ad_group.name, ad_group.status, campaign.id, campaign.name FROM ad_group WHERE ad_group.status != 'REMOVED' ```
### 列出关键字
```sql SELECT ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, metrics.impressions, metrics.clicks FROM keyword_view WHERE segments.date DURING LAST_30_DAYS ```
## 代码示例
### JavaScript
```javascript // Get customer IDs const customers = await fetch( 'https://gateway.maton.ai/google-ads/v23/customers:listAccessibleCustomers', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ).then(r => r.json());
// Query campaigns const campaigns = await fetch( `https://gateway.maton.ai/google-ads/v23/customers/${customerId}/googleAds:search`, { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${process.env.MATON_API_KEY}` }, body: JSON.stringify({ query: 'SELECT campaign.id, campaign.name FROM campaign' }) } ).then(r => r.json()); ```
### Python
```python import os import requests
headers = {'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'}
# Query campaigns response = requests.post( f'https://gateway.maton.ai/google-ads/v23/customers/{customer_id}/googleAds:search', headers=headers, json={'query': 'SELECT campaign.id, campaign.name FROM campaign'} ) ```
## 注意事项
- 首先使用 `listAccessibleCustomers` 获取客户 ID - 客户 ID 是 10 位数字（请去掉连字符） - 货币价值以微单位为单位（除以 1,000,000） - 日期范围：`LAST_7_DAYS`, `LAST_30_DAYS`, `THIS_MONTH` - 状态值：`ENABLED`, `PAUSED`, `REMOVED` - 重要：使用 curl 命令时，如果 URL 包含方括号（`fields[]`, `sort[]`, `records[]`），请使用 `curl -g` 以禁用 glob 解析 - 重要：当将 curl 输出通过管道传递给 `jq` 或其他命令时，某些 shell 环境可能无法正确展开 `$MATON_API_KEY` 等环境变量。通过管道传递时，您可能会收到“Invalid API key”错误。
## 错误处理
| Status | Meaning | |--------|---------| | 400 | 缺少 Google Ads 连接 | | 401 | 无效或缺少 Maton API 密钥 | | 429 | 速率受限 (每个账户 10 次/秒) | | 4xx/5xx | 来自 Google Ads API 的透传错误 |
### 故障排除：API 密钥问题
1. 检查是否设置了 `MATON_API_KEY` 环境变量：
```bash echo $MATON_API_KEY ```
2. 通过列出连接来验证 API 密钥是否有效：
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 故障排除：无效的应用名称
1. 确保您的 URL 路径以 `google-ads` 开头。例如：
- 正确：`https://gateway.maton.ai/google-ads/v23/customers:listAccessibleCustomers` - 错误：`https://gateway.maton.ai/v23/customers:listAccessibleCustomers`
## 资源
- [Google Ads API 概览](https://developers.google.com/google-ads/api/docs/start) - [GAQL 参考](https://developers.google.com/google-ads/api/docs/query/overview) - [指标参考](https://developers.google.com/google-ads/api/fields/v23/metrics) - [搜索](https://developers.google.com/google-ads/api/reference/rpc/v23/GoogleAdsService/Search) - [Maton 社区](https://discord.com/invite/dBfFAcefs2) - [Maton 支持](mailto:[email protected])