adloop 0.12.0__tar.gz → 0.13.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {adloop-0.12.0 → adloop-0.13.0}/PKG-INFO +46 -10
- {adloop-0.12.0 → adloop-0.13.0}/README.md +44 -8
- {adloop-0.12.0 → adloop-0.13.0}/pyproject.toml +2 -2
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/client.py +1 -1
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/forecast.py +34 -35
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/pmax.py +1 -1
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/write.py +47 -2
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/auth.py +80 -3
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/cli.py +203 -20
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/config.py +6 -0
- adloop-0.13.0/src/adloop/ga4/write.py +100 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/gsc/reports.py +10 -1
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/gtm/read.py +13 -1
- adloop-0.13.0/src/adloop/merchant/__init__.py +1 -0
- adloop-0.13.0/src/adloop/merchant/client.py +81 -0
- adloop-0.13.0/src/adloop/merchant/read.py +227 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/adloop.md +14 -1
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/safety/preview.py +5 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/server.py +168 -66
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/__main__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/_mcp_patches.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/currency.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/enums.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/gaql.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ads/read.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/crossref.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/diagnostics.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ga4/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ga4/client.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ga4/reports.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/ga4/tracking.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/gsc/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/gsc/client.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/gtm/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/gtm/client.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/pagespeed.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/commands/analyze-performance.md +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/commands/budget-plan.md +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/commands/create-ad.md +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/commands/create-campaign.md +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/commands/diagnose-tracking.md +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules/commands/optimize-campaign.md +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/rules_install.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/runtime.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/safety/__init__.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/safety/audit.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/safety/guards.py +0 -0
- {adloop-0.12.0 → adloop-0.13.0}/src/adloop/tracking.py +0 -0
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
Metadata-Version: 2.3
|
|
2
2
|
Name: adloop
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.13.0
|
|
4
4
|
Summary: The AI command center for Google Ads, GA4, and tracking code.
|
|
5
5
|
Keywords: mcp,google-ads,google-analytics,ga4,cursor,marketing
|
|
6
6
|
Author: Daniel Klose
|
|
7
7
|
Author-email: Daniel Klose <info@daniel-klose.com>
|
|
8
8
|
License: MIT
|
|
9
9
|
Requires-Dist: fastmcp>=3.0.0
|
|
10
|
-
Requires-Dist: google-ads>=
|
|
10
|
+
Requires-Dist: google-ads>=31.1.0
|
|
11
11
|
Requires-Dist: google-analytics-data>=0.20.0
|
|
12
12
|
Requires-Dist: google-analytics-admin>=0.27.0
|
|
13
13
|
Requires-Dist: google-api-python-client>=2.100.0
|
|
@@ -34,7 +34,7 @@ Description-Content-Type: text/markdown
|
|
|
34
34
|
[](LICENSE)
|
|
35
35
|
[](https://www.python.org/downloads/)
|
|
36
36
|
[](https://modelcontextprotocol.io)
|
|
37
|
-
[](https://developers.google.com/google-ads/api/docs/start)
|
|
38
38
|
[](https://developers.google.com/analytics/devguides/reporting/data/v1)
|
|
39
39
|
[](https://github.com/kLOsk/adloop)
|
|
40
40
|
|
|
@@ -45,13 +45,13 @@ An MCP server that gives your AI assistant read + write access to Google Ads and
|
|
|
45
45
|
</div>
|
|
46
46
|
|
|
47
47
|
> [!TIP]
|
|
48
|
-
> **[AdLoop Cloud](https://getadloop.com) is the hosted version of this project — live now, free during beta (limited seats).** Connect Google in two clicks and use the
|
|
48
|
+
> **[AdLoop Cloud](https://getadloop.com) is the hosted version of this project — live now, free during beta (limited seats).** Connect Google in two clicks and use the full toolset from claude.ai, ChatGPT, Claude Code, Cursor, or Gemini. No Google Cloud project, no developer token, no OAuth verification wait. EU-hosted, GDPR-first, DPA included.
|
|
49
49
|
|
|
50
50
|
---
|
|
51
51
|
|
|
52
52
|
## Cloud or Self-Hosted?
|
|
53
53
|
|
|
54
|
-
Both versions run the same
|
|
54
|
+
Both versions run the same tools with the same safety model. The difference is who handles the plumbing:
|
|
55
55
|
|
|
56
56
|
| | ☁️ [AdLoop Cloud](https://getadloop.com) | 🛠️ Self-hosted (this repo) |
|
|
57
57
|
|---|---|---|
|
|
@@ -89,7 +89,7 @@ Every tool exists because of an actual problem hit while running real Google Ads
|
|
|
89
89
|
|
|
90
90
|
The best features come from real workflows. If you're using AdLoop and find yourself wishing it could do something it can't, **open an issue describing your situation** — not just "add feature X" but "I was trying to do Y and couldn't because Z." The context matters more than the request.
|
|
91
91
|
|
|
92
|
-
## All
|
|
92
|
+
## All Tools
|
|
93
93
|
|
|
94
94
|
> **Quick start:** `pip install adloop` or `git clone https://github.com/kLOsk/adloop.git && cd adloop && uv sync && uv run adloop init` — or zero setup on [AdLoop Cloud](https://getadloop.com)
|
|
95
95
|
|
|
@@ -182,6 +182,15 @@ These tools read the live GTM container and join it with the codebase + GA4 to f
|
|
|
182
182
|
|------|-------------|
|
|
183
183
|
| `analyze_page_speed` | PageSpeed Insights for landing pages — Lighthouse score, Core Web Vitals, real-user CrUX data, top fixes. No OAuth needed (optional API key). |
|
|
184
184
|
|
|
185
|
+
### Merchant Center Tools
|
|
186
|
+
|
|
187
|
+
| Tool | What It Does |
|
|
188
|
+
|------|-------------|
|
|
189
|
+
| `list_merchant_accounts` | Discover accessible Merchant Center accounts |
|
|
190
|
+
| `get_merchant_feed_health` | Feed health — approved/pending/disapproved counts per reporting context, top product issues with docs, account-level issues. Disapprovals silently starve Shopping/PMax. |
|
|
191
|
+
|
|
192
|
+
> **Setup for Merchant Center tools** — Enable the **Merchant API** in your GCP project (the Content API for Shopping is deprecated). The Merchant API has no read-only scope; AdLoop uses it strictly read-only. Upgrading OAuth users re-authorize once.
|
|
193
|
+
|
|
185
194
|
> **Setup for GSC tools** — Enable the **Search Console API** in your GCP project. Upgrading OAuth users must re-authorize once for the new scope (delete `~/.adloop/token.json`, run any tool). The killer combo: cross-reference organic queries with `get_keyword_performance` to find paid/organic cannibalization and untapped keyword opportunities.
|
|
186
195
|
|
|
187
196
|
### Planning Tools
|
|
@@ -189,7 +198,7 @@ These tools read the live GTM container and join it with the codebase + GA4 to f
|
|
|
189
198
|
| Tool | What It Does |
|
|
190
199
|
|------|-------------|
|
|
191
200
|
| `discover_keywords` | Discover new keyword ideas from seed keywords and/or a URL — with optional per-month search history + seasonality insights (`include_monthly_volumes`) using Google Ads Keyword Planner. Returns avg monthly searches, competition level, and top-of-page bid range. |
|
|
192
|
-
| `estimate_budget` | Forecast clicks,
|
|
201
|
+
| `estimate_budget` | Forecast clicks, cost, and conversions for a set of keywords using Google Ads Keyword Planner. Supports geo/language targeting. Essential for budget planning before launching campaigns. |
|
|
193
202
|
|
|
194
203
|
### Google Ads Write Tools
|
|
195
204
|
|
|
@@ -208,6 +217,7 @@ All write operations follow a **draft → preview → confirm** workflow. Nothin
|
|
|
208
217
|
| `draft_keywords` | Propose keyword additions with match types. Proactively checks bidding strategy — blocks BROAD match on Manual CPC campaigns. |
|
|
209
218
|
| `add_negative_keywords` | Propose negative keywords directly on a campaign |
|
|
210
219
|
| `add_negative_locations` | Propose negative geo exclusions on a campaign — exclude cities/regions while keeping broader positive targets |
|
|
220
|
+
| `draft_key_event` | Mark a GA4 event as a key event (conversion) — the fix for "fires but isn't tracked as a conversion" |
|
|
211
221
|
| `draft_demographic_targeting` | Propose demographic criteria (age, gender, parental status, income) — exclusions by default |
|
|
212
222
|
| `propose_negative_keyword_list` | Draft a shared negative keyword list (SharedSet) and attach it to a campaign — reusable across multiple campaigns |
|
|
213
223
|
| `pause_entity` | Pause a campaign, ad group, ad, or keyword |
|
|
@@ -248,6 +258,7 @@ AdLoop manages real ad spend, so safety is not optional.
|
|
|
248
258
|
|
|
249
259
|
- **Two-step writes.** Every mutation returns a preview first. A separate `confirm_and_apply` call is required to execute.
|
|
250
260
|
- **Dry-run by default.** Even `confirm_and_apply` defaults to `dry_run=true`. Real changes require explicit `dry_run=false`.
|
|
261
|
+
- **Two-phase apply (optional).** With `safety.two_phase_apply: true`, `confirm_and_apply` refuses `dry_run=false` until the plan has completed one dry-run pass — preview-then-apply becomes server-enforced instead of a convention.
|
|
251
262
|
- **Budget caps.** Configurable maximum daily budget — the server rejects anything above the cap.
|
|
252
263
|
- **Audit log.** Every operation (including dry runs) is logged to `~/.adloop/audit.log`.
|
|
253
264
|
- **New campaigns and ads are PAUSED.** Nothing goes live without manual enablement.
|
|
@@ -296,8 +307,10 @@ The wizard walks you through:
|
|
|
296
307
|
3. **MCC Account ID** — your Manager Account ID (top bar in the MCC UI)
|
|
297
308
|
4. **OAuth sign-in** — opens a browser to sign in with Google (or prints a URL for headless servers)
|
|
298
309
|
5. **Auto-discovers your accounts** — finds your GA4 properties and Ads accounts automatically
|
|
299
|
-
6. **
|
|
300
|
-
7. **
|
|
310
|
+
6. **Optional services** — pin a GTM container, a Search Console property (both auto-discovered too), and a PageSpeed API key; skip any of them with Enter
|
|
311
|
+
7. **Safety defaults** — budget cap and dry-run preference
|
|
312
|
+
8. **Toolsets** — optionally expose only part of the tool catalog to your AI client (see [Toolsets](#toolsets--trim-the-context-footprint))
|
|
313
|
+
9. **Editor config snippets** — prints MCP configuration for both Cursor and Claude Code, including your toolset selection
|
|
301
314
|
|
|
302
315
|
### Requirements
|
|
303
316
|
|
|
@@ -431,14 +444,37 @@ All configuration lives in `~/.adloop/config.yaml`. See [`config.yaml.example`](
|
|
|
431
444
|
| `ads` | `login_customer_id` | — | Your MCC account ID |
|
|
432
445
|
| `safety` | `max_daily_budget` | `50.00` | Maximum allowed daily budget per campaign |
|
|
433
446
|
| `safety` | `require_dry_run` | `true` | Force all writes to dry-run mode |
|
|
447
|
+
| `safety` | `two_phase_apply` | `false` | Refuse real applies until the plan had a dry-run pass |
|
|
434
448
|
| `safety` | `blocked_operations` | `[]` | Operations to block entirely |
|
|
435
449
|
|
|
450
|
+
### Toolsets — trim the context footprint
|
|
451
|
+
|
|
452
|
+
Most MCP clients (claude.ai, ChatGPT, Cursor, …) load **every tool schema into the model's context at the start of every conversation**. AdLoop's full catalog costs roughly 18k tokens per session that way — paid before you type a word. If you only use part of AdLoop, expose a subset with the `ADLOOP_TOOLSETS` environment variable in your MCP client's `env` block (the `adloop init` wizard offers this and writes it into the snippets for you):
|
|
453
|
+
|
|
454
|
+
```json
|
|
455
|
+
"env": { "ADLOOP_TOOLSETS": "ads,ga4" }
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
| Toolset | Covers |
|
|
459
|
+
|---|---|
|
|
460
|
+
| `ads` | Google Ads reads, writes, and planning (Keyword Planner) |
|
|
461
|
+
| `ga4` | Google Analytics reports, realtime, key events |
|
|
462
|
+
| `tracking` | Cross-channel attribution + tracking code generation |
|
|
463
|
+
| `gtm` | Google Tag Manager audits and reads |
|
|
464
|
+
| `gsc` | Search Console reads |
|
|
465
|
+
| `web` | PageSpeed / Core Web Vitals |
|
|
466
|
+
| `merchant` | Merchant Center feed health |
|
|
467
|
+
|
|
468
|
+
`health_check` and `confirm_and_apply` are always included, whatever you select. Unset = the full catalog; unknown names fail at startup with the valid list. The effect is real: `ads,ga4` drops the session cost to ~13k tokens, and a `ga4`-only client pays ~2k — nearly 90% less. Toolsets are per *client*, not per install: one AdLoop config can serve a trimmed Cursor and a full-catalog Claude Code side by side.
|
|
469
|
+
|
|
470
|
+
On [AdLoop Cloud](https://getadloop.com), the same feature is per API key: pick toolsets when creating a key in the dashboard, and that key's tools/list is trimmed server-side for whichever AI client uses it.
|
|
471
|
+
|
|
436
472
|
## Project Structure
|
|
437
473
|
|
|
438
474
|
```
|
|
439
475
|
src/adloop/
|
|
440
476
|
├── __init__.py # Entry point — routes 'adloop init' to wizard, otherwise starts MCP server
|
|
441
|
-
├── server.py # FastMCP server —
|
|
477
|
+
├── server.py # FastMCP server — 67 tool registrations with safety annotations
|
|
442
478
|
├── config.py # Config loader (~/.adloop/config.yaml)
|
|
443
479
|
├── auth.py # OAuth 2.0 flow (user-supplied credentials, headless fallback) + service accounts; GA4 / Ads / GTM scopes
|
|
444
480
|
├── cli.py # Interactive 'adloop init' setup wizard
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
[](LICENSE)
|
|
9
9
|
[](https://www.python.org/downloads/)
|
|
10
10
|
[](https://modelcontextprotocol.io)
|
|
11
|
-
[](https://developers.google.com/google-ads/api/docs/start)
|
|
12
12
|
[](https://developers.google.com/analytics/devguides/reporting/data/v1)
|
|
13
13
|
[](https://github.com/kLOsk/adloop)
|
|
14
14
|
|
|
@@ -19,13 +19,13 @@ An MCP server that gives your AI assistant read + write access to Google Ads and
|
|
|
19
19
|
</div>
|
|
20
20
|
|
|
21
21
|
> [!TIP]
|
|
22
|
-
> **[AdLoop Cloud](https://getadloop.com) is the hosted version of this project — live now, free during beta (limited seats).** Connect Google in two clicks and use the
|
|
22
|
+
> **[AdLoop Cloud](https://getadloop.com) is the hosted version of this project — live now, free during beta (limited seats).** Connect Google in two clicks and use the full toolset from claude.ai, ChatGPT, Claude Code, Cursor, or Gemini. No Google Cloud project, no developer token, no OAuth verification wait. EU-hosted, GDPR-first, DPA included.
|
|
23
23
|
|
|
24
24
|
---
|
|
25
25
|
|
|
26
26
|
## Cloud or Self-Hosted?
|
|
27
27
|
|
|
28
|
-
Both versions run the same
|
|
28
|
+
Both versions run the same tools with the same safety model. The difference is who handles the plumbing:
|
|
29
29
|
|
|
30
30
|
| | ☁️ [AdLoop Cloud](https://getadloop.com) | 🛠️ Self-hosted (this repo) |
|
|
31
31
|
|---|---|---|
|
|
@@ -63,7 +63,7 @@ Every tool exists because of an actual problem hit while running real Google Ads
|
|
|
63
63
|
|
|
64
64
|
The best features come from real workflows. If you're using AdLoop and find yourself wishing it could do something it can't, **open an issue describing your situation** — not just "add feature X" but "I was trying to do Y and couldn't because Z." The context matters more than the request.
|
|
65
65
|
|
|
66
|
-
## All
|
|
66
|
+
## All Tools
|
|
67
67
|
|
|
68
68
|
> **Quick start:** `pip install adloop` or `git clone https://github.com/kLOsk/adloop.git && cd adloop && uv sync && uv run adloop init` — or zero setup on [AdLoop Cloud](https://getadloop.com)
|
|
69
69
|
|
|
@@ -156,6 +156,15 @@ These tools read the live GTM container and join it with the codebase + GA4 to f
|
|
|
156
156
|
|------|-------------|
|
|
157
157
|
| `analyze_page_speed` | PageSpeed Insights for landing pages — Lighthouse score, Core Web Vitals, real-user CrUX data, top fixes. No OAuth needed (optional API key). |
|
|
158
158
|
|
|
159
|
+
### Merchant Center Tools
|
|
160
|
+
|
|
161
|
+
| Tool | What It Does |
|
|
162
|
+
|------|-------------|
|
|
163
|
+
| `list_merchant_accounts` | Discover accessible Merchant Center accounts |
|
|
164
|
+
| `get_merchant_feed_health` | Feed health — approved/pending/disapproved counts per reporting context, top product issues with docs, account-level issues. Disapprovals silently starve Shopping/PMax. |
|
|
165
|
+
|
|
166
|
+
> **Setup for Merchant Center tools** — Enable the **Merchant API** in your GCP project (the Content API for Shopping is deprecated). The Merchant API has no read-only scope; AdLoop uses it strictly read-only. Upgrading OAuth users re-authorize once.
|
|
167
|
+
|
|
159
168
|
> **Setup for GSC tools** — Enable the **Search Console API** in your GCP project. Upgrading OAuth users must re-authorize once for the new scope (delete `~/.adloop/token.json`, run any tool). The killer combo: cross-reference organic queries with `get_keyword_performance` to find paid/organic cannibalization and untapped keyword opportunities.
|
|
160
169
|
|
|
161
170
|
### Planning Tools
|
|
@@ -163,7 +172,7 @@ These tools read the live GTM container and join it with the codebase + GA4 to f
|
|
|
163
172
|
| Tool | What It Does |
|
|
164
173
|
|------|-------------|
|
|
165
174
|
| `discover_keywords` | Discover new keyword ideas from seed keywords and/or a URL — with optional per-month search history + seasonality insights (`include_monthly_volumes`) using Google Ads Keyword Planner. Returns avg monthly searches, competition level, and top-of-page bid range. |
|
|
166
|
-
| `estimate_budget` | Forecast clicks,
|
|
175
|
+
| `estimate_budget` | Forecast clicks, cost, and conversions for a set of keywords using Google Ads Keyword Planner. Supports geo/language targeting. Essential for budget planning before launching campaigns. |
|
|
167
176
|
|
|
168
177
|
### Google Ads Write Tools
|
|
169
178
|
|
|
@@ -182,6 +191,7 @@ All write operations follow a **draft → preview → confirm** workflow. Nothin
|
|
|
182
191
|
| `draft_keywords` | Propose keyword additions with match types. Proactively checks bidding strategy — blocks BROAD match on Manual CPC campaigns. |
|
|
183
192
|
| `add_negative_keywords` | Propose negative keywords directly on a campaign |
|
|
184
193
|
| `add_negative_locations` | Propose negative geo exclusions on a campaign — exclude cities/regions while keeping broader positive targets |
|
|
194
|
+
| `draft_key_event` | Mark a GA4 event as a key event (conversion) — the fix for "fires but isn't tracked as a conversion" |
|
|
185
195
|
| `draft_demographic_targeting` | Propose demographic criteria (age, gender, parental status, income) — exclusions by default |
|
|
186
196
|
| `propose_negative_keyword_list` | Draft a shared negative keyword list (SharedSet) and attach it to a campaign — reusable across multiple campaigns |
|
|
187
197
|
| `pause_entity` | Pause a campaign, ad group, ad, or keyword |
|
|
@@ -222,6 +232,7 @@ AdLoop manages real ad spend, so safety is not optional.
|
|
|
222
232
|
|
|
223
233
|
- **Two-step writes.** Every mutation returns a preview first. A separate `confirm_and_apply` call is required to execute.
|
|
224
234
|
- **Dry-run by default.** Even `confirm_and_apply` defaults to `dry_run=true`. Real changes require explicit `dry_run=false`.
|
|
235
|
+
- **Two-phase apply (optional).** With `safety.two_phase_apply: true`, `confirm_and_apply` refuses `dry_run=false` until the plan has completed one dry-run pass — preview-then-apply becomes server-enforced instead of a convention.
|
|
225
236
|
- **Budget caps.** Configurable maximum daily budget — the server rejects anything above the cap.
|
|
226
237
|
- **Audit log.** Every operation (including dry runs) is logged to `~/.adloop/audit.log`.
|
|
227
238
|
- **New campaigns and ads are PAUSED.** Nothing goes live without manual enablement.
|
|
@@ -270,8 +281,10 @@ The wizard walks you through:
|
|
|
270
281
|
3. **MCC Account ID** — your Manager Account ID (top bar in the MCC UI)
|
|
271
282
|
4. **OAuth sign-in** — opens a browser to sign in with Google (or prints a URL for headless servers)
|
|
272
283
|
5. **Auto-discovers your accounts** — finds your GA4 properties and Ads accounts automatically
|
|
273
|
-
6. **
|
|
274
|
-
7. **
|
|
284
|
+
6. **Optional services** — pin a GTM container, a Search Console property (both auto-discovered too), and a PageSpeed API key; skip any of them with Enter
|
|
285
|
+
7. **Safety defaults** — budget cap and dry-run preference
|
|
286
|
+
8. **Toolsets** — optionally expose only part of the tool catalog to your AI client (see [Toolsets](#toolsets--trim-the-context-footprint))
|
|
287
|
+
9. **Editor config snippets** — prints MCP configuration for both Cursor and Claude Code, including your toolset selection
|
|
275
288
|
|
|
276
289
|
### Requirements
|
|
277
290
|
|
|
@@ -405,14 +418,37 @@ All configuration lives in `~/.adloop/config.yaml`. See [`config.yaml.example`](
|
|
|
405
418
|
| `ads` | `login_customer_id` | — | Your MCC account ID |
|
|
406
419
|
| `safety` | `max_daily_budget` | `50.00` | Maximum allowed daily budget per campaign |
|
|
407
420
|
| `safety` | `require_dry_run` | `true` | Force all writes to dry-run mode |
|
|
421
|
+
| `safety` | `two_phase_apply` | `false` | Refuse real applies until the plan had a dry-run pass |
|
|
408
422
|
| `safety` | `blocked_operations` | `[]` | Operations to block entirely |
|
|
409
423
|
|
|
424
|
+
### Toolsets — trim the context footprint
|
|
425
|
+
|
|
426
|
+
Most MCP clients (claude.ai, ChatGPT, Cursor, …) load **every tool schema into the model's context at the start of every conversation**. AdLoop's full catalog costs roughly 18k tokens per session that way — paid before you type a word. If you only use part of AdLoop, expose a subset with the `ADLOOP_TOOLSETS` environment variable in your MCP client's `env` block (the `adloop init` wizard offers this and writes it into the snippets for you):
|
|
427
|
+
|
|
428
|
+
```json
|
|
429
|
+
"env": { "ADLOOP_TOOLSETS": "ads,ga4" }
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
| Toolset | Covers |
|
|
433
|
+
|---|---|
|
|
434
|
+
| `ads` | Google Ads reads, writes, and planning (Keyword Planner) |
|
|
435
|
+
| `ga4` | Google Analytics reports, realtime, key events |
|
|
436
|
+
| `tracking` | Cross-channel attribution + tracking code generation |
|
|
437
|
+
| `gtm` | Google Tag Manager audits and reads |
|
|
438
|
+
| `gsc` | Search Console reads |
|
|
439
|
+
| `web` | PageSpeed / Core Web Vitals |
|
|
440
|
+
| `merchant` | Merchant Center feed health |
|
|
441
|
+
|
|
442
|
+
`health_check` and `confirm_and_apply` are always included, whatever you select. Unset = the full catalog; unknown names fail at startup with the valid list. The effect is real: `ads,ga4` drops the session cost to ~13k tokens, and a `ga4`-only client pays ~2k — nearly 90% less. Toolsets are per *client*, not per install: one AdLoop config can serve a trimmed Cursor and a full-catalog Claude Code side by side.
|
|
443
|
+
|
|
444
|
+
On [AdLoop Cloud](https://getadloop.com), the same feature is per API key: pick toolsets when creating a key in the dashboard, and that key's tools/list is trimmed server-side for whichever AI client uses it.
|
|
445
|
+
|
|
410
446
|
## Project Structure
|
|
411
447
|
|
|
412
448
|
```
|
|
413
449
|
src/adloop/
|
|
414
450
|
├── __init__.py # Entry point — routes 'adloop init' to wizard, otherwise starts MCP server
|
|
415
|
-
├── server.py # FastMCP server —
|
|
451
|
+
├── server.py # FastMCP server — 67 tool registrations with safety annotations
|
|
416
452
|
├── config.py # Config loader (~/.adloop/config.yaml)
|
|
417
453
|
├── auth.py # OAuth 2.0 flow (user-supplied credentials, headless fallback) + service accounts; GA4 / Ads / GTM scopes
|
|
418
454
|
├── cli.py # Interactive 'adloop init' setup wizard
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "adloop"
|
|
3
|
-
version = "0.
|
|
3
|
+
version = "0.13.0"
|
|
4
4
|
description = "The AI command center for Google Ads, GA4, and tracking code."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
authors = [
|
|
@@ -11,7 +11,7 @@ license = { text = "MIT" }
|
|
|
11
11
|
keywords = ["mcp", "google-ads", "google-analytics", "ga4", "cursor", "marketing"]
|
|
12
12
|
dependencies = [
|
|
13
13
|
"fastmcp>=3.0.0",
|
|
14
|
-
"google-ads>=
|
|
14
|
+
"google-ads>=31.1.0",
|
|
15
15
|
"google-analytics-data>=0.20.0",
|
|
16
16
|
"google-analytics-admin>=0.27.0",
|
|
17
17
|
"google-api-python-client>=2.100.0",
|
|
@@ -16,7 +16,7 @@ if TYPE_CHECKING:
|
|
|
16
16
|
# Pin the API version so library upgrades don't silently break field names,
|
|
17
17
|
# enum values, or mutate operation structures. Bump this deliberately when
|
|
18
18
|
# migrating to a new API version — never let it float to the library default.
|
|
19
|
-
GOOGLE_ADS_API_VERSION = "
|
|
19
|
+
GOOGLE_ADS_API_VERSION = "v24"
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
def get_ads_client(config: AdLoopConfig) -> GoogleAdsClient:
|
|
@@ -22,13 +22,16 @@ def estimate_budget(
|
|
|
22
22
|
forecast_days: int = 30,
|
|
23
23
|
customer_id: str = "",
|
|
24
24
|
) -> dict:
|
|
25
|
-
"""Forecast clicks,
|
|
25
|
+
"""Forecast clicks, cost, and conversions for a set of keywords.
|
|
26
26
|
|
|
27
27
|
Uses KeywordPlanIdeaService.GenerateKeywordForecastMetrics to estimate
|
|
28
28
|
campaign performance without creating anything. Useful for budget planning
|
|
29
29
|
before launching a new campaign.
|
|
30
30
|
|
|
31
31
|
keywords: list of {"text": str, "match_type": "EXACT|PHRASE|BROAD", "max_cpc": float (optional)}
|
|
32
|
+
Since Ads API v24 the forecast takes no per-keyword bids — the
|
|
33
|
+
highest max_cpc across the list becomes the campaign-level manual
|
|
34
|
+
CPC cap.
|
|
32
35
|
geo_target_id: geo target constant (2276=Germany, 2840=USA, 2826=UK, 2250=France)
|
|
33
36
|
language_id: language constant (1000=English, 1001=German, 1002=French, 1003=Spanish)
|
|
34
37
|
forecast_days: number of days to forecast (default 30)
|
|
@@ -45,9 +48,6 @@ def estimate_budget(
|
|
|
45
48
|
kp_service = client.get_service("KeywordPlanIdeaService")
|
|
46
49
|
|
|
47
50
|
campaign = client.get_type("CampaignToForecast")
|
|
48
|
-
campaign.keyword_plan_network = (
|
|
49
|
-
client.enums.KeywordPlanNetworkEnum.GOOGLE_SEARCH
|
|
50
|
-
)
|
|
51
51
|
|
|
52
52
|
max_bid = max(
|
|
53
53
|
(int(kw.get("max_cpc", 0) * 1_000_000) for kw in keywords),
|
|
@@ -57,11 +57,9 @@ def estimate_budget(
|
|
|
57
57
|
max_bid = _DEFAULT_MAX_CPC_MICROS
|
|
58
58
|
campaign.bidding_strategy.manual_cpc_bidding_strategy.max_cpc_bid_micros = max_bid
|
|
59
59
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
geo_target_id
|
|
60
|
+
campaign.geo_target_constants.append(
|
|
61
|
+
googleads_service.geo_target_constant_path(geo_target_id)
|
|
63
62
|
)
|
|
64
|
-
campaign.geo_modifiers.append(geo_modifier)
|
|
65
63
|
|
|
66
64
|
campaign.language_constants.append(
|
|
67
65
|
googleads_service.language_constant_path(language_id)
|
|
@@ -74,15 +72,13 @@ def estimate_budget(
|
|
|
74
72
|
if not text:
|
|
75
73
|
continue
|
|
76
74
|
match_type = kw.get("match_type", "BROAD").upper()
|
|
77
|
-
cpc_micros = int(kw.get("max_cpc", 0) * 1_000_000) or _DEFAULT_MAX_CPC_MICROS
|
|
78
75
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
biddable.keyword.match_type = getattr(
|
|
76
|
+
keyword = client.get_type("KeywordInfo")
|
|
77
|
+
keyword.text = text
|
|
78
|
+
keyword.match_type = getattr(
|
|
83
79
|
client.enums.KeywordMatchTypeEnum, match_type, client.enums.KeywordMatchTypeEnum.BROAD
|
|
84
80
|
)
|
|
85
|
-
ad_group.
|
|
81
|
+
ad_group.keywords.append(keyword)
|
|
86
82
|
|
|
87
83
|
campaign.ad_groups.append(ad_group)
|
|
88
84
|
|
|
@@ -98,29 +94,29 @@ def estimate_budget(
|
|
|
98
94
|
response = kp_service.generate_keyword_forecast_metrics(request=request)
|
|
99
95
|
metrics = response.campaign_forecast_metrics
|
|
100
96
|
|
|
101
|
-
# KeywordForecastMetrics fields are ``optional
|
|
102
|
-
#
|
|
103
|
-
#
|
|
97
|
+
# KeywordForecastMetrics fields are ``optional``, so the SDK returns
|
|
98
|
+
# ``None`` for unset fields and the actual number (including 0)
|
|
99
|
+
# otherwise. Falsy checks like ``int(v) if v else None`` would
|
|
104
100
|
# silently map a real 0-click or 0-cost forecast to None and the
|
|
105
101
|
# caller couldn't tell "no data" apart from "data says zero" — same
|
|
106
102
|
# bug class as discover_keywords (issue Bug 2). Use ``is not None``
|
|
107
103
|
# throughout and the shared ``_micros_to_currency`` helper for the
|
|
108
104
|
# micros→currency conversions.
|
|
105
|
+
# v24 dropped impressions/click_through_rate from the forecast and
|
|
106
|
+
# added conversions/average_cpa_micros.
|
|
109
107
|
clicks = getattr(metrics, "clicks", None)
|
|
110
|
-
impressions = getattr(metrics, "impressions", None)
|
|
111
108
|
avg_cpc_micros = getattr(metrics, "average_cpc_micros", None)
|
|
112
109
|
cost_micros = getattr(metrics, "cost_micros", None)
|
|
113
|
-
|
|
110
|
+
conversions = getattr(metrics, "conversions", None)
|
|
111
|
+
avg_cpa_micros = getattr(metrics, "average_cpa_micros", None)
|
|
114
112
|
|
|
115
113
|
total_cost = _micros_to_currency(cost_micros)
|
|
116
114
|
avg_cpc = _micros_to_currency(avg_cpc_micros)
|
|
115
|
+
avg_cpa = _micros_to_currency(avg_cpa_micros)
|
|
117
116
|
|
|
118
117
|
days = max(forecast_days, 1)
|
|
119
118
|
daily = {
|
|
120
119
|
"clicks": round(clicks / days, 1) if clicks is not None else None,
|
|
121
|
-
"impressions": (
|
|
122
|
-
round(impressions / days, 1) if impressions is not None else None
|
|
123
|
-
),
|
|
124
120
|
"cost": round(total_cost / days, 2) if total_cost is not None else None,
|
|
125
121
|
}
|
|
126
122
|
|
|
@@ -147,15 +143,16 @@ def estimate_budget(
|
|
|
147
143
|
f"most available traffic (estimated daily cost: {daily['cost']:.2f})."
|
|
148
144
|
)
|
|
149
145
|
|
|
150
|
-
if
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
146
|
+
if clicks is not None and clicks == 0:
|
|
147
|
+
insights.append(
|
|
148
|
+
"Forecast shows zero clicks — keywords may be too niche, too "
|
|
149
|
+
"generic, or the max CPC too low for competitive positions."
|
|
150
|
+
)
|
|
151
|
+
|
|
152
|
+
if conversions is not None and conversions > 0 and avg_cpa is not None:
|
|
156
153
|
insights.append(
|
|
157
|
-
"
|
|
158
|
-
"
|
|
154
|
+
f"Estimated {conversions:.1f} conversions at ~{avg_cpa:.2f} avg "
|
|
155
|
+
f"CPA (based on historical conversion rates for these keywords)."
|
|
159
156
|
)
|
|
160
157
|
|
|
161
158
|
return {
|
|
@@ -164,10 +161,12 @@ def estimate_budget(
|
|
|
164
161
|
"end": end_date.isoformat(),
|
|
165
162
|
},
|
|
166
163
|
"estimated_clicks": clicks,
|
|
167
|
-
"estimated_impressions": impressions,
|
|
168
164
|
"estimated_cost": total_cost,
|
|
169
165
|
"estimated_avg_cpc": avg_cpc,
|
|
170
|
-
"
|
|
166
|
+
"estimated_conversions": (
|
|
167
|
+
round(conversions, 1) if conversions is not None else None
|
|
168
|
+
),
|
|
169
|
+
"estimated_avg_cpa": avg_cpa,
|
|
171
170
|
"daily_estimates": daily,
|
|
172
171
|
"keywords_used": len([kw for kw in keywords if kw.get("text")]),
|
|
173
172
|
"insights": insights,
|
|
@@ -227,7 +226,7 @@ def _build_keyword_ideas_rest_body(
|
|
|
227
226
|
) -> dict:
|
|
228
227
|
"""Build the JSON body for the REST generateKeywordIdeas endpoint.
|
|
229
228
|
|
|
230
|
-
Schema follows google-ads REST
|
|
229
|
+
Schema follows google-ads REST v24 (camelCase). Exactly one of
|
|
231
230
|
``keywordSeed`` / ``urlSeed`` / ``keywordAndUrlSeed`` is set based on
|
|
232
231
|
which inputs were provided.
|
|
233
232
|
"""
|
|
@@ -255,7 +254,7 @@ def _post_keyword_ideas_rest_page(
|
|
|
255
254
|
|
|
256
255
|
Issue #37: ``KeywordPlanIdeaService.GenerateKeywordIdeas`` over gRPC sits
|
|
257
256
|
in a tight quota bucket that exhausts after a small number of sequential
|
|
258
|
-
calls and returns ``RESOURCE_EXHAUSTED`` regardless of QPS. The REST
|
|
257
|
+
calls and returns ``RESOURCE_EXHAUSTED`` regardless of QPS. The REST
|
|
259
258
|
endpoint for the same method lives in a separate, much larger quota
|
|
260
259
|
bucket, so this swap eliminates the 429s that made ``discover_keywords``
|
|
261
260
|
unusable for any multi-geo or repeat-call workflow. Filed against
|
|
@@ -389,7 +388,7 @@ def discover_keywords(
|
|
|
389
388
|
seasonality insight — the "Google Trends" view for keyword demand.
|
|
390
389
|
|
|
391
390
|
Network: this tool intentionally bypasses the google-ads gRPC client for
|
|
392
|
-
KeywordPlanIdeaService and calls the
|
|
391
|
+
KeywordPlanIdeaService and calls the versioned REST endpoint directly. The
|
|
393
392
|
gRPC quota bucket for this single method exhausts almost immediately
|
|
394
393
|
under sequential single-geo calls (issue #37); REST sits in a separate,
|
|
395
394
|
much larger bucket and works without issue. All other Ads tools still
|
|
@@ -121,7 +121,7 @@ def get_asset_performance(
|
|
|
121
121
|
content. ``primary_status`` shows whether the asset is eligible to serve
|
|
122
122
|
(ELIGIBLE, NOT_ELIGIBLE, PAUSED, PENDING).
|
|
123
123
|
|
|
124
|
-
Note: the Google Ads API
|
|
124
|
+
Note: the Google Ads API does not expose per-asset performance labels
|
|
125
125
|
(BEST/GOOD/LOW) for PMax assets via GAQL. Use ``get_detailed_asset_performance``
|
|
126
126
|
to see which asset *combinations* Google selects most — that's the closest
|
|
127
127
|
proxy for individual asset quality.
|
|
@@ -1789,7 +1789,7 @@ def confirm_and_apply(
|
|
|
1789
1789
|
to make real changes.
|
|
1790
1790
|
"""
|
|
1791
1791
|
from adloop.safety.audit import log_mutation
|
|
1792
|
-
from adloop.safety.preview import get_plan, remove_plan
|
|
1792
|
+
from adloop.safety.preview import get_plan, remove_plan, store_plan
|
|
1793
1793
|
|
|
1794
1794
|
plan = get_plan(plan_id)
|
|
1795
1795
|
if plan is None:
|
|
@@ -1813,6 +1813,17 @@ def confirm_and_apply(
|
|
|
1813
1813
|
dry_run=True,
|
|
1814
1814
|
result="dry_run_success",
|
|
1815
1815
|
)
|
|
1816
|
+
if plan.dry_run_result is None:
|
|
1817
|
+
# Persist the dry-run pass on the plan; two-phase apply checks
|
|
1818
|
+
# this marker before allowing a real write. Re-storing
|
|
1819
|
+
# overwrites the pending plan (PlanStore.store is an upsert).
|
|
1820
|
+
from datetime import datetime, timezone
|
|
1821
|
+
|
|
1822
|
+
plan.dry_run_result = {
|
|
1823
|
+
"status": "DRY_RUN_SUCCESS",
|
|
1824
|
+
"at": datetime.now(timezone.utc).isoformat(),
|
|
1825
|
+
}
|
|
1826
|
+
store_plan(plan)
|
|
1816
1827
|
response = {
|
|
1817
1828
|
"status": "DRY_RUN_SUCCESS",
|
|
1818
1829
|
"plan_id": plan.plan_id,
|
|
@@ -1848,6 +1859,33 @@ def confirm_and_apply(
|
|
|
1848
1859
|
)
|
|
1849
1860
|
return response
|
|
1850
1861
|
|
|
1862
|
+
if config.safety.two_phase_apply and plan.dry_run_result is None:
|
|
1863
|
+
# Server-enforced two-phase apply: the preview→confirm flow is a
|
|
1864
|
+
# protocol requirement here, not a convention the calling agent
|
|
1865
|
+
# can skip. Refuse, log the refusal, and keep the plan pending.
|
|
1866
|
+
log_mutation(
|
|
1867
|
+
config.safety.log_file,
|
|
1868
|
+
operation=plan.operation,
|
|
1869
|
+
customer_id=plan.customer_id,
|
|
1870
|
+
entity_type=plan.entity_type,
|
|
1871
|
+
entity_id=plan.entity_id,
|
|
1872
|
+
changes=plan.changes,
|
|
1873
|
+
dry_run=False,
|
|
1874
|
+
result="refused_two_phase",
|
|
1875
|
+
)
|
|
1876
|
+
return {
|
|
1877
|
+
"status": "DRY_RUN_REQUIRED",
|
|
1878
|
+
"plan_id": plan.plan_id,
|
|
1879
|
+
"operation": plan.operation,
|
|
1880
|
+
"message": (
|
|
1881
|
+
f"No changes were made: two-phase apply is enabled and plan "
|
|
1882
|
+
f"'{plan.plan_id}' has not completed a dry run yet. Call "
|
|
1883
|
+
f"confirm_and_apply with dry_run=true once, show the result "
|
|
1884
|
+
f"to the user and get their approval, then call again with "
|
|
1885
|
+
f"dry_run=false — that second call will succeed."
|
|
1886
|
+
),
|
|
1887
|
+
}
|
|
1888
|
+
|
|
1851
1889
|
try:
|
|
1852
1890
|
result = _execute_plan(config, plan)
|
|
1853
1891
|
except Exception as e:
|
|
@@ -2520,9 +2558,16 @@ def _extract_resource_name(resp: object) -> str:
|
|
|
2520
2558
|
|
|
2521
2559
|
|
|
2522
2560
|
def _execute_plan(config: AdLoopConfig, plan: object) -> dict:
|
|
2523
|
-
"""Dispatch to the right Google
|
|
2561
|
+
"""Dispatch to the right Google API call based on plan.operation."""
|
|
2524
2562
|
from adloop.ads.client import get_ads_client, normalize_customer_id
|
|
2525
2563
|
|
|
2564
|
+
# GA4 plans dispatch before Ads client construction so they work for
|
|
2565
|
+
# GA4-only setups (no Ads credentials/developer token required).
|
|
2566
|
+
if plan.operation == "create_key_event":
|
|
2567
|
+
from adloop.ga4.write import _apply_create_key_event
|
|
2568
|
+
|
|
2569
|
+
return _apply_create_key_event(config, plan.changes)
|
|
2570
|
+
|
|
2526
2571
|
client = get_ads_client(config)
|
|
2527
2572
|
cid = normalize_customer_id(plan.customer_id)
|
|
2528
2573
|
|