rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
Measure performance
Stay organized with collections
Save and categorize content based on your preferences.
You can use the Reports
service to retrieve performance
metrics for your account.
See the metrics
documentation for the
complete list of available metrics.
Requirements
You need the Reporting manager
role to retrieve this report.
To give an account the Reporting manager role, use
accounts.update
to
set the reportingManager
field to true
. The Reporting manager role is
equivalent to the Performance and insights role in Merchant Center.
accounts.update
replaces the entire Account
resource. Use accounts.get
to
get the full Account
resource, then provide all fields in your
accounts.update
request so you don't lose information.
Sample query
The following query retrieves the impressions
, clicks
, and ctr
for all
products in your account during a specific 30-day period. To make the request,
pass the following Merchant Center Query Language statement to the
reports.search
method:
SELECT
metrics.impressions,
metrics.clicks,
metrics.ctr
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'
Run
Click Run to try the sample in the API Explorer. After you click
Run, update the merchant ID placeholder to your own merchant ID in the
request URL. You can modify the query. The full query must remain on one line to
work with the API explorer.
You can also segment the
metrics in the query for more granular performance reports.
See the Products guide to learn how
to retrieve and filter products with the Reports
service.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eReports\u003c/code\u003e service allows you to retrieve performance metrics, such as impressions, clicks, and click-through rate (CTR), for your account.\u003c/p\u003e\n"],["\u003cp\u003eTo access this service, you must have the Reporting manager role (equivalent to the Performance and insights role in Merchant Center), which can be assigned using the \u003ccode\u003eaccounts.update\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eA comprehensive list of available metrics can be found in the \u003ccode\u003emetrics\u003c/code\u003e documentation, and you can use Merchant Center Query Language to create customized reports.\u003c/p\u003e\n"],["\u003cp\u003eFor more detailed analysis, you can segment your metrics and further explore report functionalities through the provided guides on segmentation and products.\u003c/p\u003e\n"]]],["The `Reports` service retrieves performance metrics, requiring the Reporting manager role. This role is enabled by setting `reportingManager` to `true` using `accounts.update`. To retain data, use `accounts.get` beforehand. `reports.search` uses Merchant Center Query Language, as demonstrated in a sample query that fetches `impressions`, `clicks`, and `ctr` for a given date range, and allows to run it in the API Explorer. Additionally, metrics can be segmented for detailed reports.\n"],null,["# Measure performance\n\nYou can use the `Reports` service to retrieve [performance\nmetrics](//support.google.com/merchants/answer/10265167) for your account.\n\nSee the [`metrics` documentation](/shopping-content/reference/rest/v2.1/reports/search#Metrics) for the\ncomplete list of available metrics.\n\nRequirements\n------------\n\nYou need the [Reporting manager\nrole](//support.google.com/merchants/answer/11935402) to retrieve this report.\n\nTo give an account the Reporting manager role, use\n[`accounts.update`](/shopping-content/reference/rest/v2.1/accounts/update) to\nset the `reportingManager` field to `true`. The Reporting manager role is\nequivalent to the Performance and insights role in Merchant Center.\n\n`accounts.update` replaces the entire `Account` resource. Use [`accounts.get`](/shopping-content/reference/rest/v2.1/accounts/get) to\nget the full `Account` resource, then provide all fields in your\n`accounts.update` request so you don't lose information.\n\nSample query\n------------\n\nThe following query retrieves the `impressions`, `clicks`, and `ctr` for all\nproducts in your account during a specific 30-day period. To make the request,\npass the following Merchant Center Query Language statement to the\n[`reports.search`](/shopping-content/reference/rest/v2.1/reports/search) method: \n\n SELECT\n metrics.impressions,\n metrics.clicks,\n metrics.ctr\n FROM MerchantPerformanceView\n WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'\n\n[Run](https://developers.google.com/shopping-content/reference/rest/v2.1/reports/search?apix=true&apix_params=%7B%22merchantId%22%3A0%2C%22resource%22%3A%7B%22query%22%3A%22SELECT%20%20metrics.impressions%2C%20%20metrics.clicks%2C%20%20metrics.ctr%20FROM%20MerchantPerformanceView%20WHERE%20segments.date%20BETWEEN%20%272020-12-01%27%20AND%20%272020-12-30%27%22%7D%7D)\n\nClick **Run** to try the sample in the **API Explorer** . After you click\n**Run** , update the merchant ID placeholder to your own merchant ID in the\nrequest URL. You can modify the query. The full query must remain on one line to\nwork with the **API explorer**.\n\nYou can also [segment](/shopping-content/guides/reports/segmentation) the\nmetrics in the query for more granular performance reports.\n\nSee the [Products guide](/shopping-content/guides/reports/products) to learn how\nto retrieve and filter products with the `Reports` service."]]