Package google.shopping.merchant.reports.v1beta

Index

• ReportService (interface)
• BestSellersBrandView (message)
• BestSellersProductClusterView (message)
• BestSellersProductClusterView.InventoryStatus (enum)
• CompetitiveVisibilityBenchmarkView (message)
• CompetitiveVisibilityCompetitorView (message)
• CompetitiveVisibilityTopMerchantView (message)
• MarketingMethod (message)
• MarketingMethod.MarketingMethodEnum (enum)
• NonProductPerformanceView (message)
• PriceCompetitivenessProductView (message)
• PriceInsightsProductView (message)
• PriceInsightsProductView.Effectiveness (enum)
• ProductPerformanceView (message)
• ProductView (message)
• ProductView.AggregatedReportingContextStatus (enum)
• ProductView.ClickPotential (enum)
• ProductView.ItemIssue (message)
• ProductView.ItemIssue.ItemIssueResolution (enum)
• ProductView.ItemIssue.ItemIssueSeverity (message)
• ProductView.ItemIssue.ItemIssueSeverity.AggregatedIssueSeverity (enum)
• ProductView.ItemIssue.ItemIssueSeverity.IssueSeverityPerReportingContext (message)
• ProductView.ItemIssue.ItemIssueType (message)
• RelativeDemand (message)
• RelativeDemand.RelativeDemandEnum (enum)
• RelativeDemandChangeType (message)
• RelativeDemandChangeType.RelativeDemandChangeTypeEnum (enum)
• ReportGranularity (message)
• ReportGranularity.ReportGranularityEnum (enum)
• ReportRow (message)
• SearchRequest (message)
• SearchResponse (message)
• TrafficSource (message)
• TrafficSource.TrafficSourceEnum (enum)

ReportService

Service for retrieving reports and insights about your products, their performance, and their competitive environment on Google.

Search
rpc Search(SearchRequest) returns (SearchResponse) Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

BestSellersBrandView

Fields available for query in best_sellers_brand_view table.

Best sellers report with top brands.

Values are only set for fields requested explicitly in the request's search query.

Fields
report_date	Date 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. Required in the SELECT clause. If a WHERE condition on report_date is not specified in the query, the latest available weekly or monthly report is returned.
report_granularity	ReportGranularityEnum Granularity of the report. The ranking can be done over a week or a month timeframe. Required in the SELECT clause. Condition on report_granularity is required in the WHERE clause.
report_country_code	string Country where the ranking is calculated. Represented in the ISO 3166 format. Required in the SELECT clause. Condition on report_country_code is required in the WHERE clause.
report_category_id	int64 Google product category ID to calculate the ranking for, represented in Google's product taxonomy. Required in the SELECT clause. If a WHERE condition on report_category_id is not specified in the query, rankings for all top-level categories are returned.
brand	string Name of the brand.
rank	int64 Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
previous_rank	int64 Popularity rank in the previous week or month.
relative_demand	RelativeDemandEnum Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
previous_relative_demand	RelativeDemandEnum Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
relative_demand_change	RelativeDemandChangeTypeEnum Change in the estimated demand. Whether it rose, sank or remained flat.

BestSellersProductClusterView

Fields available for query in best_sellers_product_cluster_view table.

Best sellers report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7.

Values are only set for fields requested explicitly in the request's search query.

