Google Ads
Query campaigns, ad groups, and performance metrics
Connect to Google Ads to list accessible accounts, list campaigns, view ad group details, get performance metrics, and run custom GAQL queries.
| Parameter | Type | Required | Description |
|---|
developerToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
customerIds | array | List of accessible customer IDs |
totalCount | number | Total number of accessible customer accounts |
| Parameter | Type | Required | Description |
|---|
customerId | string | Yes | No description |
developerToken | string | Yes | No description |
managerCustomerId | string | No | No description |
query | string | Yes | No description |
pageToken | string | No | No description |
| Parameter | Type | Description |
|---|
results | json | Array of result objects from the GAQL query |
totalResultsCount | number | Total number of matching results |
nextPageToken | string | Token for the next page of results |
| Parameter | Type | Required | Description |
|---|
customerId | string | Yes | No description |
developerToken | string | Yes | No description |
managerCustomerId | string | No | No description |
status | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
campaigns | array | List of campaigns in the account |
↳ id | string | Campaign ID |
↳ name | string | Campaign name |
↳ status | string | Campaign status (ENABLED, PAUSED, REMOVED) |
↳ channelType | string | Advertising channel type (SEARCH, DISPLAY, SHOPPING, VIDEO, PERFORMANCE_MAX) |
↳ startDate | string | Campaign start date (YYYY-MM-DD) |
↳ endDate | string | Campaign end date (YYYY-MM-DD) |
↳ budgetAmountMicros | string | Daily budget in micros (divide by 1,000,000 for currency value) |
totalCount | number | Total number of campaigns returned |
| Parameter | Type | Required | Description |
|---|
customerId | string | Yes | No description |
developerToken | string | Yes | No description |
managerCustomerId | string | No | No description |
campaignId | string | No | No description |
dateRange | string | No | Predefined date range (LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, TODAY, YESTERDAY) |
startDate | string | No | No description |
endDate | string | No | No description |
| Parameter | Type | Description |
|---|
campaigns | array | Campaign performance data broken down by date |
↳ id | string | Campaign ID |
↳ name | string | Campaign name |
↳ status | string | Campaign status |
↳ impressions | string | Number of impressions |
↳ clicks | string | Number of clicks |
↳ costMicros | string | Cost in micros (divide by 1,000,000 for currency value) |
↳ ctr | number | Click-through rate (0.0 to 1.0) |
↳ conversions | number | Number of conversions |
↳ date | string | Date for this row (YYYY-MM-DD) |
totalCount | number | Total number of result rows |
| Parameter | Type | Required | Description |
|---|
customerId | string | Yes | No description |
developerToken | string | Yes | No description |
managerCustomerId | string | No | No description |
campaignId | string | Yes | No description |
status | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
adGroups | array | List of ad groups in the campaign |
↳ id | string | Ad group ID |
↳ name | string | Ad group name |
↳ status | string | Ad group status (ENABLED, PAUSED, REMOVED) |
↳ type | string | Ad group type (SEARCH_STANDARD, DISPLAY_STANDARD, SHOPPING_PRODUCT_ADS) |
↳ campaignId | string | Parent campaign ID |
↳ campaignName | string | Parent campaign name |
totalCount | number | Total number of ad groups returned |
| Parameter | Type | Required | Description |
|---|
customerId | string | Yes | No description |
developerToken | string | Yes | No description |
managerCustomerId | string | No | No description |
campaignId | string | No | No description |
adGroupId | string | No | No description |
dateRange | string | No | Predefined date range (LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, TODAY, YESTERDAY) |
startDate | string | No | No description |
endDate | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
ads | array | Ad performance data broken down by date |
↳ adId | string | Ad ID |
↳ adGroupId | string | Parent ad group ID |
↳ adGroupName | string | Parent ad group name |
↳ campaignId | string | Parent campaign ID |
↳ campaignName | string | Parent campaign name |
↳ adType | string | Ad type (RESPONSIVE_SEARCH_AD, EXPANDED_TEXT_AD, etc.) |
↳ impressions | string | Number of impressions |
↳ clicks | string | Number of clicks |
↳ costMicros | string | Cost in micros (divide by 1,000,000 for currency value) |
↳ ctr | number | Click-through rate (0.0 to 1.0) |
↳ conversions | number | Number of conversions |
↳ date | string | Date for this row (YYYY-MM-DD) |
totalCount | number | Total number of result rows |
