Reporting data for advertisers, including:
- Performance metrics across all of an advertiser's engine accounts and campaigns.
- Configuration attributes for an advertiser.
Request excerpt
Send a regular
Reports.request() or
Reports.generate()
request body, but specify "reportType": "advertiser".
{
...
"reportType": "advertiser",
"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 advertiser: Active, Paused, or Removed. |
attribute | Status |
Yes |
creationTimestamp |
Timestamp of the advertiser's creation, formatted in ISO 8601. | attribute | Timestamp |
Yes |
lastModifiedTimestamp |
Timestamp of the advertiser'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 |
dfaAdvertiserId |
ID of the Campaign manager advertiser associated with this DS advertiser. | attribute | ID |
Yes |
dfaNetworkId |
ID of the Campaign manager network associated with this DS advertiser. | attribute | ID |
Yes |
dfaNetworkTimeZone |
Time zone of the Campaign manager network associated with this DS advertiser in IANA Time Zone Database format, such as America/New_York. |
attribute | String |
Yes |
advertiserCurrencyCode |
Currency code of the advertiser in ISO 4217 format. | attribute | String |
Yes |
googleAnalyticsTimeZone |
The time zone of the Google Analytics view linked to this DS advertiser. Uses the IANA Time Zone Database format, such as America/New_York. |
attribute | String |
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 |