Fields
report_date	Date 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. Required in the SELECT clause. If a WHERE condition on report_date is not specified in the query, the latest available weekly or monthly report is returned.
variant_gtins[]	string GTINs of example variants of the product cluster.
report_granularity	ReportGranularityEnum Granularity of the report. The ranking can be done over a week or a month timeframe. Required in the SELECT clause. Condition on report_granularity is required in the WHERE clause.
report_country_code	string Country where the ranking is calculated. Represented in the ISO 3166 format. Required in the SELECT clause. Condition on report_country_code is required in the WHERE clause.
report_category_id	int64 Google product category ID to calculate the ranking for, represented in Google's product taxonomy. Required in the SELECT clause. If a WHERE condition on report_category_id is not specified in the query, rankings for all top-level categories are returned.
title	string Title of the product cluster.
brand	string Brand of the product cluster.
category_l1	string Product category (1st level) of the product cluster, represented in Google's product taxonomy.
category_l2	string Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
category_l3	string Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
category_l4	string Product category (4th level) of the product cluster, represented in Google's product taxonomy.
category_l5	string Product category (5th level) of the product cluster, represented in Google's product taxonomy.
inventory_status	InventoryStatus Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source in all countries, or NOT_IN_INVENTORY at all. The field doesn't take the Best sellers report country filter into account.
brand_inventory_status	InventoryStatus Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source in all countries, or NOT_IN_INVENTORY. The field doesn't take the Best sellers report country filter into account.
rank	int64 Popularity of the product cluster on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
previous_rank	int64 Popularity rank in the previous week or month.
relative_demand	RelativeDemandEnum Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.
previous_relative_demand	RelativeDemandEnum Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country in the previous week or month.
relative_demand_change	RelativeDemandChangeTypeEnum Change in the estimated demand. Whether it rose, sank or remained flat.

InventoryStatus

Status of the product cluster or brand in your inventory.

Enums
INVENTORY_STATUS_UNSPECIFIED	Not specified.
IN_STOCK	You have a product for this product cluster or brand in stock.
OUT_OF_STOCK	You have a product for this product cluster or brand in inventory but it is currently out of stock.
NOT_IN_INVENTORY	You do not have a product for this product cluster or brand in inventory.

CompetitiveVisibilityBenchmarkView

Fields available for query in competitive_visibility_benchmark_view table.

Competitive visibility report with the category benchmark.

Values are only set for fields requested explicitly in the request's search query.

Fields
date	Date Date of this row. Required in the SELECT clause. A condition on date is required in the WHERE clause.
report_country_code	string Country where impressions appeared. Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.
report_category_id	int64 Google product category ID to calculate the report for, represented in Google's product taxonomy. Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.
traffic_source	TrafficSourceEnum Traffic source of impressions. Required in the SELECT clause.
your_domain_visibility_trend	double 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). Cannot be filtered on in the 'WHERE' clause.
category_benchmark_visibility_trend	double 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. Cannot be filtered on in the 'WHERE' clause.

CompetitiveVisibilityCompetitorView

Fields available for query in competitive_visibility_competitor_view table.

Competitive visibility report with businesses with similar visibility.

Values are only set for fields requested explicitly in the request's search query.

Fields
date	Date Date of this row. A condition on date is required in the WHERE clause.
domain	string Domain of your competitor or your domain, if 'is_your_domain' is true. Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.
is_your_domain	bool True if this row contains data for your domain. Cannot be filtered on in the 'WHERE' clause.
report_country_code	string Country where impressions appeared. Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.
report_category_id	int64 Google product category ID to calculate the report for, represented in Google's product taxonomy. Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.
traffic_source	TrafficSourceEnum Traffic source of impressions. Required in the SELECT clause.
rank	int64 Position of the domain in the similar businesses ranking for the selected keys (date, report_category_id, report_country_code, traffic_source) based on impressions. 1 is the highest. Cannot be filtered on in the 'WHERE' clause.
ads_organic_ratio	double Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause.
page_overlap_rate	double Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page. Cannot be filtered on in the 'WHERE' clause.
higher_position_rate	double Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer. Cannot be filtered on in the 'WHERE' clause.
relative_visibility	double 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. Cannot be filtered on in the 'WHERE' clause.

CompetitiveVisibilityTopMerchantView

Fields available for query in competitive_visibility_top_merchant_view table.

Competitive visibility report with business with highest visibility.

Values are only set for fields requested explicitly in the request's search query.

