Performance metrics and configuration attributes for feed items (for example, sitelink, location, call or app extensions).
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": "feedItem"
.
{ ... "reportType": "feedItem", "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 feed item: Active
, Paused
, or Removed
. |
attribute | Status
|
Yes |
engineStatus
|
Additional status of the feed item in the external engine account. Possible statuses (depending on the type of external account) include review
, active
, etc. |
attribute | String
|
Yes |
creationTimestamp
|
Timestamp of the feed item's creation, formatted in ISO 8601. | attribute | Timestamp
|
Yes |
lastModifiedTimestamp
|
Timestamp of the feed item'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 |
sitelinkDisplayText
|
The feed item's sitelink display text. | attribute | String
|
Yes |
sitelinkDescription1
|
The feed item's sitelink description 1. | attribute | String
|
Yes |
sitelinkDescription2
|
The feed item's sitelink description 2. | attribute | String
|
Yes |
sitelinkLandingPageUrl
|
The feed item's sitelink landing page URL. | attribute | String
|
Yes |
sitelinkClickserverUrl
|
The feed item's sitelink clickserver URL name. | attribute | String
|
Yes |
locationBusinessName
|
The name of a business defined in an upgraded location extension. | attribute | String
|
Yes |
locationCategory
|
The category defined for a business in an upgraded location extension. | attribute | String
|
Yes |
locationDetails
|
Details about a business defined in an upgraded location extension. | attribute | String
|
Yes |
callPhoneNumber
|
A call extension's phone number. | attribute | String
|
Yes |
callCountryCode
|
A call extension's country code. | attribute | String
|
Yes |
callIsTracked
|
Returns true if a call extension's calls will be tracked, false otherwise. | attribute | Boolean
|
Yes |
callCallOnly
|
Returns true if a call extension is set to only show a phone number. Returns false if both the call and a link will be shown. | attribute | Boolean
|
Yes |
callConversionTracker
|
The name of the conversion tracker associated with this call extension, if any exists. | attribute | String
|
Yes |
callConversionTrackerId
|
The ID of the conversion tracker associated with this feed item, if any exists. | attribute | ID
|
Yes |
appId
|
The app ID defined for an app extension. | attribute | String
|
Yes |
appStore
|
The app store type (Apple App Store, Google Play Store) defined for an app extension. | attribute | App store
|
Yes |
feedItemId
|
The feed item row id. | attribute | ID
|
Yes |
feedId
|
The feed table id | attribute | ID
|
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 |
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 |
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 |
