Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions.

search(merchantId, body=None, x__xgafv=None)

Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions.

Args:
merchantId: string, Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for the ReportService.Search method.
"pageSize": 42, # Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.
"pageToken": "A String", # 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 `next_page_token` in the previous response should be used.
"query": "A String", # 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](https://developers.google.com/shopping-content/guides/reports/query-language/overview).
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for the ReportService.Search method.
"nextPageToken": "A String", # Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages.
"results": [ # Rows that matched the search query.
{ # Result row returned from the search query.
"bestSellers": { # Fields related to the [Best sellers reports](https://support.google.com/merchants/answer/9488679). # Best sellers fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersProductClusterView` or `BestSellersBrandView`.
"categoryId": "A String", # Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). If a `WHERE` condition on `best_sellers.category_id` is not specified in the query, rankings for all top-level categories are returned.
"countryCode": "A String", # Country where the ranking is calculated. A `WHERE` condition on `best_sellers.country_code` is required in the query.
"previousRank": "A String", # Popularity rank in the previous week or month.
"previousRelativeDemand": "A String", # Estimated demand in relation to the item with the highest popularity rank in the same category and country in the previous week or month.
"rank": "A String", # Popularity on Shopping ads and free listings, in the selected category and country, based on the estimated number of units sold.
"relativeDemand": "A String", # Estimated demand in relation to the item with the highest popularity rank in the same category and country.
"relativeDemandChange": "A String", # Change in the estimated demand. Whether it rose, sank or remained flat.
"reportDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports. * The first day of the month for monthly reports. If a `WHERE` condition on `best_sellers.report_date` is not specified in the query, the latest available weekly or monthly report is returned.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"reportGranularity": "A String", # Granularity of the report. The ranking can be done over a week or a month timeframe. A `WHERE` condition on `best_sellers.report_granularity` is required in the query.
},
"brand": { # Brand fields. Values are only set for fields requested explicitly in the request's search query. # Brand fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersBrandView`.
"name": "A String", # Name of the brand.
},
"competitiveVisibility": { # Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442). # Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView`, `CompetitiveVisibilityBenchmarkView` or `CompetitiveVisibilityCompetitorView`.
"adsOrganicRatio": 3.14, # [Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-ratio) shows how often a merchant receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"categoryBenchmarkVisibilityTrend": 3.14, # Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market. Available only in `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.
"categoryId": "A String", # Google product category ID to calculate the report for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.category_id` is required in the query.
"countryCode": "A String", # The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.country_code` is required in the query.
"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date of this row. Available only in `CompetitiveVisibilityBenchmarkView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"domain": "A String", # Domain of your competitor or your domain, if 'is_your_domain' is true. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"higherPositionRate": 3.14, # Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"isYourDomain": True or False, # True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"pageOverlapRate": 3.14, # Page overlap rate describes how frequently competing retailers’ offers are shown together with your offers on the same page. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"rank": "A String", # Position of the domain in the top merchants ranking for the selected keys (`date`, `category_id`, `country_code`, `listing_type`) based on impressions. 1 is the highest. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"relativeVisibility": 3.14, # Relative visibility shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country. Available only in `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.
"trafficSource": "A String", # Type of impression listing. Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE' clause.
"yourDomainVisibilityTrend": 3.14, # Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions). Available only in `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.
},
"metrics": { # Performance metrics. Values are only set for metrics requested explicitly in the request's search query. # Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query.
"aos": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.**
"aovMicros": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code 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 currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**
"clicks": "A String", # Number of clicks.
"conversionRate": 3.14, # 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.
"conversionValueMicros": "A String", # Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 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 currency_code 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 currency_code segment is populated in the response.
"conversions": 3.14, # 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.
"ctr": 3.14, # Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).
"daysToShip": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. 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 and customer_country_code.**
"impressions": "A String", # Number of times merchant's products are shown.
"itemDaysToShip": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.**
"itemFillRate": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. 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. **This metric cannot be segmented by customer_country_code.**
"orderedItemSalesMicros": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). 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 currency_code 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 currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
"orderedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.**
"orders": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.**
"rejectedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.**
"returnRate": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. 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 currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
"returnedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.**
"returnsMicros": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code 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 currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
"shippedItemSalesMicros": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code 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 currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**
"shippedItems": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**
"shippedOrders": "A String", # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**
"unshippedItems": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. 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. **This metric cannot be segmented by customer_country_code.**
"unshippedOrders": 3.14, # *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. 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 and customer_country_code.**
},
"priceCompetitiveness": { # Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`. https://support.google.com/merchants/answer/9626903 # Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`.
"benchmarkPriceCurrencyCode": "A String", # The price benchmark currency (ISO 4217 code).
"benchmarkPriceMicros": "A String", # The latest available price benchmark in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product's catalog in the benchmark country.
"countryCode": "A String", # The country of the price benchmark (ISO 3166 code).
},
"priceInsights": { # Price insights fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceInsightsProductView`. https://support.google.com/merchants/answer/11916926 # Price insights fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceInsightsProductView`.
"effectiveness": "A String", # The predicted effectiveness of applying the price suggestion, bucketed.
"predictedClicksChangeFraction": 3.14, # The predicted change in clicks as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in clicks.
"predictedConversionsChangeFraction": 3.14, # The predicted change in conversions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).
"predictedGrossProfitChangeFraction": 3.14, # *Deprecated*: This field is no longer supported and will start returning 0. The predicted change in gross profit as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in gross profit.
"predictedImpressionsChangeFraction": 3.14, # The predicted change in impressions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in impressions.
"predictedMonthlyGrossProfitChangeCurrencyCode": "A String", # *Deprecated*: This field is no longer supported and will start returning USD for all requests. The predicted monthly gross profit change currency (ISO 4217 code).
"predictedMonthlyGrossProfitChangeMicros": "A String", # *Deprecated*: This field is no longer supported and will start returning 0. The predicted change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after introducing the suggested price for a month compared to current active price.
"suggestedPriceCurrencyCode": "A String", # The suggested price currency (ISO 4217 code).
"suggestedPriceMicros": "A String", # The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product.
},
"productCluster": { # Product cluster fields. A product cluster is a grouping for different offers that represent the same product. Values are only set for fields requested explicitly in the request's search query. # Product cluster fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersProductClusterView`.
"brand": "A String", # Brand of the product cluster.
"brandInventoryStatus": "A String", # Tells if there is at least one product of the brand currently `IN_STOCK` in your product feed across multiple countries, all products are `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY`. The field doesn't take the Best Sellers report country filter into account.
"categoryL1": "A String", # Product category (1st level) of the product cluster, represented in Google's product taxonomy.
"categoryL2": "A String", # Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
"categoryL3": "A String", # Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
"categoryL4": "A String", # Product category (4th level) of the product cluster, represented in Google's product taxonomy.
"categoryL5": "A String", # Product category (5th level) of the product cluster, represented in Google's product taxonomy.
"inventoryStatus": "A String", # Tells whether the product cluster is `IN_STOCK` in your product feed across multiple countries, `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY` at all. The field doesn't take the Best Sellers report country filter into account.
"title": "A String", # Title of the product cluster.
"variantGtins": [ # GTINs of example variants of the product cluster.
"A String",
],
},
"productView": { # Product fields. Values are only set for fields requested explicitly in the request's search query. # Product fields requested by the merchant in the query. Field values are only set if the merchant queries `ProductView`.
"aggregatedDestinationStatus": "A String", # Aggregated destination status.
"availability": "A String", # Availability of the product.
"brand": "A String", # Brand of the product.
"categoryL1": "A String", # First level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
"categoryL2": "A String", # Second level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
"categoryL3": "A String", # Third level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
"categoryL4": "A String", # Fourth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
"categoryL5": "A String", # Fifth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
"channel": "A String", # Channel of the product (online versus local).
"clickPotential": "A String", # Estimated performance potential compared to highest performing products of the merchant.
"clickPotentialRank": "A String", # Rank of the product based on its click potential. A product with `click_potential_rank` 1 has the highest click potential among the merchant's products that fulfill the search query conditions.
"condition": "A String", # Condition of the product.
"creationTime": "A String", # The time the merchant created the product in timestamp seconds.
"currencyCode": "A String", # Product price currency code (for example, ISO 4217). Absent if product price is not available.
"expirationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Expiration date for the product. Specified on insertion.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"gtin": [ # GTIN of the product.
"A String",
],
"id": "A String", # The REST ID of the product, in the form of channel:contentLanguage:targetCountry:offerId. Content API methods that operate on products take this as their productId parameter. Should always be included in the SELECT clause.
"itemGroupId": "A String", # Item group ID provided by the merchant for grouping variants together.
"itemIssues": [ # List of item issues for the product.
{ # Item issue associated with the product.
"issueType": { # Type of the item issue. # Item issue type.
"canonicalAttribute": "A String", # Canonical attribute name for attribute-specific issues.
"code": "A String", # Error code of the issue.
},
"resolution": "A String", # Item issue resolution.
"severity": { # Severity of an issue per destination in a region, and aggregated severity. # Item issue severity.
"aggregatedSeverity": "A String", # Severity of an issue aggregated for destination.
"severityPerDestination": [ # Item issue severity for every destination.
{ # Issue severity for all affected regions in a destination.
"demotedCountries": [ # List of demoted countries in the destination.
"A String",
],
"destination": "A String", # Issue destination.
"disapprovedCountries": [ # List of disapproved countries in the destination.
"A String",
],
},
],
},
},
],
"languageCode": "A String", # Language code of the product in BCP 47 format.
"offerId": "A String", # Merchant-provided id of the product.
"priceMicros": "A String", # Product price specified as micros (1 millionth of a standard unit, 1 USD = 1000000 micros) in the product currency. Absent in case the information about the price of the product is not available.
"productTypeL1": "A String", # First level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).
"productTypeL2": "A String", # Second level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).
"productTypeL3": "A String", # Third level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).
"productTypeL4": "A String", # Fourth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).
"productTypeL5": "A String", # Fifth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).
"shippingLabel": "A String", # The normalized shipping label specified in the feed
"title": "A String", # Title of the product.
},
"segments": { # Dimensions according to which metrics are segmented in the response. Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the corresponding event, for example, 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. # Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query.
"brand": "A String", # Brand of the product.
"categoryL1": "A String", # [Product category (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.
"categoryL2": "A String", # [Product category (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.
"categoryL3": "A String", # [Product category (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.
"categoryL4": "A String", # [Product category (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.
"categoryL5": "A String", # [Product category (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.
"currencyCode": "A String", # Currency in which price metrics are represented, for example, if you select `ordered_item_sales_micros`, the returned value will be represented by this currency.
"customLabel0": "A String", # Custom label 0 for custom grouping of products.
"customLabel1": "A String", # Custom label 1 for custom grouping of products.
"customLabel2": "A String", # Custom label 2 for custom grouping of products.
"customLabel3": "A String", # Custom label 3 for custom grouping of products.
"customLabel4": "A String", # Custom label 4 for custom grouping of products.
"customerCountryCode": "A String", # Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. If the customer country cannot be determined, a special 'ZZ' code is returned.
"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the merchant timezone to which metrics apply.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"offerId": "A String", # Merchant-provided id of the product.
"productTypeL1": "A String", # [Product type (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy.
"productTypeL2": "A String", # [Product type (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy.
"productTypeL3": "A String", # [Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy.
"productTypeL4": "A String", # [Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy.
"productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy.
"program": "A String", # Program to which metrics apply, for example, Free Product Listing.
"title": "A String", # Title of the product.
"week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the merchant timezone.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
},
"topicTrends": { # Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. Forecast data can be queried up to 13 weeks by passing a future date in the `date` field. Historical data is measured daily, and forecasted data is projected weekly. All data points are normalized based on the highest data points returned in the response. If you make separate queries with different date ranges, you might see different values for the same date in each response. The recommended way to get a trend score of a topic is `last7_days_search_interest / last{$day}_days_search_interest - 1`. You can view trends for up to eight topics at a time. # [Topic trends](https://support.google.com/merchants/answer/13542370) fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`.
"customerCountryCode": "A String", # Country trends are calculated for. Must be a two-letter country code (ISO 3166-1-alpha-2 code), for example, `“US”`.
"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date the trend score was retrieved.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"last120DaysSearchInterest": 3.14, # Search interest in the last 120 days, with the same normalization as search_interest. This field is only present for a past date.
"last30DaysSearchInterest": 3.14, # Search interest in the last 30 days, with the same normalization as search_interest. This field is only present for a past date.
"last7DaysSearchInterest": 3.14, # Search interest in the last 7 days, with the same normalization as search_interest. This field is only present for a past date.
"last90DaysSearchInterest": 3.14, # Search interest in the last 90 days, with the same normalization as search_interest. This field is only present for a past date.
"next7DaysSearchInterest": 3.14, # Estimated search interest in the next 7 days, with the same normalization as search_interest. This field is only present for a future date.
"searchInterest": 3.14, # Daily search interest, normalized to the time and country to make comparisons easier, with 100 representing peak popularity (from 0 to 100) for the requested time period and location.
"topic": "A String", # Google-provided topic trends are calculated for. Only top eight topics are returned. Topic is what shoppers are searching for on Google, grouped by the same concept.
},
},
],
}

Content API for Shopping . reports

Instance Methods

Method Details