Fields
date	Date Date of this row. Cannot be selected in the SELECT clause. A condition on date is required in the WHERE clause.
domain	string Domain of your competitor or your domain, if 'is_your_domain' is true. Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.
is_your_domain	bool True if this row contains data for your domain. Cannot be filtered on in the 'WHERE' clause.
report_country_code	string Country where impressions appeared. Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.
report_category_id	int64 Google product category ID to calculate the report for, represented in Google's product taxonomy. Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause.
traffic_source	TrafficSourceEnum Traffic source of impressions. Required in the SELECT clause.
rank	int64 Position of the domain in the top merchants ranking for the selected keys (date, report_category_id, report_country_code, traffic_source) based on impressions. 1 is the highest. Cannot be filtered on in the 'WHERE' clause.
ads_organic_ratio	double Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause.
page_overlap_rate	double Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page. Cannot be filtered on in the 'WHERE' clause.
higher_position_rate	double Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer. Cannot be filtered on in the 'WHERE' clause.

MarketingMethod

This type has no fields.

Marketing method used to promote your products on Google (organic versus ads).

MarketingMethodEnum

Marketing method values.

Enums
MARKETING_METHOD_ENUM_UNSPECIFIED	Not specified.
ORGANIC	Organic marketing.
ADS	Ads-based marketing.

NonProductPerformanceView

Fields available for query in non_product_performance_view table.

Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, clicks) and dimensions according to which performance metrics are segmented (for example, date).

Segment fields cannot be selected in queries without also selecting at least one metric field.

Values are only set for fields requested explicitly in the request's search query.

Fields
date	Date Date in the merchant timezone to which metrics apply. Segment. Condition on date is required in the WHERE clause.
week	Date First day of the week (Monday) of the metrics date in the merchant timezone. Segment.
clicks	int64 Number of clicks on images and online store links leading to your non-product pages. Metric.
impressions	int64 Number of times images and online store links leading to your non-product pages were shown. Metric.
click_through_rate	double Click-through rate - the number of clicks (clicks) divided by the number of impressions (impressions) of images and online store links leading to your non-product pages. Metric.

PriceCompetitivenessProductView

Fields available for query in price_competitiveness_product_view table.

Price competitiveness report.

Values are only set for fields requested explicitly in the request's search query.

Fields
price	Price Current price of the product.
benchmark_price	Price Latest available price benchmark for the product's catalog in the benchmark country.
report_country_code	string Country of the price benchmark. Represented in the ISO 3166 format. Required in the SELECT clause.
id	string REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the product_view table. Required in the SELECT clause.
offer_id	string Merchant-provided id of the product.
title	string Title of the product.
brand	string Brand of the product.
category_l1	string Product category (1st level) in Google's product taxonomy.
category_l2	string Product category (2nd level) in Google's product taxonomy.
category_l3	string Product category (3rd level) in Google's product taxonomy.
category_l4	string Product category (4th level) in Google's product taxonomy.
category_l5	string Product category (5th level) in Google's product taxonomy.
product_type_l1	string Product type (1st level) in merchant's own product taxonomy.
product_type_l2	string Product type (2nd level) in merchant's own product taxonomy.
product_type_l3	string Product type (3rd level) in merchant's own product taxonomy.
product_type_l4	string Product type (4th level) in merchant's own product taxonomy.
product_type_l5	string Product type (5th level) in merchant's own product taxonomy.

PriceInsightsProductView

Fields available for query in price_insights_product_view table.

Price insights report.

Values are only set for fields requested explicitly in the request's search query.

Fields
price	Price Current price of the product.
suggested_price	Price Latest suggested price for the product.
effectiveness	Effectiveness The predicted effectiveness of applying the price suggestion, bucketed.
id	string REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Can be used to join data with the product_view table. Required in the SELECT clause.
offer_id	string Merchant-provided id of the product.
title	string Title of the product.
brand	string Brand of the product.
category_l1	string Product category (1st level) in Google's product taxonomy.
category_l2	string Product category (2nd level) in Google's product taxonomy.
category_l3	string Product category (3rd level) in Google's product taxonomy.
category_l4	string Product category (4th level) in Google's product taxonomy.
category_l5	string Product category (5th level) in Google's product taxonomy.
product_type_l1	string Product type (1st level) in merchant's own product taxonomy.
product_type_l2	string Product type (2nd level) in merchant's own product taxonomy.
product_type_l3	string Product type (3rd level) in merchant's own product taxonomy.
product_type_l4	string Product type (4th level) in merchant's own product taxonomy.
product_type_l5	string Product type (5th level) in merchant's own product taxonomy.
predicted_impressions_change_fraction	double 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.
predicted_clicks_change_fraction	double 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.
predicted_conversions_change_fraction	double 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).

Effectiveness

Predicted effectiveness bucket.

Effectiveness indicates which products would benefit most from price changes. This rating takes into consideration the performance boost predicted by adjusting the sale price and the difference between your current price and the suggested price. Price suggestions with HIGH effectiveness are predicted to drive the largest increase in performance.

Enums
EFFECTIVENESS_UNSPECIFIED	Effectiveness is unknown.
LOW	Effectiveness is low.
MEDIUM	Effectiveness is medium.
HIGH	Effectiveness is high.

ProductPerformanceView

Fields available for query in product_performance_view table.

Product performance data for your account, including performance metrics (for example, clicks) and dimensions according to which performance metrics are segmented (for example, offer_id). Values of product dimensions, such as offer_id, reflect the state of a product at the time of the impression.

Segment fields cannot be selected in queries without also selecting at least one metric field.

Values are only set for fields requested explicitly in the request's search query.

Fields
date	Date Date in the merchant timezone to which metrics apply. Segment. Condition on date is required in the WHERE clause.
week	Date First day of the week (Monday) of the metrics date in the merchant timezone. Segment.
conversion_value	Price Value of conversions attributed to the product, reported on the conversion date. Metric. Available only for the FREE traffic source.
marketing_method	MarketingMethodEnum Marketing method to which metrics apply. Segment.
customer_country_code	string Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned.
offer_id	string Merchant-provided id of the product. Segment.
title	string Title of the product. Segment.
brand	string Brand of the product. Segment.
category_l1	string Product category (1st level) in Google's product taxonomy. Segment.
category_l2	string Product category (2nd level) in Google's product taxonomy. Segment.
category_l3	string Product category (3rd level) in Google's product taxonomy. Segment.
category_l4	string Product category (4th level) in Google's product taxonomy. Segment.
category_l5	string Product category (5th level) in Google's product taxonomy. Segment.
product_type_l1	string Product type (1st level) in merchant's own product taxonomy. Segment.
product_type_l2	string Product type (2nd level) in merchant's own product taxonomy. Segment.
product_type_l3	string Product type (3rd level) in merchant's own product taxonomy. Segment.
product_type_l4	string Product type (4th level) in merchant's own product taxonomy. Segment.
product_type_l5	string Product type (5th level) in merchant's own product taxonomy. Segment.
custom_label0	string Custom label 0 for custom grouping of products. Segment.
custom_label1	string Custom label 1 for custom grouping of products. Segment.
custom_label2	string Custom label 2 for custom grouping of products. Segment.
custom_label3	string Custom label 3 for custom grouping of products. Segment.
custom_label4	string Custom label 4 for custom grouping of products. Segment.
clicks	int64 Number of clicks. Metric.
impressions	int64 Number of times merchant's products are shown. Metric.
click_through_rate	double Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.
conversions	double 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. Metric. Available only for the FREE traffic source.
conversion_rate	double Number of conversions divided by the number of clicks, reported on the impression date. Metric. Available only for the FREE traffic source.

ProductView

Fields available for query in product_view table.

Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by id or list all products, Products sub-API should be used.

Values are only set for fields requested explicitly in the request's search query.

