@google-shopping/reports 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.4.0](https://github.com/googleapis/google-cloud-node/compare/reports-v0.3.0...reports-v0.4.0) (2024-04-16)
+
+
+### Features
+
+* [merchantapi] add click potential to Reports sub-API publication ([#5222](https://github.com/googleapis/google-cloud-node/issues/5222)) ([02719b6](https://github.com/googleapis/google-cloud-node/commit/02719b6945141a7b35256c6d96228280da5bda0f))
+
 ## [0.3.0](https://github.com/googleapis/google-cloud-node/compare/reports-v0.2.0...reports-v0.3.0) (2024-03-29)
 
 

package/build/protos/google/shopping/merchant/reports/v1beta/reports.proto

@@ -60,7 +60,7 @@ message SearchRequest {
   string query = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-  // the maximum of 1000. Values above 1000 are coerced to 1000.
+  // 1000. Values above 5000 are coerced to 5000.
   int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Token of the page to retrieve. If not specified, the first page
@@ -378,6 +378,29 @@ message ProductView {
     ELIGIBLE = 4;
   }
 
+  // A product's [click
+  // potential](https://support.google.com/merchants/answer/188488) 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.
+  enum ClickPotential {
+    // Unknown predicted clicks impact.
+    CLICK_POTENTIAL_UNSPECIFIED = 0;
+
+    // Potential to receive a low number of clicks compared to the highest
+    // performing products of the merchant.
+    LOW = 1;
+
+    // Potential to receive a moderate number of clicks compared to the highest
+    // performing products of the merchant.
+    MEDIUM = 2;
+
+    // Potential to receive a similar number of clicks as the highest performing
+    // products of the merchant.
+    HIGH = 3;
+  }
+
   // 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.
@@ -488,6 +511,15 @@ message ProductView {
   // `item_issues.severity.aggregated_severity`) can be used for filtering the
   // results.**
   repeated ItemIssue item_issues = 27;
+
+  // Estimated performance potential compared to highest performing products of
+  // the merchant.
+  ClickPotential click_potential = 29;
+
+  // 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.
+  optional int64 click_potential_rank = 30;
 }
 
 // Fields available for query in `price_competitiveness_product_view` table.

package/build/protos/protos.d.ts

@@ -857,6 +857,12 @@ export namespace google {
 
                         /** ProductView itemIssues */
                         itemIssues?: (google.shopping.merchant.reports.v1beta.ProductView.IItemIssue[]|null);
+
+                        /** ProductView clickPotential */
+                        clickPotential?: (google.shopping.merchant.reports.v1beta.ProductView.ClickPotential|keyof typeof google.shopping.merchant.reports.v1beta.ProductView.ClickPotential|null);
+
+                        /** ProductView clickPotentialRank */
+                        clickPotentialRank?: (number|Long|string|null);
                     }
 
                     /** Represents a ProductView. */
@@ -952,6 +958,12 @@ export namespace google {
                         /** ProductView itemIssues. */
                         public itemIssues: google.shopping.merchant.reports.v1beta.ProductView.IItemIssue[];
 
+                        /** ProductView clickPotential. */
+                        public clickPotential: (google.shopping.merchant.reports.v1beta.ProductView.ClickPotential|keyof typeof google.shopping.merchant.reports.v1beta.ProductView.ClickPotential);
+
+                        /** ProductView clickPotentialRank. */
+                        public clickPotentialRank?: (number|Long|string|null);
+
                         /** ProductView _id. */
                         public _id?: "id";
 
@@ -1021,6 +1033,9 @@ export namespace google {
                         /** ProductView _aggregatedReportingContextStatus. */
                         public _aggregatedReportingContextStatus?: "aggregatedReportingContextStatus";
 
+                        /** ProductView _clickPotentialRank. */
+                        public _clickPotentialRank?: "clickPotentialRank";
+
                         /**
                          * Creates a new ProductView instance using the specified properties.
                          * @param [properties] Properties to set
@@ -1569,6 +1584,14 @@ export namespace google {
                             ELIGIBLE_LIMITED = 3,
                             ELIGIBLE = 4
                         }
+
+                        /** ClickPotential enum. */
+                        enum ClickPotential {
+                            CLICK_POTENTIAL_UNSPECIFIED = 0,
+                            LOW = 1,
+                            MEDIUM = 2,
+                            HIGH = 3
+                        }
                     }
 
                     /** Properties of a PriceCompetitivenessProductView. */

package/build/protos/protos.js

@@ -2394,6 +2394,8 @@
                              * @property {google.type.IDate|null} [expirationDate] ProductView expirationDate
                              * @property {google.shopping.merchant.reports.v1beta.ProductView.AggregatedReportingContextStatus|null} [aggregatedReportingContextStatus] ProductView aggregatedReportingContextStatus
                              * @property {Array.<google.shopping.merchant.reports.v1beta.ProductView.IItemIssue>|null} [itemIssues] ProductView itemIssues
+                             * @property {google.shopping.merchant.reports.v1beta.ProductView.ClickPotential|null} [clickPotential] ProductView clickPotential
+                             * @property {number|Long|null} [clickPotentialRank] ProductView clickPotentialRank
                              */
     
                             /**
@@ -2637,6 +2639,22 @@
                              */
                             ProductView.prototype.itemIssues = $util.emptyArray;
     
+                            /**
+                             * ProductView clickPotential.
+                             * @member {google.shopping.merchant.reports.v1beta.ProductView.ClickPotential} clickPotential
+                             * @memberof google.shopping.merchant.reports.v1beta.ProductView
+                             * @instance
+                             */
+                            ProductView.prototype.clickPotential = 0;
+    
+                            /**
+                             * ProductView clickPotentialRank.
+                             * @member {number|Long|null|undefined} clickPotentialRank
+                             * @memberof google.shopping.merchant.reports.v1beta.ProductView
+                             * @instance
+                             */
+                            ProductView.prototype.clickPotentialRank = null;
+    
                             // OneOf field names bound to virtual getters and setters
                             var $oneOfFields;
     
@@ -2893,6 +2911,17 @@
                                 set: $util.oneOfSetter($oneOfFields)
                             });
     
+                            /**
+                             * ProductView _clickPotentialRank.
+                             * @member {"clickPotentialRank"|undefined} _clickPotentialRank
+                             * @memberof google.shopping.merchant.reports.v1beta.ProductView
+                             * @instance
+                             */
+                            Object.defineProperty(ProductView.prototype, "_clickPotentialRank", {
+                                get: $util.oneOfGetter($oneOfFields = ["clickPotentialRank"]),
+                                set: $util.oneOfSetter($oneOfFields)
+                            });
+    
                             /**
                              * Creates a new ProductView instance using the specified properties.
                              * @function create
@@ -2975,6 +3004,10 @@
                                         $root.google.shopping.merchant.reports.v1beta.ProductView.ItemIssue.encode(message.itemIssues[i], writer.uint32(/* id 27, wireType 2 =*/218).fork()).ldelim();
                                 if (message.channel != null && Object.hasOwnProperty.call(message, "channel"))
                                     writer.uint32(/* id 28, wireType 0 =*/224).int32(message.channel);
+                                if (message.clickPotential != null && Object.hasOwnProperty.call(message, "clickPotential"))
+                                    writer.uint32(/* id 29, wireType 0 =*/232).int32(message.clickPotential);
+                                if (message.clickPotentialRank != null && Object.hasOwnProperty.call(message, "clickPotentialRank"))
+                                    writer.uint32(/* id 30, wireType 0 =*/240).int64(message.clickPotentialRank);
                                 return writer;
                             };
     
@@ -3125,6 +3158,14 @@
                                             message.itemIssues.push($root.google.shopping.merchant.reports.v1beta.ProductView.ItemIssue.decode(reader, reader.uint32()));
                                             break;
                                         }
+                                    case 29: {
+                                            message.clickPotential = reader.int32();
+                                            break;
+                                        }
+                                    case 30: {
+                                            message.clickPotentialRank = reader.int64();
+                                            break;
+                                        }
                                     default:
                                         reader.skipType(tag & 7);
                                         break;
@@ -3321,6 +3362,21 @@
                                             return "itemIssues." + error;
                                     }
                                 }
+                                if (message.clickPotential != null && message.hasOwnProperty("clickPotential"))
+                                    switch (message.clickPotential) {
+                                    default:
+                                        return "clickPotential: enum value expected";
+                                    case 0:
+                                    case 1:
+                                    case 2:
+                                    case 3:
+                                        break;
+                                    }
+                                if (message.clickPotentialRank != null && message.hasOwnProperty("clickPotentialRank")) {
+                                    properties._clickPotentialRank = 1;
+                                    if (!$util.isInteger(message.clickPotentialRank) && !(message.clickPotentialRank && $util.isInteger(message.clickPotentialRank.low) && $util.isInteger(message.clickPotentialRank.high)))
+                                        return "clickPotentialRank: integer|Long expected";
+                                }
                                 return null;
                             };
     
@@ -3458,6 +3514,39 @@
                                         message.itemIssues[i] = $root.google.shopping.merchant.reports.v1beta.ProductView.ItemIssue.fromObject(object.itemIssues[i]);
                                     }
                                 }
+                                switch (object.clickPotential) {
+                                default:
+                                    if (typeof object.clickPotential === "number") {
+                                        message.clickPotential = object.clickPotential;
+                                        break;
+                                    }
+                                    break;
+                                case "CLICK_POTENTIAL_UNSPECIFIED":
+                                case 0:
+                                    message.clickPotential = 0;
+                                    break;
+                                case "LOW":
+                                case 1:
+                                    message.clickPotential = 1;
+                                    break;
+                                case "MEDIUM":
+                                case 2:
+                                    message.clickPotential = 2;
+                                    break;
+                                case "HIGH":
+                                case 3:
+                                    message.clickPotential = 3;
+                                    break;
+                                }
+                                if (object.clickPotentialRank != null)
+                                    if ($util.Long)
+                                        (message.clickPotentialRank = $util.Long.fromValue(object.clickPotentialRank)).unsigned = false;
+                                    else if (typeof object.clickPotentialRank === "string")
+                                        message.clickPotentialRank = parseInt(object.clickPotentialRank, 10);
+                                    else if (typeof object.clickPotentialRank === "number")
+                                        message.clickPotentialRank = object.clickPotentialRank;
+                                    else if (typeof object.clickPotentialRank === "object")
+                                        message.clickPotentialRank = new $util.LongBits(object.clickPotentialRank.low >>> 0, object.clickPotentialRank.high >>> 0).toNumber();
                                 return message;
                             };
     
@@ -3482,6 +3571,7 @@
                                     object.price = null;
                                     object.creationTime = null;
                                     object.expirationDate = null;
+                                    object.clickPotential = options.enums === String ? "CLICK_POTENTIAL_UNSPECIFIED" : 0;
                                 }
                                 if (message.id != null && message.hasOwnProperty("id")) {
                                     object.id = message.id;
@@ -3614,6 +3704,16 @@
                                     if (options.oneofs)
                                         object._channel = "channel";
                                 }
+                                if (message.clickPotential != null && message.hasOwnProperty("clickPotential"))
+                                    object.clickPotential = options.enums === String ? $root.google.shopping.merchant.reports.v1beta.ProductView.ClickPotential[message.clickPotential] === undefined ? message.clickPotential : $root.google.shopping.merchant.reports.v1beta.ProductView.ClickPotential[message.clickPotential] : message.clickPotential;
+                                if (message.clickPotentialRank != null && message.hasOwnProperty("clickPotentialRank")) {
+                                    if (typeof message.clickPotentialRank === "number")
+                                        object.clickPotentialRank = options.longs === String ? String(message.clickPotentialRank) : message.clickPotentialRank;
+                                    else
+                                        object.clickPotentialRank = options.longs === String ? $util.Long.prototype.toString.call(message.clickPotentialRank) : options.longs === Number ? new $util.LongBits(message.clickPotentialRank.low >>> 0, message.clickPotentialRank.high >>> 0).toNumber() : message.clickPotentialRank;
+                                    if (options.oneofs)
+                                        object._clickPotentialRank = "clickPotentialRank";
+                                }
                                 return object;
                             };
     
