Skip to content

Commit 9e5778c

Browse files
feat: [merchantapi] add non_product_performance_view table to Reports sub-API (#5372)
* feat: A new enum `Effectiveness` is added 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 Source-Link: googleapis/googleapis@0541468 Source-Link: googleapis/googleapis-gen@809fa15 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXNob3BwaW5nLW1lcmNoYW50LXJlcG9ydHMvLk93bEJvdC55YW1sIiwiaCI6IjgwOWZhMTVlNDI1YTQyNjQ1MjYxMDA0NDI2YjZiYTc3Njc2N2FjMjMifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add `non_product_performance_view` table to Reports sub-API feat: add `effectiveness` field to `price_insights_product_view` table in Reports sub-API PiperOrigin-RevId: 635777166 Source-Link: googleapis/googleapis@57514fb Source-Link: googleapis/googleapis-gen@5648357 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXNob3BwaW5nLW1lcmNoYW50LXJlcG9ydHMvLk93bEJvdC55YW1sIiwiaCI6IjU2NDgzNTc5MjM2NWI4MGZmNmUwMjQ4YjUwY2RhODE4YmQxOGMwZTUifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Daniel Bankhead <[email protected]>
1 parent b0fbf7b commit 9e5778c

5 files changed

Lines changed: 765 additions & 8 deletions

File tree

packages/google-shopping-merchant-reports/protos/google/shopping/merchant/reports/v1beta/reports.proto

Lines changed: 70 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ message ReportRow {
8989
// Fields available for query in `product_performance_view` table.
9090
ProductPerformanceView product_performance_view = 1;
9191

92+
// Fields available for query in `non_product_performance_view` table.
93+
NonProductPerformanceView non_product_performance_view = 7;
94+
9295
// Fields available for query in `product_view` table.
9396
ProductView product_view = 2;
9497

@@ -352,7 +355,7 @@ message ProductView {
352355
//
353356
// Here's an example of how the aggregated status is computed:
354357
//
355-
// Free listings | Shopping Ads | Status
358+
// Free listings | Shopping ads | Status
356359
// --------------|--------------|------------------------------
357360
// Approved | Approved | ELIGIBLE
358361
// Approved | Pending | ELIGIBLE
@@ -480,7 +483,7 @@ message ProductView {
480483

481484
// Normalized [shipping
482485
// label](https://support.google.com/merchants/answer/6324504) specified in
483-
// the feed.
486+
// the data source.
484487
optional string shipping_label = 20;
485488

486489
// List of Global Trade Item Numbers (GTINs) of the product.
@@ -607,6 +610,27 @@ message PriceCompetitivenessProductView {
607610
// Values are only set for fields requested explicitly in the request's search
608611
// query.
609612
message PriceInsightsProductView {
613+
// Predicted effectiveness bucket.
614+
//
615+
// Effectiveness indicates which products would benefit most from price
616+
// changes. This rating takes into consideration the performance boost
617+
// predicted by adjusting the sale price and the difference between your
618+
// current price and the suggested price. Price suggestions with `HIGH`
619+
// effectiveness are predicted to drive the largest increase in performance.
620+
enum Effectiveness {
621+
// Effectiveness is unknown.
622+
EFFECTIVENESS_UNSPECIFIED = 0;
623+
624+
// Effectiveness is low.
625+
LOW = 1;
626+
627+
// Effectiveness is medium.
628+
MEDIUM = 2;
629+
630+
// Effectiveness is high.
631+
HIGH = 3;
632+
}
633+
610634
// REST ID of the product, in the form of
611635
// `channel~languageCode~feedLabel~offerId`. Can be used to join data with the
612636
// `product_view` table.
@@ -683,6 +707,9 @@ message PriceInsightsProductView {
683707
// suggested price compared to current active price. For example, 0.05 is a 5%
684708
// predicted increase in conversions).
685709
optional double predicted_conversions_change_fraction = 19;
710+
711+
// The predicted effectiveness of applying the price suggestion, bucketed.
712+
Effectiveness effectiveness = 22;
686713
}
687714

688715
// Fields available for query in `best_sellers_product_cluster_view` table.
@@ -778,16 +805,16 @@ message BestSellersProductClusterView {
778805
// GTINs of example variants of the product cluster.
779806
repeated string variant_gtins = 13;
780807

781-
// Whether the product cluster is `IN_STOCK` in your product feed in at least
782-
// one of the countries, `OUT_OF_STOCK` in your product feed in all countries,
783-
// or `NOT_IN_INVENTORY` at all.
808+
// Whether the product cluster is `IN_STOCK` in your product data source in at
809+
// least one of the countries, `OUT_OF_STOCK` in your product data source in
810+
// all countries, or `NOT_IN_INVENTORY` at all.
784811
//
785812
// The field doesn't take the Best sellers report country filter into account.
786813
optional InventoryStatus inventory_status = 14;
787814

788815
// Whether there is at least one product of the brand currently `IN_STOCK` in
789-
// your product feed in at least one of the countries, all products are
790-
// `OUT_OF_STOCK` in your product feed in all countries, or
816+
// your product data source in at least one of the countries, all products are
817+
// `OUT_OF_STOCK` in your product data source in all countries, or
791818
// `NOT_IN_INVENTORY`.
792819
//
793820
// The field doesn't take the Best sellers report country filter into account.
@@ -878,6 +905,42 @@ message BestSellersBrandView {
878905
relative_demand_change = 11;
879906
}
880907

908+
// Fields available for query in `non_product_performance_view` table.
909+
//
910+
// Performance data on images and online store links leading to your non-product
911+
// pages. This includes performance metrics (for example, `clicks`)
912+
// and dimensions according to which performance metrics are segmented (for
913+
// example, `date`).
914+
//
915+
// Segment fields cannot be selected in queries without also selecting at least
916+
// one metric field.
917+
//
918+
// Values are only set for fields requested explicitly in the request's search
919+
// query.
920+
message NonProductPerformanceView {
921+
// Date in the merchant timezone to which metrics apply. Segment.
922+
//
923+
// Condition on `date` is required in the `WHERE` clause.
924+
google.type.Date date = 1;
925+
926+
// First day of the week (Monday) of the metrics date in the merchant
927+
// timezone. Segment.
928+
google.type.Date week = 2;
929+
930+
// Number of clicks on images and online store links leading to your
931+
// non-product pages. Metric.
932+
optional int64 clicks = 3;
933+
934+
// Number of times images and online store links leading to your non-product
935+
// pages were shown. Metric.
936+
optional int64 impressions = 4;
937+
938+
// Click-through rate - the number of clicks (`clicks`) divided by the number
939+
// of impressions (`impressions`) of images and online store links leading to
940+
// your non-product pages. Metric.
941+
optional double click_through_rate = 5;
942+
}
943+
881944
// Fields available for query in `competitive_visibility_competitor_view` table.
882945
//
883946
// [Competitive

packages/google-shopping-merchant-reports/protos/protos.d.ts

Lines changed: 153 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)