Fields
price	Price Product price. Absent if the information about the price of the product is not available.
gtin[]	string List of Global Trade Item Numbers (GTINs) of the product.
creation_time	Timestamp The time the merchant created the product in timestamp seconds.
expiration_date	Date Expiration date for the product, specified on insertion.
item_issues[]	ItemIssue List of item issues for the product. This field cannot be used for sorting the results. Only selected attributes of this field (for example, item_issues.severity.aggregated_severity) can be used for filtering the results.
click_potential	ClickPotential Estimated performance potential compared to highest performing products of the merchant.
id	string REST ID of the product, in the form of channel~languageCode~feedLabel~offerId. Merchant API methods that operate on products take this as their name parameter. Required in the SELECT clause.
channel	ChannelEnum Channel of the product. Can be ONLINE or LOCAL.
language_code	string Language code of the product in BCP 47 format.
feed_label	string Feed label of the product.
offer_id	string Merchant-provided id of the product.
title	string Title of the product.
brand	string Brand of the product.
category_l1	string Product category (1st level) in Google's product taxonomy.
category_l2	string Product category (2nd level) in Google's product taxonomy.
category_l3	string Product category (3rd level) in Google's product taxonomy.
category_l4	string Product category (4th level) in Google's product taxonomy.
category_l5	string Product category (5th level) in Google's product taxonomy.
product_type_l1	string Product type (1st level) in merchant's own product taxonomy.
product_type_l2	string Product type (2nd level) in merchant's own product taxonomy.
product_type_l3	string Product type (3rd level) in merchant's own product taxonomy.
product_type_l4	string Product type (4th level) in merchant's own product taxonomy.
product_type_l5	string Product type (5th level) in merchant's own product taxonomy.
condition	string Condition of the product.
availability	string Availability of the product.
shipping_label	string Normalized shipping label specified in the data source.
item_group_id	string Item group id provided by the merchant for grouping variants together.
thumbnail_link	string Link to the processed image of the product, hosted on the Google infrastructure.
aggregated_reporting_context_status	AggregatedReportingContextStatus Aggregated status.
click_potential_rank	int64 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.

AggregatedReportingContextStatus

Status of the product aggregated for all reporting contexts.

Here's an example of how the aggregated status is computed:

Free listings	Shopping ads	Status
Approved	Approved	ELIGIBLE
Approved	Pending	ELIGIBLE
Approved	Disapproved	ELIGIBLE_LIMITED
Pending	Pending	PENDING
Disapproved	Disapproved	NOT_ELIGIBLE_OR_DISAPPROVED

Enums
AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED	Not specified.
NOT_ELIGIBLE_OR_DISAPPROVED	Product is not eligible or is disapproved for all reporting contexts.
PENDING	Product's status is pending in all reporting contexts.
ELIGIBLE_LIMITED	Product is eligible for some (but not all) reporting contexts.
ELIGIBLE	Product is eligible for all reporting contexts.

ClickPotential

A product's click potential estimates its performance potential compared to highest performing products of the merchant. Click potential of a product helps merchants to prioritize which products to fix and helps them understand how products are performing against their potential.

Enums
CLICK_POTENTIAL_UNSPECIFIED	Unknown predicted clicks impact.
LOW	Potential to receive a low number of clicks compared to the highest performing products of the merchant.
MEDIUM	Potential to receive a moderate number of clicks compared to the highest performing products of the merchant.
HIGH	Potential to receive a similar number of clicks as the highest performing products of the merchant.

ItemIssue

Item issue associated with the product.

Fields
type	ItemIssueType Item issue type.
severity	ItemIssueSeverity Item issue severity.
resolution	ItemIssueResolution Item issue resolution.

ItemIssueResolution

How to resolve the issue.

Enums
ITEM_ISSUE_RESOLUTION_UNSPECIFIED	Not specified.
MERCHANT_ACTION	The merchant has to fix the issue.
PENDING_PROCESSING	The issue will be resolved automatically (for example, image crawl) or through a Google review. No merchant action is required now. Resolution might lead to another issue (for example, if crawl fails).

ItemIssueSeverity

How the issue affects the serving of the product.

Fields
severity_per_reporting_context[]	IssueSeverityPerReportingContext Issue severity per reporting context.
aggregated_severity	AggregatedIssueSeverity Aggregated severity of the issue for all reporting contexts it affects. This field can be used for filtering the results.

AggregatedIssueSeverity

Issue severity aggregated for all reporting contexts.