@@ -4939,6 +5039,24 @@
                                 return values;
                             })();
     
+                            /**
+                             * ClickPotential enum.
+                             * @name google.shopping.merchant.reports.v1beta.ProductView.ClickPotential
+                             * @enum {number}
+                             * @property {number} CLICK_POTENTIAL_UNSPECIFIED=0 CLICK_POTENTIAL_UNSPECIFIED value
+                             * @property {number} LOW=1 LOW value
+                             * @property {number} MEDIUM=2 MEDIUM value
+                             * @property {number} HIGH=3 HIGH value
+                             */
+                            ProductView.ClickPotential = (function() {
+                                var valuesById = {}, values = Object.create(valuesById);
+                                values[valuesById[0] = "CLICK_POTENTIAL_UNSPECIFIED"] = 0;
+                                values[valuesById[1] = "LOW"] = 1;
+                                values[valuesById[2] = "MEDIUM"] = 2;
+                                values[valuesById[3] = "HIGH"] = 3;
+                                return values;
+                            })();
+    
                             return ProductView;
                         })();
     

package/build/protos/protos.json

@@ -563,6 +563,11 @@
                               "oneof": [
                                 "aggregatedReportingContextStatus"
                               ]
+                            },
+                            "_clickPotentialRank": {
+                              "oneof": [
+                                "clickPotentialRank"
+                              ]
                             }
                           },
                           "fields": {
@@ -748,6 +753,17 @@
                               "rule": "repeated",
                               "type": "ItemIssue",
                               "id": 27
+                            },
+                            "clickPotential": {
+                              "type": "ClickPotential",
+                              "id": 29
+                            },
+                            "clickPotentialRank": {
+                              "type": "int64",
+                              "id": 30,
+                              "options": {
+                                "proto3_optional": true
+                              }
                             }
                           },
                           "nested": {
@@ -885,6 +901,14 @@
                                 "ELIGIBLE_LIMITED": 3,
                                 "ELIGIBLE": 4
                               }
+                            },
+                            "ClickPotential": {
+                              "values": {
+                                "CLICK_POTENTIAL_UNSPECIFIED": 0,
+                                "LOW": 1,
+                                "MEDIUM": 2,
+                                "HIGH": 3
+                              }
                             }
                           }
                         },

package/build/src/v1beta/report_service_client.d.ts

@@ -131,7 +131,7 @@ export declare class ReportServiceClient {
      *   fields.
      * @param {number} [request.pageSize]
      *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-     *   the maximum of 1000. Values above 1000 are coerced to 1000.
+     *   1000. Values above 5000 are coerced to 5000.
      * @param {string} [request.pageToken]
      *   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
@@ -171,7 +171,7 @@ export declare class ReportServiceClient {
      *   fields.
      * @param {number} [request.pageSize]
      *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-     *   the maximum of 1000. Values above 1000 are coerced to 1000.
+     *   1000. Values above 5000 are coerced to 5000.
      * @param {string} [request.pageToken]
      *   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
@@ -206,7 +206,7 @@ export declare class ReportServiceClient {
      *   fields.
      * @param {number} [request.pageSize]
      *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-     *   the maximum of 1000. Values above 1000 are coerced to 1000.
+     *   1000. Values above 5000 are coerced to 5000.
      * @param {string} [request.pageToken]
      *   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

package/build/src/v1beta/report_service_client.js

@@ -298,7 +298,7 @@ class ReportServiceClient {
      *   fields.
      * @param {number} [request.pageSize]
      *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-     *   the maximum of 1000. Values above 1000 are coerced to 1000.
+     *   1000. Values above 5000 are coerced to 5000.
      * @param {string} [request.pageToken]
      *   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
@@ -347,7 +347,7 @@ class ReportServiceClient {
      *   fields.
      * @param {number} [request.pageSize]
      *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-     *   the maximum of 1000. Values above 1000 are coerced to 1000.
+     *   1000. Values above 5000 are coerced to 5000.
      * @param {string} [request.pageToken]
      *   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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-shopping/reports",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Merchant API client for Node.js",
   "repository": {
     "type": "git",