- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- ReportRow
- Segments
- Program
- Metrics
- Try it!
Retrieves merchant performance mertrics matching the search query and optionally segmented by selected dimensions.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/reports/search
Path parameters
Parameters | |
---|---|
merchantId |
Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "query": string, "pageSize": integer, "pageToken": string } |
Fields | |
---|---|
query |
Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the Query Language guide. |
pageSize |
Number of ReportRows to retrieve in a single page. Defaults to the maximum of 1000. Values above 1000 are coerced to 1000. |
pageToken |
Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from |
Response body
If successful, the response body contains data with the following structure:
Response message for the ReportService.Search method.
JSON representation |
---|
{
"results": [
{
object ( |
Fields | |
---|---|
results[] |
Rows that matched the search query. |
nextPageToken |
Token which can be sent as |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
ReportRow
Result row returned from the search query.
JSON representation |
---|
{ "segments": { object ( |
Fields | |
---|---|
segments |
Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query. |
metrics |
Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query. |
Segments
Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order.
Segment fields cannot be selected in queries without also selecting at least one metric field.
Values are only set for dimensions requested explicitly in the request's search query.
JSON representation |
---|
{ "program": enum ( |
Fields | |
---|---|
program |
Program to which metrics apply, e.g., Free Product Listing. |
date |
Date in the merchant timezone to which metrics apply. |
week |
First day of the week (Monday) of the metrics date in the merchant timezone. |
currencyCode |
Currency in which price metrics are represented, e.g., if you select |
offerId |
Merchant-provided id of the product. |
title |
Title of the product. |
brand |
Brand of the product. |
categoryL1 |
Product category (1st level) in Google's product taxonomy. |
categoryL2 |
Product category (2nd level) in Google's product taxonomy. |
categoryL3 |
Product category (3rd level) in Google's product taxonomy. |
categoryL4 |
Product category (4th level) in Google's product taxonomy. |
categoryL5 |
Product category (5th level) in Google's product taxonomy. |
productTypeL1 |
Product type (1st level) in merchant's own product taxonomy. |
productTypeL2 |
Product type (2nd level) in merchant's own product taxonomy. |
productTypeL3 |
Product type (3rd level) in merchant's own product taxonomy. |
productTypeL4 |
Product type (4th level) in merchant's own product taxonomy. |
productTypeL5 |
Product type (5th level) in merchant's own product taxonomy. |
customLabel0 |
Custom label 0 for custom grouping of products. |
customLabel1 |
Custom label 1 for custom grouping of products. |
customLabel2 |
Custom label 2 for custom grouping of products. |
customLabel3 |
Custom label 3 for custom grouping of products. |
customLabel4 |
Custom label 4 for custom grouping of products. |
Program
Programs as part of which merchant's products are listed across Google.
Enums | |
---|---|
PROGRAM_UNSPECIFIED |
Not specified. |
SHOPPING_ADS |
Shopping Ads. |
FREE_PRODUCT_LISTING |
Free Product Listing. |
FREE_LOCAL_PRODUCT_LISTING |
Free Local Product Listing. |
BUY_ON_GOOGLE_LISTING |
Buy on Google Listing. |
Metrics
Performance metrics. Values are only set for metrics requested explicitly in the request's search query.
JSON representation |
---|
{ "clicks": string, "impressions": string, "ctr": number, "conversions": number, "conversionValueMicros": string, "conversionRate": number, "orders": string, "shippedOrders": string, "unshippedOrders": number, "daysToShip": number, "aos": number, "aovMicros": number, "orderedItems": string, "orderedItemSalesMicros": string, "shippedItems": string, "unshippedItems": number, "shippedItemSalesMicros": string, "rejectedItems": string, "itemDaysToShip": number, "itemFillRate": number, "returnedItems": string, "returnsMicros": string, "returnRate": number } |
Fields | |
---|---|
clicks |
Number of clicks. |
impressions |
Number of times merchant's products are shown. |
ctr |
Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). |
conversions |
Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the FREE_PRODUCT_LISTING program. |
conversionValueMicros |
Value of conversions in micros attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response. |
conversionRate |
Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the FREE_PRODUCT_LISTING program. |
orders |
Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. This metric cannot be segmented by product dimensions. |
shippedOrders |
Number of fully shipped orders, reported on the last shipment date. This metric cannot be segmented by product dimensions. |
unshippedOrders |
Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. This metric cannot be segmented by product dimensions. |
daysToShip |
Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. This metric cannot be segmented by product dimensions. |
aos |
Average order size - the average number of items in an order. This metric cannot be segmented by product dimensions. |
aovMicros |
Average order value - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response. This metric cannot be segmented by product dimensions. |
orderedItems |
Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. |
orderedItemSalesMicros |
Total price of ordered items. Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response. |
shippedItems |
Number of shipped items, reported on the shipment date. |
unshippedItems |
Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. |
shippedItemSalesMicros |
Total price of shipped items, reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response. |
rejectedItems |
Number of ordered items canceled by the merchant, reported on the order date. |
itemDaysToShip |
Average number of days between an item being ordered and the item being |
itemFillRate |
Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. |
returnedItems |
Number of ordered items sent back for return, reported on the date when the merchant accepted the return. |
returnsMicros |
Total price of ordered items sent back for return, reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currencyCode segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response. |
returnRate |
Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currencyCode segment is populated in the response. |