Migrate reporting from the Content API for Shopping

Page Summary

outlined_flag

• Integrate the Merchant Reports API with your existing Content API for Shopping implementation for enhanced reporting capabilities.

• Transition to the Merchant Reports API involves updates to request URLs, methods, and table/field naming conventions.

• Key differences include the introduction of a new marketing_method field, changes to price and currency representations, and the addition of feedLabel .

• Buy On Google metrics are not supported within the Merchant Reports API, and certain gross profit change fields have been removed in the Price Insights view.

• Reporting for Best Sellers and Competitive Visibility views see changes to country and category fields, adopting reportCountryCode and reportCategoryId respectively.

You can use Merchant Reports API to learn about your products, their performance , and their competitive environment on Google through the data view that it offers.

You can use the Merchant Reports API to do the following:

• Measure the performance of your products : In Merchant API, MerchantPerformanceView is now product_performance_view .
• Filter your products by specific fields : With Merchant API, you can filter based on all the available fields, except item_issues .
• Improve product pricing : With Merchant API, amount micros and currency fields are merged into one field with Price type.
• Understand the market : With Merchant API, you can get the data about best-selling products and brands, competitive price points, sale price suggestions, and information about the competitive landscape for your industry.
• Explore your competitive landscape : You can get report to understand your competitive landscape on a product category level and take action to improve your visibility.

Here's how you can integrate the Merchant Reports API with your existing Content API for Shopping implementation.

Requests

Use the following request URL format for the Merchant Reports API:

  POST https://merchantapi.googleapis.com/reports/v1/ {PARENT} 
/reports:search 
 

Here's a sample comparison of the Content API for Shopping to the Merchant Reports API for search requests:

Methods

You can query the Merchant Reports API by calling the ReportService.Search method.

Views

In the Merchant API, table names are changed from CamelCase to snake_case .

MerchantPerformanceView is now product_performance_view .

Here's a mapping between table names in the Content API for Shopping and the Merchant API:

In the Merchant API, specifying a field prefix, for example, segments.offer_id is no longer required. Instead, just use the field name, offer_id .

Here's a sample comparison of queries in the Content API for Shopping and the Merchant API:

SELECT
     segments.offer_id,
     metrics.clicks
   FROM MerchantPerformanceView
   WHERE segments.date DURING LAST_7_DAYS

SELECT
     offer_id,
     clicks
   FROM product_performance_view
   WHERE date DURING LAST_7_DAYS

Here's a sample response:

{
  "segments":{
    "offerId":"abc"
  },
  "metrics":{
    "clicks":"123"
  }
}

{
  "productPerformanceView" : {
    "offerId": "abc",
    "clicks": "123"
  }
}

The table name can be used as a field prefix. For example, both offer_id and product_performance_view.offer_id are accepted in the Merchant API query.

Performance

Here's what's changed for the performance view in the Merchant Reports API:

New marketing method values

Here's the mapping between segments.program and marketing_method values:

Product

Here's what's changed for the product view in the Merchant Reports API:

Price Insights

Here's what's changed for the price insights view in the Merchant Reports API:

Price Competitiveness

Here's what's changed for the price competitiveness view in the Merchant Reports API:

Best sellers

Here's what's changed for the best sellers views in the Merchant Reports API:

Competitive visibility

Here's what's changed for the competitive visibility views in the Merchant Reports API: