Performance metrics for campaign targets, which include location targets (geo-location, proximity, and location extension) and remarketing list targets. Some targets are available only in specific types of engine accounts.
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": "campaignTarget"
.
{ ... "reportType": "campaignTarget", "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 campaign target: Active
, Paused
, or Removed
. |
attribute | Status
|
Yes |
creationTimestamp
|
Timestamp of the campaign target's creation, formatted in ISO 8601. | attribute | Timestamp
|
Yes |
lastModifiedTimestamp
|
Timestamp of the campaign target'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 |
engineRemarketingList
|
The name of the remarketing list associated with the target. | attribute | String
|
Yes |
engineRemarketingListBidModifier
|
The bid adjustment associated with the target. | attribute | Number
|
Yes |
locationTargetName
|
The name of the location target. | attribute | String
|
Yes |
locationTargetBidModifier
|
The bid adjustment associated with the location target. | attribute | Number
|
Yes |
campaignTargetId
|
The ID DS generated for a campaign target. | attribute | ID
|
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 |
