Quickstart example

Here's a sample query to the product_performance_view that returns the performance of your account over the last 30 days, segmented by marketing_method and offer_id. You can try this quick example to get familiar with the Merchant Reports API.

You need the Performance and insights role to retrieve this report. See the requirements for more details.

Note: This guide shows the underlying HTTP request as a teaching tool, but we recommend that you use one of the client libraries to submit your requests.

To make the request, pass the following Merchant Center Query Language statement to the accounts.reports.search method:

SELECT
  marketing_method,
  offer_id,
  impressions,
  clicks,
  click_through_rate
FROM product_performance_view
WHERE date BETWEEN '2023-11-01' AND '2023-11-30'

HTTP request URL

The request consists of an HTTP POST to the Merchant Reports API server at the following URL:

https://merchantapi.googleapis.com/reports/v1beta/accounts/PARENT/reports:search

Complete HTTP request sample

Here is a complete example showing the report definition enclosed within an HTTP POST request:

POST /reports/v1beta/accounts/PARENT/reports:search HTTP/1.1
Host: merchantapi.googleapis.com
User-Agent: curl
Content-Type: application/json
Accept: application/json
Authorization: Bearer

Parameters:
{
  "query" : "SELECT
              marketing_method,
              offer_id,
              impressions,
              clicks,
              click_through_rate
            FROM product_performance_view
            WHERE date BETWEEN '2023-11-01' AND '2023-11-30'"
}

Here's a sample response:

{
  "results": [
    {
      "productPerformanceView": {
        "marketingMethod": "ADS",
        "offerId": "12345",
        "clicks": "38",
        "impressions": "1038",
        "clickThroughRate": "0.3661"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ADS",
        "offerId": "12346",
        "clicks": "126",
        "impressions": "1126",
        "clickThroughRate": "0.1119"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ORGANIC",
        "offerId": "12346",
        "clicks": "26",
        "impressions": "526",
        "clickThroughRate": "0.0494"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ADS",
        "offerId": "12347",
        "clicks": "227",
        "impressions": "1227",
        "clickThroughRate": "0.1850"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ORGANIC",
        "offerId": "12347",
        "clicks": "12",
        "impressions": "512",
        "clickThroughRate": "0.0234"
      }
    }
  ]
}