Performance metrics and configuration attributes for product groups. Product group reports differ from keyword reports in several ways; Learn more.
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": "productGroup"
.
{ ... "reportType": "productGroup", "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 product group. It is always Active . |
attribute | Status |
Yes |
engineStatus |
Additional status of the product group in the external engine account. Possible statuses (depending on the type of external account) include review , campaign paused , etc. |
attribute | String |
Yes |
creationTimestamp |
Timestamp of the product group's creation, formatted in ISO 8601. | attribute | Timestamp |
Yes |
lastModifiedTimestamp |
Timestamp of the product group'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 |
productGroupId |
DS product group ID. DS generates these IDs, which may change even though the resulting product group tree is unchanged. Learn more. | attribute | ID |
Yes |
productGroup |
The criteria that were used to define the product group, such as AND(CATEGORY="Electronics",BRAND = "example"). | attribute | String |
No |
productGroupPartitionType |
The partition type for the product group: Subdivided , Excluded , or Biddable . |
attribute | Product group partition type |
Yes |
productGroupLandingPage |
Product group landing page. See Landing page and clickserver URLs. | attribute | String |
Yes |
productGroupClickserverUrl |
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 |
productGroupMaxCpc |
Returns the max CPC that has been set for this product group, if there is one. If max CPC has not been set for this product group, this field is empty and the product group inherits the max CPC setting from the ad group. | attribute | Money |
Yes |
effectiveProductGroupMaxCpc |
The max CPC (maximum cost-per-click) that is in effect for this product group. This will be either the same value as the ad group's max CPC or, if the product target is overriding the ad group's setting, the product target's own max CPC. | attribute | Money |
Yes |
productGroupMaxBid |
If this product group is managed by a DS bid strategy, the bid strategy will never raise bids above this limit. See Apply a bid strategy to product group. | attribute | Money |
Yes |
productGroupMinBid |
If this product group is managed by a DS bid strategy, the bid strategy will never lower bids below this limit. See Apply a bid strategy to product group. | 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 product group. | 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 |