AptlyStar

Google Ads

Query campaigns, ad groups, and performance metrics

Instructions d'utilisation

Connect to Google Ads to list accessible accounts, list campaigns, view ad group details, get performance metrics, and run custom GAQL queries.

Outils

List all Google Ads customer accounts accessible by the authenticated user

Entrée

ParamètreTypeObligatoireDescription
developerTokenstringOuiGoogle Ads API developer token

Sortie

ParamètreTypeDescription
customerIdsarrayList of accessible customer IDs
totalCountnumberTotal number of accessible customer accounts

Run a custom Google Ads Query Language (GAQL) query

Entrée

ParamètreTypeObligatoireDescription
customerIdstringOuiGoogle Ads customer ID (numeric, no dashes)
developerTokenstringOuiGoogle Ads API developer token
managerCustomerIdstringNonManager account customer ID (if accessing via manager account)
querystringOuiGAQL query to execute
pageTokenstringNonPage token for pagination

Sortie

ParamètreTypeDescription
resultsjsonArray of result objects from the GAQL query
totalResultsCountnumberTotal number of matching results
nextPageTokenstringToken for the next page of results

List campaigns in a Google Ads account with optional status filtering

Entrée

ParamètreTypeObligatoireDescription
customerIdstringOuiGoogle Ads customer ID (numeric, no dashes)
developerTokenstringOuiGoogle Ads API developer token
managerCustomerIdstringNonManager account customer ID (if accessing via manager account)
statusstringNonFilter by campaign status (ENABLED, PAUSED, REMOVED)
limitnumberNonMaximum number of campaigns to return

Sortie

ParamètreTypeDescription
campaignsarrayList of campaigns in the account
↳ idstringCampaign ID
↳ namestringCampaign name
↳ statusstringCampaign status (ENABLED, PAUSED, REMOVED)
↳ channelTypestringAdvertising channel type (SEARCH, DISPLAY, SHOPPING, VIDEO, PERFORMANCE_MAX)
↳ startDatestringCampaign start date (YYYY-MM-DD)
↳ endDatestringCampaign end date (YYYY-MM-DD)
↳ budgetAmountMicrosstringDaily budget in micros (divide by 1,000,000 for currency value)
totalCountnumberTotal number of campaigns returned

Get performance metrics for Google Ads campaigns over a date range

Entrée

ParamètreTypeObligatoireDescription
customerIdstringOuiGoogle Ads customer ID (numeric, no dashes)
developerTokenstringOuiGoogle Ads API developer token
managerCustomerIdstringNonManager account customer ID (if accessing via manager account)
campaignIdstringNonFilter by specific campaign ID
dateRangestringNonPredefined date range (LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, TODAY, YESTERDAY)
startDatestringNonCustom start date in YYYY-MM-DD format
endDatestringNonCustom end date in YYYY-MM-DD format

Sortie

ParamètreTypeDescription
campaignsarrayCampaign performance data broken down by date
↳ idstringCampaign ID
↳ namestringCampaign name
↳ statusstringCampaign status
↳ impressionsstringNumber of impressions
↳ clicksstringNumber of clicks
↳ costMicrosstringCost in micros (divide by 1,000,000 for currency value)
↳ ctrnumberClick-through rate (0.0 to 1.0)
↳ conversionsnumberNumber of conversions
↳ datestringDate for this row (YYYY-MM-DD)
totalCountnumberTotal number of result rows

List ad groups in a Google Ads campaign

Entrée

ParamètreTypeObligatoireDescription
customerIdstringOuiGoogle Ads customer ID (numeric, no dashes)
developerTokenstringOuiGoogle Ads API developer token
managerCustomerIdstringNonManager account customer ID (if accessing via manager account)
campaignIdstringOuiCampaign ID to list ad groups for
statusstringNonFilter by ad group status (ENABLED, PAUSED, REMOVED)
limitnumberNonMaximum number of ad groups to return

Sortie

ParamètreTypeDescription
adGroupsarrayList of ad groups in the campaign
↳ idstringAd group ID
↳ namestringAd group name
↳ statusstringAd group status (ENABLED, PAUSED, REMOVED)
↳ typestringAd group type (SEARCH_STANDARD, DISPLAY_STANDARD, SHOPPING_PRODUCT_ADS)
↳ campaignIdstringParent campaign ID
↳ campaignNamestringParent campaign name
totalCountnumberTotal number of ad groups returned

Get performance metrics for individual ads over a date range

Entrée

ParamètreTypeObligatoireDescription
customerIdstringOuiGoogle Ads customer ID (numeric, no dashes)
developerTokenstringOuiGoogle Ads API developer token
managerCustomerIdstringNonManager account customer ID (if accessing via manager account)
campaignIdstringNonFilter by campaign ID
adGroupIdstringNonFilter by ad group ID
dateRangestringNonPredefined date range (LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, TODAY, YESTERDAY)
startDatestringNonCustom start date in YYYY-MM-DD format
endDatestringNonCustom end date in YYYY-MM-DD format
limitnumberNonMaximum number of results to return

Sortie

ParamètreTypeDescription
adsarrayAd performance data broken down by date
↳ adIdstringAd ID
↳ adGroupIdstringParent ad group ID
↳ adGroupNamestringParent ad group name
↳ campaignIdstringParent campaign ID
↳ campaignNamestringParent campaign name
↳ adTypestringAd type (RESPONSIVE_SEARCH_AD, EXPANDED_TEXT_AD, etc.)
↳ impressionsstringNumber of impressions
↳ clicksstringNumber of clicks
↳ costMicrosstringCost in micros (divide by 1,000,000 for currency value)
↳ ctrnumberClick-through rate (0.0 to 1.0)
↳ conversionsnumberNumber of conversions
↳ datestringDate for this row (YYYY-MM-DD)
totalCountnumberTotal number of result rows

On this page