google-ads

# Google Ads Access the Google Ads API with managed OAuth authentication. Query campaigns, ad groups, keywords, and performance metrics using GAQL. ## Quick Start ```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 ``` ## Base URL ``` https://gateway.maton.ai/google-ads/{native-api-path} ``` Replace `{native-api-path}` with the actual Google Ads API endpoint path. The gateway proxies requests to `googleads.googleapis.com` and automatically injects OAuth and developer tokens. ## Authentication All requests require the Maton API key in the Authorization header: ``` Authorization: Bearer $MATON_API_KEY ``` **Environment Variable:** Set your API key as `MATON_API_KEY`: ```bash export MATON_API_KEY="YOUR_API_KEY" ``` ### Getting Your API Key 1. Sign in or create an account at [maton.ai](https://maton.ai) 2. Go to [maton.ai/settings](https://maton.ai/settings) 3. Copy your API key ## Connection Management Manage your Google Ads OAuth connections at `https://ctrl.maton.ai`. ### List Connections ```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 ``` ### Create Connection ```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 ``` ### Get Connection ```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 ``` **Response:** ```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": {} } } ``` Open the returned `url` in a browser to complete OAuth authorization. ### Delete Connection ```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 ``` ### Specifying Connection If you have multiple Google Ads connections, specify which one to use with the `Maton-Connection` header: ```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 ``` If omitted, the gateway uses the default (oldest) active connection. ## API Reference ### List Accessible Customers ```bash GET /google-ads/v23/customers:listAccessibleCustomers ``` ### Search (GAQL Query) ```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" } ``` ### Search Stream (for large results) ```bash POST /google-ads/v23/customers/{customerId}/googleAds:searchStream Content-Type: application/json { "query": "SELECT campaign.id, campaign.name FROM campaign" } ``` ## Common GAQL Queries ### List Campaigns ```sql SELECT campaign.id, campaign.name, campaign.status, campaign.advertising_channel_type FROM campaign WHERE campaign.status != 'REMOVED' ORDER BY campaign.name ``` ### Campaign Performance ```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 ``` ### List Ad Groups ```sql SELECT ad_group.id, ad_group.name, ad_group.status, campaign.id, campaign.name FROM ad_group WHERE ad_group.status != 'REMOVED' ``` ### List Keywords ```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 ``` ## Code Examples ### 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'} ) ``` ## Notes - Use `listAccessibleCustomers` first to get customer IDs - Customer IDs are 10-digit numbers (remove dashes) - Monetary values are in micros (divide by 1,000,000) - Date ranges: `LAST_7_DAYS`, `LAST_30_DAYS`, `THIS_MONTH` - Status values: `ENABLED`, `PAUSED`, `REMOVED` - IMPORTANT: When using curl commands, use `curl -g` when URLs contain brackets (`fields[]`, `sort[]`, `records[]`) to disable glob parsing - IMPORTANT: When piping curl output to `jq` or other commands, environment variables like `$MATON_API_KEY` may not expand correctly in some shell environments. You may get "Invalid API key" errors when piping. ## Error Handling | Status | Meaning | |--------|---------| | 400 | Missing Google Ads connection | | 401 | Invalid or missing Maton API key | | 429 | Rate limited (10 req/sec per account) | | 4xx/5xx | Passthrough error from Google Ads API | ### Troubleshooting: Invalid API Key **When you receive a "Invalid API key" error, ALWAYS follow these steps before concluding there is an issue:** 1. Check that the `MATON_API_KEY` environment variable is set: ```bash echo $MATON_API_KEY ``` 2. Verify the API key is valid by listing connections: ```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 ``` ## Resources - [Google Ads API Overview](https://developers.google.com/google-ads/api/docs/start) - [GAQL Reference](https://developers.google.com/google-ads/api/docs/query/overview) - [Metrics Reference](https://developers.google.com/google-ads/api/fields/v23/metrics) - [Search](https://developers.google.com/google-ads/api/reference/rpc/v23/GoogleAdsService/Search)