Performance metrics, configuration attributes, and inventory attributes for products defined in an inventory feed and advertised in a shopping campaign.
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": "productAdvertised".
{
...
"reportType": "productAdvertised",
"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 as indicated in the inventory account: Active or Removed. |
attribute | Status |
Yes |
creationTimestamp |
Creation timestamp of the product as indicated in the inventory account, formatted in ISO 8601. | attribute | Timestamp |
Yes |
lastModifiedTimestamp |
Most recent modification timestamp of the product as indicated in the inventory account, 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 |
productId |
The item ID of the product. | attribute | String |
Yes |
productCountry |
The country registered for the product's inventory feed. | attribute | String |
Yes |
productLanguage |
The language registered for the product's inventory feed. | attribute | String |
Yes |
productMpn |
The MPN attribute (Manufacturer Part Number) of a product item. | attribute | String |
Yes |
productColor |
The color attribute of a product item. | attribute | String |
Yes |
productSize |
The size attribute of a product item. | attribute | String |
Yes |
productMaterial |
The material attribute of a product item. | attribute | String |
Yes |
productPattern |
The pattern attribute of a product item. | attribute | String |
Yes |
productAvailability |
The availability attribute of a product item. | attribute | Product availability |
Yes |
productGender |
The gender attribute of a product item. | attribute | String |
Yes |
productAgeGroup |
The age group attribute of a product item. | attribute | String |
Yes |
productLandingPageUrl |
The landing page attribute of a product item. | attribute | String |
Yes |
productCategory |
The google product category attribute of a product item. | attribute | String |
Yes |
productCategoryLevel1 |
The google product category level 1 attribute of a product item. | attribute | String |
Yes |
productCategoryLevel2 |
The google product category level 2 attribute of a product item. | attribute | String |
Yes |
productCategoryLevel3 |
The google product category level 3 attribute of a product item. | attribute | String |
Yes |
productCategoryLevel4 |
The google product category level 4 attribute of a product item. | attribute | String |
Yes |
productCategoryLevel5 |
The google product category level 5 attribute of a product item. | attribute | String |
Yes |
productBrand |
The brand attribute of a product item. | attribute | String |
Yes |
productGtin |
The GTIN attribute (Global Trading Item Number) of a product item. | attribute | String |
Yes |
productPrice |
The price attribute of a product item. | attribute | Money |
Yes |
productSalePrice |
The price attribute of a product item. | attribute | Money |
Yes |
productTypeLevel1 |
The product type leve 1 attribute of a product item. | attribute | String |
Yes |
productTypeLevel2 |
The product type leve 2 attribute of a product item. | attribute | String |
Yes |
productTypeLevel3 |
The product type leve 3 attribute of a product item. | attribute | String |
Yes |
productTypeLevel4 |
The product type leve 4 attribute of a product item. | attribute | String |
Yes |
productTypeLevel5 |
The product type leve 5 attribute of a product item. | attribute | String |
Yes |
productCondition |
The condition attribute of a product item. | attribute | String |
Yes |
productCustomLabel0 |
The custom label 0 attribute of a product item. | attribute | String |
Yes |
productCustomLabel1 |
The custom label 1 attribute of a product item. | attribute | String |
Yes |
productCustomLabel2 |
The custom label 2 attribute of a product item. | attribute | String |
Yes |
productCustomLabel3 |
The custom label 3 attribute of a product item. | attribute | String |
Yes |
productCustomLabel4 |
The custom label 4 attribute of a product item. | attribute | String |
Yes |
productCostOfGoodsSold |
The total cost of selling a product as specified in the inventory feed. | attribute | Money |
Yes |
productStoreId |
The store for which a product was advertised in a Local Inventory Ad. This should match the store IDs used in your local products feed. | attribute | String |
Yes |
productChannel |
The sales channel attribute of a product item: Online or Local. |
attribute | Product channel |
Yes |
productChannelExclusivity |
The channel exclusivity attribute of a product item. | attribute | Product channel exclusivity |
Yes |
productItemGroupId |
The item group id attribute of a product item. | attribute | String |
Yes |
productTitle |
The title attribute of a product item. | 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 |
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 |
accountId |
DS engine account ID. | segment | ID |
Yes |
campaignId |
Segments the report by campaign. This row returns the DS campaign ID associated with the row. | segment | ID |
Yes |
adGroupId |
Segments the report by ad group. This row returns the ad group id associated with the row. | segment | ID |
Yes |