Skip to content

Commit 0da7370

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: [google-shopping-merchant-reports] add non_product_performance_view table to Reports sub-API (#12718)
- [ ] Regenerate this pull request now. feat: add `effectiveness` field to `price_insights_product_view` table in Reports sub-API BEGIN_COMMIT_OVERRIDE feat: add non_product_performance_view table to Reports sub-API feat: add a new enum `Effectiveness` feat: add a new field `effectiveness` to message `.google.shopping.merchant.reports.v1beta.PriceInsightsProductView` END_COMMIT_OVERRIDE PiperOrigin-RevId: 635777166 Source-Link: googleapis/googleapis@57514fb Source-Link: googleapis/googleapis-gen@5648357 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXNob3BwaW5nLW1lcmNoYW50LXJlcG9ydHMvLk93bEJvdC55YW1sIiwiaCI6IjU2NDgzNTc5MjM2NWI4MGZmNmUwMjQ4YjUwY2RhODE4YmQxOGMwZTUifQ== BEGIN_NESTED_COMMIT feat: [google-shopping-merchant-reports] 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== END_NESTED_COMMIT --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 57704b4 commit 0da7370

4 files changed

Lines changed: 131 additions & 8 deletions

File tree

‎packages/google-shopping-merchant-reports/google/shopping/merchant_reports/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
CompetitiveVisibilityCompetitorView,
3232
CompetitiveVisibilityTopMerchantView,
3333
MarketingMethod,
34+
NonProductPerformanceView,
3435
PriceCompetitivenessProductView,
3536
PriceInsightsProductView,
3637
ProductPerformanceView,
@@ -53,6 +54,7 @@
5354
"CompetitiveVisibilityCompetitorView",
5455
"CompetitiveVisibilityTopMerchantView",
5556
"MarketingMethod",
57+
"NonProductPerformanceView",
5658
"PriceCompetitivenessProductView",
5759
"PriceInsightsProductView",
5860
"ProductPerformanceView",

‎packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1beta/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
CompetitiveVisibilityCompetitorView,
2727
CompetitiveVisibilityTopMerchantView,
2828
MarketingMethod,
29+
NonProductPerformanceView,
2930
PriceCompetitivenessProductView,
3031
PriceInsightsProductView,
3132
ProductPerformanceView,
@@ -47,6 +48,7 @@
4748
"CompetitiveVisibilityCompetitorView",
4849
"CompetitiveVisibilityTopMerchantView",
4950
"MarketingMethod",
51+
"NonProductPerformanceView",
5052
"PriceCompetitivenessProductView",
5153
"PriceInsightsProductView",
5254
"ProductPerformanceView",

‎packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1beta/types/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
CompetitiveVisibilityCompetitorView,
2121
CompetitiveVisibilityTopMerchantView,
2222
MarketingMethod,
23+
NonProductPerformanceView,
2324
PriceCompetitivenessProductView,
2425
PriceInsightsProductView,
2526
ProductPerformanceView,
@@ -40,6 +41,7 @@
4041
"CompetitiveVisibilityCompetitorView",
4142
"CompetitiveVisibilityTopMerchantView",
4243
"MarketingMethod",
44+
"NonProductPerformanceView",
4345
"PriceCompetitivenessProductView",
4446
"PriceInsightsProductView",
4547
"ProductPerformanceView",

‎packages/google-shopping-merchant-reports/google/shopping/merchant_reports_v1beta/types/reports.py‎

Lines changed: 125 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"PriceInsightsProductView",
3535
"BestSellersProductClusterView",
3636
"BestSellersBrandView",
37+
"NonProductPerformanceView",
3738
"CompetitiveVisibilityCompetitorView",
3839
"CompetitiveVisibilityTopMerchantView",
3940
"CompetitiveVisibilityBenchmarkView",
@@ -127,6 +128,9 @@ class ReportRow(proto.Message):
127128
product_performance_view (google.shopping.merchant_reports_v1beta.types.ProductPerformanceView):
128129
Fields available for query in ``product_performance_view``
129130
table.
131+
non_product_performance_view (google.shopping.merchant_reports_v1beta.types.NonProductPerformanceView):
132+
Fields available for query in
133+
``non_product_performance_view`` table.
130134
product_view (google.shopping.merchant_reports_v1beta.types.ProductView):
131135
Fields available for query in ``product_view`` table.
132136
price_competitiveness_product_view (google.shopping.merchant_reports_v1beta.types.PriceCompetitivenessProductView):
@@ -157,6 +161,11 @@ class ReportRow(proto.Message):
157161
number=1,
158162
message="ProductPerformanceView",
159163
)
164+
non_product_performance_view: "NonProductPerformanceView" = proto.Field(
165+
proto.MESSAGE,
166+
number=7,
167+
message="NonProductPerformanceView",
168+
)
160169
product_view: "ProductView" = proto.Field(
161170
proto.MESSAGE,
162171
number=2,
@@ -643,7 +652,7 @@ class ProductView(proto.Message):
643652
shipping_label (str):
644653
Normalized `shipping
645654
label <https://support.google.com/merchants/answer/6324504>`__
646-
specified in the feed.
655+
specified in the data source.
647656
648657
This field is a member of `oneof`_ ``_shipping_label``.
649658
gtin (MutableSequence[str]):
@@ -694,7 +703,7 @@ class AggregatedReportingContextStatus(proto.Enum):
694703
695704
Here's an example of how the aggregated status is computed:
696705
697-
Free listings \| Shopping Ads \| Status
706+
Free listings \| Shopping ads \| Status
698707
--------------|--------------|------------------------------
699708
Approved \| Approved \| ELIGIBLE Approved \| Pending \| ELIGIBLE
700709
Approved \| Disapproved \| ELIGIBLE_LIMITED Pending \| Pending \|
@@ -1368,8 +1377,36 @@ class PriceInsightsProductView(proto.Message):
13681377
5% predicted increase in conversions).
13691378
13701379
This field is a member of `oneof`_ ``_predicted_conversions_change_fraction``.
1380+
effectiveness (google.shopping.merchant_reports_v1beta.types.PriceInsightsProductView.Effectiveness):
1381+
The predicted effectiveness of applying the
1382+
price suggestion, bucketed.
13711383
"""
13721384

1385+
class Effectiveness(proto.Enum):
1386+
r"""Predicted effectiveness bucket.
1387+
1388+
Effectiveness indicates which products would benefit most from price
1389+
changes. This rating takes into consideration the performance boost
1390+
predicted by adjusting the sale price and the difference between
1391+
your current price and the suggested price. Price suggestions with
1392+
``HIGH`` effectiveness are predicted to drive the largest increase
1393+
in performance.
1394+
1395+
Values:
1396+
EFFECTIVENESS_UNSPECIFIED (0):
1397+
Effectiveness is unknown.
1398+
LOW (1):
1399+
Effectiveness is low.
1400+
MEDIUM (2):
1401+
Effectiveness is medium.
1402+
HIGH (3):
1403+
Effectiveness is high.
1404+
"""
1405+
EFFECTIVENESS_UNSPECIFIED = 0
1406+
LOW = 1
1407+
MEDIUM = 2
1408+
HIGH = 3
1409+
13731410
id: str = proto.Field(
13741411
proto.STRING,
13751412
number=1,
@@ -1465,6 +1502,11 @@ class PriceInsightsProductView(proto.Message):
14651502
number=19,
14661503
optional=True,
14671504
)
1505+
effectiveness: Effectiveness = proto.Field(
1506+
proto.ENUM,
1507+
number=22,
1508+
enum=Effectiveness,
1509+
)
14681510

14691511

14701512
class BestSellersProductClusterView(proto.Message):
@@ -1563,19 +1605,20 @@ class BestSellersProductClusterView(proto.Message):
15631605
cluster.
15641606
inventory_status (google.shopping.merchant_reports_v1beta.types.BestSellersProductClusterView.InventoryStatus):
15651607
Whether the product cluster is ``IN_STOCK`` in your product
1566-
feed in at least one of the countries, ``OUT_OF_STOCK`` in
1567-
your product feed in all countries, or ``NOT_IN_INVENTORY``
1568-
at all.
1608+
data source in at least one of the countries,
1609+
``OUT_OF_STOCK`` in your product data source in all
1610+
countries, or ``NOT_IN_INVENTORY`` at all.
15691611
15701612
The field doesn't take the Best sellers report country
15711613
filter into account.
15721614
15731615
This field is a member of `oneof`_ ``_inventory_status``.
15741616
brand_inventory_status (google.shopping.merchant_reports_v1beta.types.BestSellersProductClusterView.InventoryStatus):
15751617
Whether there is at least one product of the brand currently
1576-
``IN_STOCK`` in your product feed in at least one of the
1577-
countries, all products are ``OUT_OF_STOCK`` in your product
1578-
feed in all countries, or ``NOT_IN_INVENTORY``.
1618+
``IN_STOCK`` in your product data source in at least one of
1619+
the countries, all products are ``OUT_OF_STOCK`` in your
1620+
product data source in all countries, or
1621+
``NOT_IN_INVENTORY``.
15791622
15801623
The field doesn't take the Best sellers report country
15811624
filter into account.
@@ -1882,6 +1925,80 @@ class BestSellersBrandView(proto.Message):
18821925
)
18831926

18841927

1928+
class NonProductPerformanceView(proto.Message):
1929+
r"""Fields available for query in ``non_product_performance_view``
1930+
table.
1931+
1932+
Performance data on images and online store links leading to your
1933+
non-product pages. This includes performance metrics (for example,
1934+
``clicks``) and dimensions according to which performance metrics
1935+
are segmented (for example, ``date``).
1936+
1937+
Segment fields cannot be selected in queries without also selecting
1938+
at least one metric field.
1939+
1940+
Values are only set for fields requested explicitly in the request's
1941+
search query.
1942+
1943+
1944+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1945+
1946+
Attributes:
1947+
date (google.type.date_pb2.Date):
1948+
Date in the merchant timezone to which metrics apply.
1949+
Segment.
1950+
1951+
Condition on ``date`` is required in the ``WHERE`` clause.
1952+
week (google.type.date_pb2.Date):
1953+
First day of the week (Monday) of the metrics
1954+
date in the merchant timezone. Segment.
1955+
clicks (int):
1956+
Number of clicks on images and online store
1957+
links leading to your non-product pages. Metric.
1958+
1959+
This field is a member of `oneof`_ ``_clicks``.
1960+
impressions (int):
1961+
Number of times images and online store links
1962+
leading to your non-product pages were shown.
1963+
Metric.
1964+
1965+
This field is a member of `oneof`_ ``_impressions``.
1966+
click_through_rate (float):
1967+
Click-through rate - the number of clicks (``clicks``)
1968+
divided by the number of impressions (``impressions``) of
1969+
images and online store links leading to your non-product
1970+
pages. Metric.
1971+
1972+
This field is a member of `oneof`_ ``_click_through_rate``.
1973+
"""
1974+
1975+
date: date_pb2.Date = proto.Field(
1976+
proto.MESSAGE,
1977+
number=1,
1978+
message=date_pb2.Date,
1979+
)
1980+
week: date_pb2.Date = proto.Field(
1981+
proto.MESSAGE,
1982+
number=2,
1983+
message=date_pb2.Date,
1984+
)
1985+
clicks: int = proto.Field(
1986+
proto.INT64,
1987+
number=3,
1988+
optional=True,
1989+
)
1990+
impressions: int = proto.Field(
1991+
proto.INT64,
1992+
number=4,
1993+
optional=True,
1994+
)
1995+
click_through_rate: float = proto.Field(
1996+
proto.DOUBLE,
1997+
number=5,
1998+
optional=True,
1999+
)
2000+
2001+
18852002
class CompetitiveVisibilityCompetitorView(proto.Message):
18862003
r"""Fields available for query in
18872004
``competitive_visibility_competitor_view`` table.

0 commit comments

Comments
 (0)