Enums
AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED	Not specified.
DISAPPROVED	Issue disapproves the product in at least one reporting context.
DEMOTED	Issue demotes the product in all reporting contexts it affects.
PENDING	Issue resolution is PENDING_PROCESSING.

IssueSeverityPerReportingContext

Issue severity per reporting context.

Fields
disapproved_countries[]	string List of disapproved countries in the reporting context, represented in ISO 3166 format.
demoted_countries[]	string List of demoted countries in the reporting context, represented in ISO 3166 format.
reporting_context	ReportingContextEnum Reporting context the issue applies to.

ItemIssueType

Issue type.

Fields
code	string Error code of the issue, equivalent to the code of Product issues.
canonical_attribute	string Canonical attribute name for attribute-specific issues.

RelativeDemand

This type has no fields.

Relative demand of a product cluster or brand in the Best sellers report.

RelativeDemandEnum

Relative demand values.

Enums
RELATIVE_DEMAND_ENUM_UNSPECIFIED	Not specified.
VERY_LOW	Demand is 0-5% of the demand of the highest ranked product cluster or brand.
LOW	Demand is 6-10% of the demand of the highest ranked product cluster or brand.
MEDIUM	Demand is 11-20% of the demand of the highest ranked product cluster or brand.
HIGH	Demand is 21-50% of the demand of the highest ranked product cluster or brand.
VERY_HIGH	Demand is 51-100% of the demand of the highest ranked product cluster or brand.

RelativeDemandChangeType

This type has no fields.

Relative demand of a product cluster or brand in the Best sellers report compared to the previous time period.

RelativeDemandChangeTypeEnum

Relative demand change type values.

Enums
RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED	Not specified.
SINKER	Relative demand is lower than the previous time period.
FLAT	Relative demand is equal to the previous time period.
RISER	Relative demand is higher than the previous time period.

ReportGranularity

This type has no fields.

Granularity of the Best sellers report. Best sellers reports are computed over a week and a month timeframe.

ReportGranularityEnum

Report granularity values.

Enums
REPORT_GRANULARITY_ENUM_UNSPECIFIED	Not specified.
WEEKLY	Report is computed over a week timeframe.
MONTHLY	Report is computed over a month timeframe.

ReportRow

Result row returned from the search query.

Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated.

Fields
product_performance_view	ProductPerformanceView Fields available for query in product_performance_view table.
non_product_performance_view	NonProductPerformanceView Fields available for query in non_product_performance_view table.
product_view	ProductView Fields available for query in product_view table.
price_competitiveness_product_view	PriceCompetitivenessProductView Fields available for query in price_competitiveness_product_view table.
price_insights_product_view	PriceInsightsProductView Fields available for query in price_insights_product_view table.
best_sellers_product_cluster_view	BestSellersProductClusterView Fields available for query in best_sellers_product_cluster_view table.
best_sellers_brand_view	BestSellersBrandView Fields available for query in best_sellers_brand_view table.
competitive_visibility_competitor_view	CompetitiveVisibilityCompetitorView Fields available for query in competitive_visibility_competitor_view table.
competitive_visibility_top_merchant_view	CompetitiveVisibilityTopMerchantView Fields available for query in competitive_visibility_top_merchant_view table.
competitive_visibility_benchmark_view	CompetitiveVisibilityBenchmarkView Fields available for query in competitive_visibility_benchmark_view table.

SearchRequest

Request message for the ReportService.Search method.

Fields
parent	string Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}
query	string Required. Query that defines a report to be retrieved. For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.
page_size	int32 Optional. Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.
page_token	string Optional. 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.

SearchResponse

Response message for the ReportService.Search method.

Fields
results[]	ReportRow Rows that matched the search query.
next_page_token	string Token which can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.

TrafficSource

This type has no fields.

Traffic source of impressions in the Competitive visibility report.

TrafficSourceEnum

Traffic source values.

Enums
TRAFFIC_SOURCE_ENUM_UNSPECIFIED	Not specified.
ORGANIC	Organic traffic.
ADS	Traffic from ads.
ALL	Organic and ads traffic.