feat: A new enum Effectiveness is added

Google APIs · copybara-github · commit 054146896ff3 · 2024-05-21T00:36:03.000-07:00
feat: A new field `effectiveness` is added to message `.google.shopping.merchant.reports.v1beta.PriceInsightsProductView`

docs: A comment for enum `AggregatedReportingContextStatus` is changed

docs: A comment for field `shipping_label` in message `.google.shopping.merchant.reports.v1beta.ProductView` is changed

docs: A comment for field `inventory_status` in message `.google.shopping.merchant.reports.v1beta.BestSellersProductClusterView` is changed

docs: A comment for field `brand_inventory_status` in message `.google.shopping.merchant.reports.v1beta.BestSellersProductClusterView` is changed
PiperOrigin-RevId: 635706104
diff --git a/google/shopping/merchant/reports/v1beta/reports.proto b/google/shopping/merchant/reports/v1beta/reports.proto
@@ -352,7 +352,7 @@ message ProductView {
   //
   // Here's an example of how the aggregated status is computed:
   //
-  // Free listings | Shopping Ads | Status
+  // Free listings | Shopping ads | Status
   // --------------|--------------|------------------------------
   // Approved      | Approved     | ELIGIBLE
   // Approved      | Pending      | ELIGIBLE
@@ -480,7 +480,7 @@ message ProductView {
 
   // Normalized [shipping
   // label](https://support.google.com/merchants/answer/6324504) specified in
-  // the feed.
+  // the data source.
   optional string shipping_label = 20;
 
   // List of Global Trade Item Numbers (GTINs) of the product.
@@ -607,6 +607,27 @@ message PriceCompetitivenessProductView {
 // Values are only set for fields requested explicitly in the request's search
 // query.
 message PriceInsightsProductView {
+  // 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.
+  enum Effectiveness {
+    // Effectiveness is unknown.
+    EFFECTIVENESS_UNSPECIFIED = 0;
+
+    // Effectiveness is low.
+    LOW = 1;
+
+    // Effectiveness is medium.
+    MEDIUM = 2;
+
+    // Effectiveness is high.
+    HIGH = 3;
+  }
+
   // REST ID of the product, in the form of
   // `channel~languageCode~feedLabel~offerId`. Can be used to join data with the
   // `product_view` table.
@@ -683,6 +704,9 @@ message PriceInsightsProductView {
   // suggested price compared to current active price. For example, 0.05 is a 5%
   // predicted increase in conversions).
   optional double predicted_conversions_change_fraction = 19;
+
+  // The predicted effectiveness of applying the price suggestion, bucketed.
+  Effectiveness effectiveness = 22;
 }
 
 // Fields available for query in `best_sellers_product_cluster_view` table.
@@ -778,16 +802,16 @@ message BestSellersProductClusterView {
   // GTINs of example variants of the product cluster.
   repeated string variant_gtins = 13;
 
-  // Whether the product cluster is `IN_STOCK` in your product feed in at least
-  // one of the countries, `OUT_OF_STOCK` in your product feed in all countries,
-  // or `NOT_IN_INVENTORY` at all.
+  // 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.
   optional InventoryStatus inventory_status = 14;
 
   // Whether there is at least one product of the brand currently `IN_STOCK` in
-  // your product feed in at least one of the countries, all products are
-  // `OUT_OF_STOCK` in your product feed in all countries, or
+  // 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.
