Performance metrics and configuration attributes for ads.
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": "ad"
.
{ ... "reportType": "ad", "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
|
The status of the ad: Active
, Paused
, or Removed
. Note that campaigns, ad groups, keywords, and ads each have their own status. See status
. |
attribute | Status
|
Yes |
engineStatus
|
Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active
, eligible
, creative deleted
, creative approved family safe
, etc. |
attribute | String
|
Yes |
creationTimestamp
|
Timestamp of the ad's creation, formatted in ISO 8601. | attribute | Timestamp
|
Yes |
lastModifiedTimestamp
|
Timestamp of the ad'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 that contains this item. | attribute | Status
|
Yes |
adGroup
|
Ad group name. | attribute | String
|
Yes |
adGroupId
|
DS ad group ID. | attribute | ID
|
Yes |
adGroupStatus
|
The status of the ad group that contains this item. | attribute | Status
|
Yes |
ad
|
Ad name. | attribute | String
|
Yes |
adId
|
DS ad ID. A value of 0 indicates that the ad is unattributed. | attribute | ID
|
Yes |
adEngineId
|
ID of the ad in the external engine account. | attribute | ID
|
Yes |
isUnattributedAd
|
Indicates whether metrics in this row are unattributable to a specific ad. For example, an ad with an unsupported format or an erroneous clickserver URL can prevent DS from attributing metrics to an ad. | attribute | Boolean
|
Yes |
adHeadline
|
Ad headline. | attribute | String
|
Yes |
adHeadline2
|
Ad headline 2; not available for some engines. | attribute | String
|
Yes |
adHeadline3
|
Ad headline 3; not available for some engines. | attribute | String
|
Yes |
adDescription1
|
Ad description line 1. | attribute | String
|
Yes |
adDescription2
|
Ad description line 2; not available for some engines. | attribute | String
|
Yes |
adDisplayUrl
|
Ad display URL. | attribute | String
|
Yes |
adLandingPage
|
Ad landing page. See Landing page and clickserver URLs . | attribute | String
|
Yes |
adType
|
The type of ad: Text
, Product
, Dynamic search
, Mobile app install
, Call-Only
, Expanded text
, or Expanded dynamic search
. |
attribute | Ad type
|
Yes |
adPromotionLine
|
Ad promotion line. A short promotional message for a product ad. | attribute | String
|
Yes |
adLabels
|
Names of labels directly assigned to this ad; inherited labels are not included. | attribute | String list
|
Yes |
adPathField1
|
Ad path field 1. Path fields 1 and 2 are combined with adDisplayUrl to form the URL that is shown on an ad. | attribute | String
|
Yes |
adPathField2
|
Ad path field 2. Path fields 1 and 2 are combined with adDisplayUrl to form the URL that is shown on an ad. | attribute | String
|
Yes |
effectiveLabels
|
Names of all labels inherited or directly assigned to this ad. | attribute | String list
|
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 |
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 |
