Performance metrics and configuration attributes for keywords.
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": "keyword".
{
...
"reportType": "keyword",
"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 keyword: 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 keyword in the external engine account. Possible statuses (depending on the type of external account) include criterion rarely served, criterion below first page bid, criterion low quality score, review, campaign paused, etc. |
attribute | String |
Yes |
creationTimestamp |
Timestamp of the keyword's creation, formatted in ISO 8601. | attribute | Timestamp |
Yes |
lastModifiedTimestamp |
Timestamp of the keyword'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 |
keywordId |
DS keyword ID. A value of 0 indicates that the keyword is unattributed. | attribute | ID |
Yes |
keywordMatchType |
Keyword match type: Broad, Exact, Phrase, or Content. |
attribute | Match type |
Yes |
keywordText |
Keyword text. | attribute | String |
Yes |
keywordEngineId |
ID of the keyword in the external engine account. | attribute | ID |
Yes |
keywordMaxCpc |
Overrides the ad group's max CPC and sets a maximum amount you are willing to pay if someone clicks an ad for this specific keyword. If this field is empty, the keyword will use the ad group's max CPC. | attribute | Money |
Yes |
effectiveKeywordMaxCpc |
The max CPC (maximum cost-per-click) that is in effect for this keyword. This will be either the same value as the ad group's max CPC or, if the keyword is overriding the ad group's setting, the keyword's own max CPC. | attribute | Money |
Yes |
keywordLandingPage |
The final URL that a user would visit after clicking on your ad. See Landing page and clickserver URLs. | attribute | String |
Yes |
keywordClickserverUrl |
The URL that DS uses to track activity. A user who clicks an ad would visit the clickserver URL first, and then be redirected to the final landing page. See Landing page and clickserver URLs. | attribute | String |
Yes |
isDisplayKeyword |
Indicates whether this is a placeholder keyword that is used for display and placement reporting. | attribute | Boolean |
Yes |
keywordMaxBid |
If this keyword is managed by a DS bid strategy, the bid strategy will never raise bids above this limit. See Apply a bid strategy to keywords. | attribute | Money |
Yes |
keywordMinBid |
If this keyword is managed by a DS bid strategy, the bid strategy will never lower bids below this limit. See Apply a bid strategy to keywords. | attribute | Money |
Yes |
keywordUrlParams |
Extra URL parameters added to the landing page. See Add URL parameters. | attribute | String |
Yes |
bingKeywordParam2 |
Param2 of a Bing Ads keyword. | attribute | String |
Yes |
bingKeywordParam3 |
Param3 of a Bing Ads keyword. | attribute | String |
Yes |
keywordLabels |
Names of labels directly assigned to this keyword; inherited labels are not included. | attribute | String list |
Yes |
qualityScoreCurrent |
Google Ads and Bing Ads only. The most recent value of the engine's Quality score (QS) for a keyword. Note that this column always reports the latest QS for a keyword regardless of the report's time range. | attribute | Integer |
Yes |
topOfPageBidCurrent |
Google Ads only. Approximates the current CPC bid needed for your ad to appear regularly in the top positions above the search results. Note that this column always reports the CPC currently needed regardless of the report's time range. | attribute | Money |
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 |
effectiveLabels |
Names of all labels inherited or directly assigned to this keyword. | 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 |
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 |
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 |
ad |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the name of the ad in each row. | segment | String |
Yes |
adId |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the DS ID of the ad in each row. | segment | ID |
Yes |
isUnattributedAd |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column indicates whether the metrics in this row is unattributable to a specific ad. | segment | Boolean |
Yes |
adHeadline |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the headline of the ad in each row. | segment | String |
Yes |
adHeadline2 |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the headline 2 of the ad in each row. Not available for some engines. | segment | String |
Yes |
adHeadline3 |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the headline 3 of the ad in each row. Not available for some engines. | segment | String |
Yes |
adDescription1 |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns description line 1 of the ad in each row. | segment | String |
Yes |
adDescription2 |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns description line 2 of the ad in each row. | segment | String |
Yes |
adDisplayUrl |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the display URL of the ad in each row. | segment | String |
Yes |
adLandingPage |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the landing page of the ad in each row. | segment | String |
Yes |
adType |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the type of the ad in each row: Text or Product. |
segment | Ad type |
Yes |
adPromotionLine |
Segments the report by ads; each row and its aggregate metrics are split into multiple rows, up to one for each ad. This column returns the promotion line of the product ad in each row. | segment | String |
Yes |