Performance metrics and configuration attributes for campaigns.
This report can only be returned by an asynchronous request (that is, via the Reports.request() method).
Request excerpt
Send a regular Reports.request()
request body, but specify "reportType": "campaign"
.
{ ... "reportType": "campaign", "columns": [ { "columnName": string , "headerText": string , "startDate": string , "endDate": string } ], "filters": [ { "column": { "columnName": string , }, ... }, ... ], ... }
For each column that you want returned or filtered in the report,
specify the columnName
listed in the table below.
You can also optionally specify headerText
, startDate
,
and endDate
.
Note that some columns cannot be filtered; refer to "Filterable" in the table below.
columnName
|
Description | Behavior | Type | Filterable |
|---|---|---|---|---|
status
|
An alias for the campaignStatus
attribute. |
attribute | Status
|
Yes |
engineStatus
|
Additional status of the campaign in the external engine account. Possible statuses (depending on the type of external account) include disapproved
, budget constrained
, etc. |
attribute | String
|
Yes |
creationTimestamp
|
Timestamp of the campaign's creation, formatted in ISO 8601. | attribute | Timestamp
|
Yes |
lastModifiedTimestamp
|
Timestamp of the campaign's most recent modification, formatted in ISO 8601. | attribute | Timestamp
|
Yes |
agency
|
Agency name. | attribute | String
|
Yes |
agencyId
|
DS agency ID. | attribute | ID
|
Yes |
advertiser
|
Advertiser name. | attribute | String
|
Yes |
advertiserId
|
DS advertiser ID. | attribute | ID
|
Yes |
account
|
Engine account name. | attribute | String
|
Yes |
accountId
|
DS engine account ID. | attribute | ID
|
Yes |
accountEngineId
|
ID of the account in the external engine account. | attribute | String
|
Yes |
accountType
|
Engine account type: Google AdWords
, Bing Ads
, Yahoo Japan Listing Ads
, Yahoo Search Marketing
, Yahoo Gemini
, Baidu
, or Comparison Shopping
. |
attribute | Engine type
|
Yes |
campaign
|
Campaign name. | attribute | String
|
Yes |
campaignId
|
DS campaign ID. | attribute | ID
|
Yes |
campaignStatus
|
The status of the campaign: Active
, Paused
, or Removed
. Note that campaigns, ad groups, keywords, ads, and targets each have their own status. See status
. |
attribute | Status
|
Yes |
campaignEngineId
|
ID of the campaign in the external engine account. | attribute | ID
|
Yes |
campaignStartDate
|
Start date of the campaign. | attribute | Date
|
Yes |
campaignEndDate
|
End date of the campaign. | attribute | Date
|
Yes |
bingAdsBudgetType
|
How budget is controlled for Bing Ads campaigns: Daily budget
, Monthly even spend
, Monthly accelerated spend
, Daily accelerated spend
, or Daily even spend
. |
attribute | Microsoft Advertising budget type
|
Yes |
dailyBudget
|
Daily budget of the campaign. | attribute | Money
|
Yes |
monthlyBudget
|
Monthly budget of the campaign. | attribute | Money
|
Yes |
deliveryMethod
|
Budget delivery method of the campaign: Standard
or Accelerated
. |
attribute | Budget delivery method
|
Yes |
adWordsBidStrategy
|
The bid strategy Google Ads uses for this campaign: Manual cpc
, Manual cpm
, Percent cpa
, Budget optimizer
, or Conversion optimizer
. Campaigns using DS bid strategies are set to Manual cpc
or Manual cpm
. |
attribute | AdWords bid strategy
|
Yes |
yahooJapanBidStrategy
|
The bid strategy Yahoo! JAPAN uses for this campaign: Manual cpc
or Budget optimizer
. Campaigns using DS bid strategies are set to Manual cpc
. |
attribute | Yahoo! JAPAN bid strategy
|
Yes |
keywordNearMatchEnabled
|
Whether keyword near match is enabled for the campaign: Enabled
or Disabled
. |
attribute | Keyword match setting
|
Yes |
campaignMobileBidAdjustment
|
The percentage by which bids are adjusted for mobile. For example, 0.2 means 20% increase, so mobile bids are 1.2 times the default bid. The range of valid values differs based on the external engine. | attribute | Number
|
Yes |
campaignTabletBidAdjustment
|
The percentage by which bids are adjusted for tablet. For example, 0.2 means 20% increase, so tablet bids are 1.2 times the default bid. The range of valid values differs based on the external engine. | attribute | Number
|
Yes |
campaignDesktopBidAdjustment
|
The percentage by which bids are adjusted for desktop. For example, 0.2 means 20% increase, so desktop bids are 1.2 times the default bid. The range of valid values differs based on the external engine. | attribute | Number
|
Yes |
networkTarget
|
The type of network(s) the campaign advertises on. | attribute | String
|
No |
yahooGeoTargets
|
Geo targets for Yahoo Search Marketing campaigns. See Download upload templates and geo/language codes . | attribute | String
|
No |
campaignLabels
|
Names of labels directly assigned to this campaign; inherited labels are not included. | attribute | String list
|
Yes |
campaignType
|
Indicates the type of campaign: Manual
, Inventory
, Inventory - PLA
, Shopping
, Comparison shopping
, Mobile app install
, Universal app
, or Smart shopping
. |
attribute | Campaign type
|
Yes |
effectiveBidStrategyId
|
DS ID of the bid strategy assigned to this entity, or inherited by this entity. | attribute | ID
|
Yes |
effectiveBidStrategy
|
The name of the bid strategy assigned to this entity, or inherited by this entity. | attribute | String
|
Yes |
bidStrategyInherited
|
Indicates whether this entity's bid strategy is inherited. | attribute | Boolean
|
Yes |
deviceTargets
|
Device targets at the campaign level; a combination of Desktop
, Mobile
, Tablet
, or Other
. |
attribute | String
|
No |
effectiveDeviceTargets
|
Device targets at the campaign level; a combination of Desktop
, Mobile
, Tablet
, or Other
. |
attribute | String
|
No |
languageTargets
|
Language targets at the campaign level. Download upload templates and geo/language codes . | attribute | String
|
No |
countryTargets
|
Country targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
provinceTargets
|
Province targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
metroTargets
|
Metro targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
cityTargets
|
City targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
effectiveCountryTargets
|
Country targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
effectiveProvinceTargets
|
Province targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
effectiveMetroTargets
|
Metro targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
effectiveCityTargets
|
City targets included in the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
excludedCountryTargets
|
Country targets excluded from the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
excludedProvinceTargets
|
Province targets excluded from the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
excludedMetroTargets
|
Metro targets excluded from the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
excludedCityTargets
|
City targets excluded from the campaign. Download upload templates and geo/language codes . | attribute | String
|
No |
effectiveLabels
|
Names of all labels inherited or directly assigned to this campaign. | attribute | String list
|
Yes |
clicksWithFeedItemShowing
|
Clicks on any link in the ad while the feed item was displayed. This column only returns a value in a feed item report or in a report that is segmented by a feed-item column. | metric | Integer
|
Yes |
costWithFeedItemShowing
|
Cost of all ads when the feed item was showing. This column only returns a value in a feed item report or in a report that is segmented by a feed-item column. | metric | Money
|
Yes |
dfaActions
|
The total number of Campaign manager actions. | metric | Integer
|
Yes |
dfaRevenue
|
Aggregate revenue generated by Campaign manager transactions. | metric | Money
|
Yes |
dfaTransactions
|
The total number of Campaign manager transactions. | metric | Integer
|
Yes |
dfaWeightedActions
|
Weighted sum of Campaign manager actions. | metric | Number
|
Yes |
dfaActionsCrossEnv
|
The total number of cross-environment Campaign manager actions. | metric | Number
|
Yes |
dfaRevenueCrossEnv
|
Aggregate revenue generated by cross-environment Campaign manager transactions. | metric | Money
|
Yes |
dfaTransactionsCrossEnv
|
The total number of cross-environment Campaign manager transactions. | metric | Number
|
Yes |
dfaWeightedActionsCrossEnv
|
Weighted sum of cross-environment Campaign manager actions. | metric | Number
|
Yes |
avgCpc
|
Average cost per click. | metric | Money
|
Yes |
avgCpm
|
Average cost per thousand impressions. | metric | Money
|
Yes |
avgPos
|
Average position. | metric | Number
|
Yes |
clicks
|
Aggregate clicks. | metric | Integer
|
Yes |
cost
|
Aggregate cost paid to engine account(s). | metric | Money
|
Yes |
ctr
|
Average click-through rate. | metric | Number
|
Yes |
impr
|
The total number of impressions. | metric | Integer
|
Yes |
adWordsConversions
|
The data that the advertiser has set up to be reported in the Google Ads Conversions column. When an Google Ads conversion action is created, the advertiser can choose whether to count those conversions in the Conversions reporting column . | metric | Number
|
Yes |
adWordsConversionValue
|
Aggregate value of Google Ads conversions. | metric | Number
|
Yes |
adWordsViewThroughConversions
|
The total number of Google Ads view-through conversions. | metric | Integer
|
Yes |
visits
|
The total number of DS visits. | metric | Integer
|
Yes |
searchImpressionShare
|
Google Ads and Bing Ads only. The impressions you have received on the Search Network divided by the estimated number of impressions you were eligible to receive. Returned as a number between 0.1 and 1 or, if the share is less than 0.1, the string < 10%
. |
metric | Impression share
|
Yes |
searchBudgetLostImpressionShare
|
Google Ads and Bing Ads only. The percentage of time that your ads weren't shown on the Search Network due to insufficient budget. Returned as a number between 0 and 0.9 or, if the share is greater than 0.9, as a string > 90%
. |
metric | Impression share
|
Yes |
searchRankLostImpressionShare
|
Google Ads and Bing Ads only. The percentage of time that your ads weren’t shown on the Search Network due to poor Ad Rank. Returned as a number between 0 and 0.9 or, if the share is greater than 0.9, as a string > 90%
. |
metric | Impression share
|
Yes |
displayImpressionShare
|
Google Ads only. The impressions you have received on the Display Network divided by the estimated number of impressions you were eligible to receive. Returned as a number between 0.1 and 1 or, if the share is less than 0.1, the string < 10%
. |
metric | Impression share
|
Yes |
displayBudgetLostImpressionShare
|
Google Ads only. The percentage of time that your ads weren't shown on the Display Network due to insufficient budget. Returned as a number between 0 and 0.9 or, if the share is greater than 0.9, as a string > 90%
. |
metric | Impression share
|
Yes |
displayRankLostImpressionShare
|
Google Ads only. The percentage of time that your ads weren’t shown on the Display Network due to poor Ad Rank. Returned as a number between 0 and 0.9 or, if the share is greater than 0.9, as a string > 90%
. |
metric | Impression share
|
Yes |
qualityScoreAvg
|
Google Ads and Bing Ads only. The impression-weighted average of the engine's Quality score (QS) across all days and keywords in the report scope. | metric | Number
|
Yes |
topOfPageBidAvg
|
Google Ads only. Approximates the average CPC bid needed during the report's time range for your ads to appear regularly in the top positions above the search results. | metric | Money
|
Yes |
absoluteTopImpressionPercentage
|
Percent of your ad impressions that are shown as the very first ad above the organic search results. | metric | Impression share
|
Yes |
searchAbsoluteTopImpressionShare
|
Impressions you've received in the absolute top location (the very first ad above the organic search results) divided by the estimated number of impressions you were eligible to receive in the top location. | metric | Impression share
|
Yes |
topImpressionPercentage
|
Percent of your ad impressions that are shown anywhere above the organic search results. | metric | Impression share
|
Yes |
searchTopImpressionShare
|
Impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. | metric | Impression share
|
Yes |
searchBudgetLostAbsoluteTopImpressionShare
|
Estimates how often your ad wasn't the very first ad above the organic search results due to a low budget. | metric | Impression share
|
Yes |
searchBudgetLostTopImpressionShare
|
Helps you to understand how often your ad didn't show anywhere above the organic search results due to a low budget. | metric | Impression share
|
Yes |
searchRankLostAbsoluteTopImpressionShare
|
Estimates how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. | metric | Impression share
|
Yes |
searchRankLostTopImpressionShare
|
Estimates how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. | metric | Impression share
|
Yes |
date
|
Segments the report by days; each row and its aggregate metrics are split into multiple rows, one for each day. This column returns the date of each row. | segment | Date
|
Yes |
monthStart
|
Segments the report by months; each row and its aggregate metrics are split into multiple rows, one for each month. This column returns the first day of the month of each row. | segment | Date
|
Yes |
monthEnd
|
Segments the report by months; each row and its aggregate metrics are split into multiple rows, one for each month. This column returns the last day of the month of each row. | segment | Date
|
Yes |
quarterStart
|
Segments the report by quarters; each row and its aggregate metrics are split into multiple rows, one for each quarter. This column returns the first day of the quarter of each row. | segment | Date
|
Yes |
quarterEnd
|
Segments the report by quarters; each row and its aggregate metrics are split into multiple rows, one for each quarter. This column returns the last day of the quarter of each row. | segment | Date
|
Yes |
weekStart
|
Segments the report by weeks (Sunday to Saturday); each row and its aggregate metrics are split into multiple rows, one for each week. This column returns the first day (Sunday) of each row. | segment | Date
|
Yes |
weekEnd
|
Segments the report by weeks (Sunday to Saturday); each row and its aggregate metrics are split into multiple rows, one for each week. This column returns the last day (Saturday) of each row. | segment | Date
|
Yes |
yearStart
|
Segments the report by years; each row and its aggregate metrics are split into multiple rows, one for each year. This column returns the first day of the year of each row. | segment | Date
|
Yes |
yearEnd
|
Segments the report by years; each row and its aggregate metrics are split into multiple rows, one for each year. This column returns the last day of the year of each row. | segment | Date
|
Yes |
deviceSegment
|
Segments the report by device; each row and its aggregate metrics are split into multiple rows, up to one for each device segment. This column returns the device segment of each row. | segment | Device segment
|
Yes |
floodlightGroup
|
Segments the report by Floodlight groups; each row and its aggregate metrics are split into multiple rows, up to one for each Floodlight group. This column returns the Floodlight group name of each row. Note that some metrics do not have Floodlight segmented values, such as clicks and visits. | segment | String
|
Yes |
floodlightGroupId
|
Segments the report by Floodlight groups; each row and its aggregate metrics are split into multiple rows, up to one for each Floodlight group. This column returns the DS Floodlight group ID of each row. Note that some metrics do not have Floodlight segmented values, such as clicks and visits. | segment | ID
|
Yes |
floodlightGroupTag
|
Segments the report by Floodlight groups; each row and its aggregate metrics are split into multiple rows, up to one for each Floodlight group. This column returns the Floodlight group tag of each row. Note that some metrics do not have Floodlight segmented values, such as clicks and visits. | segment | String
|
Yes |
floodlightActivity
|
Segments the report by Floodlight activities; each row and its aggregate metrics are split into multiple rows, up to one for each Floodlight activity. This column returns the Floodlight activity name of each row. Note that some metrics do not have Floodlight segmented values, such as clicks and visits. | segment | String
|
Yes |
floodlightActivityId
|
Segments the report by Floodlight activities; each row and its aggregate metrics are split into multiple rows, up to one for each Floodlight activity. This column returns the DS Floodlight activity ID of each row. Note that some metrics do not have Floodlight segmented values, such as clicks and visits. | segment | ID
|
Yes |
floodlightActivityTag
|
Segments the report by Floodlight activities; each row and its aggregate metrics are split into multiple rows, up to one for each Floodlight activity. This column returns the Floodlight activity tag of each row. Note that some metrics do not have Floodlight segmented values, such as clicks and visits. | segment | String
|
Yes |
sitelinkDisplayText
|
Segments the report by sitelinks; each row and its aggregate metrics are split into multiple rows, one for each sitelink. This column returns the sitelink display text of each row. | segment | String
|
Yes |
sitelinkDescription1
|
Segments the report by sitelinks; each row and its aggregate metrics are split into multiple rows, one for each sitelink. This column returns the sitelink description 1 of each row. | segment | String
|
Yes |
sitelinkDescription2
|
Segments the report by sitelinks; each row and its aggregate metrics are split into multiple rows, one for each sitelink. This column returns the sitelink description 2 of each row. | segment | String
|
Yes |
sitelinkLandingPageUrl
|
Segments the report by sitelinks; each row and its aggregate metrics are split into multiple rows, one for each sitelink. This column returns the sitelink's landing page URL of each row. | segment | String
|
Yes |
sitelinkClickserverUrl
|
Segments the report by sitelinks; each row and its aggregate metrics are split into multiple rows, one for each sitelink. This column returns the sitelink's clickserver URL of each row. | segment | String
|
Yes |
locationBusinessName
|
Segments the report by upgraded location extensions linked to a Business Profile account; each row and its aggregate metrics are split into multiple rows, one for each location that has metrics available. This column returns the location's business name for each row. | segment | String
|
Yes |
locationCategory
|
Segments the report by upgraded location extensions linked to a Business Profile account; each row and its aggregate metrics are split into multiple rows, one for each location that has metrics available. This column returns the location's category for each row. | segment | String
|
Yes |
locationDetails
|
Segments the report by upgraded location extensions linked to a Business Profile account; each row and its aggregate metrics are split into multiple rows, one for each location that has metrics available. This column returns the details about a location for each row. | segment | String
|
Yes |
locationFilter
|
Segments the report by upgraded location extensions linked to a Business Profile account; each row and its aggregate metrics are split into multiple rows, one for each location that has metrics available. This column returns the location's filter for each row. | segment | String
|
No |
callPhoneNumber
|
Segments the report by call extension; each row and its aggregate metrics are split into multiple rows, one for each call extension. This column returns a call extension's phone number. | segment | String
|
Yes |
callCountryCode
|
Segments the report by call extension; each row and its aggregate metrics are split into multiple rows, one for each call extension. This column returns the call extension's country code of each row. | segment | String
|
Yes |
callIsTracked
|
Segments the report by call extension; each row and its aggregate metrics are split into multiple rows, one for each call extension. This column returns true if the call extension's calls will be tracked, false otherwise. | segment | Boolean
|
Yes |
callCallOnly
|
Segments the report by call extension; each row and its aggregate metrics are split into multiple rows, one for each call extension. This column returns true if the call extension only shows a phone number, or false if the extension shows both a phone number and a link. | segment | Boolean
|
Yes |
callConversionTracker
|
Segments the report by call extensions; each row and its aggregate metrics are split into multiple rows, one for each call extension. This column returns the name of the conversion tracker associated with the feed item, if any exists. | segment | String
|
Yes |
callConversionTrackerId
|
Segments the report by call extensions; each row and its aggregate metrics are split into multiple rows, one for each call extension. This column returns the ID of the conversion tracker associated with the call extension, if any exists. | segment | ID
|
Yes |
appId
|
Segments the report by app extension; each row and its aggregate metrics are split into multiple rows, one for each app extension. This column returns the app ID, if any exists. | segment | String
|
Yes |
appStore
|
Segments the report by app extension; each row and its aggregate metrics are split into multiple rows, one for each app extension. This column returns the app store type (Apple App Store, Google Play Store), if any exists. | segment | App store
|
Yes |
feedItemId
|
Segments the report by feed items; each row and its aggregate metrics are split into multiple rows, one for each feed item. This column returns the DS feed item row ID for each row. | segment | ID
|
Yes |
feedId
|
Segments the report by feed items; each row and its aggregate metrics are split into multiple rows, one for each feed item. This column returns the DS feed table ID for each row. | segment | ID
|
Yes |
feedType
|
Segments the report by feed items; each row and its aggregate metrics are split into multiple rows, one for each feed item. This column returns the type of feed item for each row. | segment | Feed type
|
Yes |
