@google-shopping/reports 0.14.0 → 0.15.0

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

@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -60,11 +60,11 @@ message SearchRequest {
   // For details on how to construct your query, see the [Query Language
   // guide](/merchant/api/guides/reports/query-language). For the full list of
   // available tables and fields, see the [Available
-  // fields](/merchant/api/reference/rest/reports_v1/accounts.reports).
+  // fields][google.shopping.merchant.reports.v1.ReportRow].
   string query = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
-  // 1000. Values above 5000 are coerced to 5000.
+  // 1000. Values above 100,000 are coerced to 100,000.
   int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Token of the page to retrieve. If not specified, the first page
@@ -158,6 +158,13 @@ message ProductPerformanceView {
   // returned.
   optional string customer_country_code = 4;
 
+  // Store type to which metrics apply. Can be `ONLINE_STORE` or
+  // `LOCAL_STORES`. Segment.
+  //
+  // For `LOCAL_STORES` store type, further segmentation by a specific store
+  // is not available.
+  optional StoreType.StoreTypeEnum store_type = 32;
+
   // Merchant-provided id of the product. Segment.
   optional string offer_id = 5;
 
@@ -266,16 +273,16 @@ message ProductPerformanceView {
 
 // 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.
+// Products in the current inventory. Products in this table are the
+// same as a [Product resource in Products
+// sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products)
+// 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.
-//
 message ProductView {
   // Item issue associated with the product.
   message ItemIssue {
@@ -322,11 +329,18 @@ message ProductView {
       }
 
       // Issue severity per reporting context.
+      //
+      // Reporting contexts included in this list can be restricted using a
+      // filter on the `reporting_context` field.
       repeated IssueSeverityPerReportingContext severity_per_reporting_context =
           1;
 
       // Aggregated severity of the issue for all reporting contexts it affects.
       //
+      // Reporting contexts included in the computation of the aggregated
+      // severity can be restricted using a filter on the `reporting_context`
+      // field.
+      //
       // **This field can be used for filtering the results.**
       optional AggregatedIssueSeverity aggregated_severity = 2;
     }
@@ -355,8 +369,37 @@ message ProductView {
     optional ItemIssueResolution resolution = 3;
   }
 
+  // Status of the product for a specific reporting context.
+  //
+  // Equivalent to
+  // [`DestinationStatus`][google.shopping.merchant.products.v1.ProductStatus.DestinationStatus]
+  // in Products API.
+  message StatusPerReportingContext {
+    // Reporting context the status applies to.
+    optional google.shopping.type.ReportingContext.ReportingContextEnum
+        reporting_context = 1;
+
+    // List of approved countries in the reporting context, represented in
+    // [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for
+    // example, `US`.
+    repeated string approved_countries = 2;
+
+    // List of disapproved countries in the reporting context, represented in
+    // [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for
+    // example, `US`.
+    repeated string disapproved_countries = 3;
+
+    // List of pending countries in the reporting context, represented in
+    // [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for
+    // example, `US`.
+    repeated string pending_countries = 4;
+  }
+
   // Status of the product aggregated for all reporting contexts.
   //
+  // Reporting contexts included in the computation of the aggregated status can
+  // be restricted using a filter on the `reporting_context` field.
+  //
   // Here's an example of how the aggregated status is computed:
   //
   // Free listings | Shopping ads | Status
@@ -372,16 +415,18 @@ message ProductView {
     // Not specified.
     AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED = 0;
 
-    // Product is not eligible or is disapproved for all reporting contexts.
+    // Product is not eligible or is disapproved for all reporting contexts and
+    // countries.
     NOT_ELIGIBLE_OR_DISAPPROVED = 1;
 
-    // Product's status is pending in all reporting contexts.
+    // Product's status is pending in all reporting contexts and countries.
     PENDING = 2;
 
-    // Product is eligible for some (but not all) reporting contexts.
+    // Product is eligible for some (but not all) reporting contexts and
+    // countries.
     ELIGIBLE_LIMITED = 3;
 
-    // Product is eligible for all reporting contexts.
+    // Product is eligible for all reporting contexts and countries.
     ELIGIBLE = 4;
   }
 
@@ -506,10 +551,36 @@ message ProductView {
   // Expiration date for the product, specified on insertion.
   google.type.Date expiration_date = 25;
 
-  // Aggregated status.
+  // Aggregated status across all reporting contexts.
+  //
+  // Reporting contexts included in the computation of the aggregated status can
+  // be restricted using a filter on the `reporting_context` field.
   optional AggregatedReportingContextStatus
       aggregated_reporting_context_status = 26;
 
+  // Detailed product status per reporting context.
+  //
+  // Reporting contexts included in this list can be restricted using a filter
+  // on the `reporting_context` field.
+  //
+  // Equivalent to
+  // [`ProductStatus.destination_statuses`][google.shopping.merchant.products.v1.ProductStatus]
+  // in Products API.
+  //
+  // **This field cannot be used for sorting or filtering the results.**
+  repeated StatusPerReportingContext status_per_reporting_context = 32;
+
+  // Reporting context to restrict the query to.
+  //
+  // Restricts the reporting contexts returned in `status_per_reporting_context`
+  // and `item_issues`, and used to compute
+  // `aggregated_reporting_context_status`.
+  //
+  // **This field can only be used in the `WHERE` clause and cannot be selected
+  // in the `SELECT` clause.**
+  optional google.shopping.type.ReportingContext.ReportingContextEnum
+      reporting_context = 33;
+
   // List of item issues for the product.
   //
   // **This field cannot be used for sorting the results.**
@@ -523,9 +594,8 @@ message ProductView {
   // 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.
+  // Normalized click potential of the product. Values range from 1 to 1000,
+  // where 1 is the highest click potential and 1000 is the theoretical lowest.
   optional int64 click_potential_rank = 30;
 }
 
@@ -1175,6 +1245,21 @@ message MarketingMethod {
   }
 }
 
+// Store where the product is sold (online versus local stores).
+message StoreType {
+  // Store types.
+  enum StoreTypeEnum {
+    // Not specified.
+    STORE_TYPE_ENUM_UNSPECIFIED = 0;
+
+    // Online store.
+    ONLINE_STORE = 1;
+
+    // Local (physical) stores.
+    LOCAL_STORES = 2;
+  }
+}
+
 // Granularity of the Best sellers report. Best sellers reports are computed
 // over a week and a month timeframe.
 message ReportGranularity {

package/build/protos/protos.d.ts

@@ -458,6 +458,9 @@ export namespace google {
                         /** ProductPerformanceView customerCountryCode */
                         customerCountryCode?: (string|null);
 
+                        /** ProductPerformanceView storeType */
+                        storeType?: (google.shopping.merchant.reports.v1.StoreType.StoreTypeEnum|keyof typeof google.shopping.merchant.reports.v1.StoreType.StoreTypeEnum|null);
+
                         /** ProductPerformanceView offerId */
                         offerId?: (string|null);
 
@@ -552,6 +555,9 @@ export namespace google {
                         /** ProductPerformanceView customerCountryCode. */
                         public customerCountryCode?: (string|null);
 
+                        /** ProductPerformanceView storeType. */
+                        public storeType?: (google.shopping.merchant.reports.v1.StoreType.StoreTypeEnum|keyof typeof google.shopping.merchant.reports.v1.StoreType.StoreTypeEnum|null);
+
                         /** ProductPerformanceView offerId. */
                         public offerId?: (string|null);
 
@@ -786,6 +792,12 @@ export namespace google {
                         /** ProductView aggregatedReportingContextStatus */
                         aggregatedReportingContextStatus?: (google.shopping.merchant.reports.v1.ProductView.AggregatedReportingContextStatus|keyof typeof google.shopping.merchant.reports.v1.ProductView.AggregatedReportingContextStatus|null);
 
+                        /** ProductView statusPerReportingContext */
+                        statusPerReportingContext?: (google.shopping.merchant.reports.v1.ProductView.IStatusPerReportingContext[]|null);
+
+                        /** ProductView reportingContext */
+                        reportingContext?: (google.shopping.type.ReportingContext.ReportingContextEnum|keyof typeof google.shopping.type.ReportingContext.ReportingContextEnum|null);
+
                         /** ProductView itemIssues */
                         itemIssues?: (google.shopping.merchant.reports.v1.ProductView.IItemIssue[]|null);
 
@@ -886,6 +898,12 @@ export namespace google {
                         /** ProductView aggregatedReportingContextStatus. */
                         public aggregatedReportingContextStatus?: (google.shopping.merchant.reports.v1.ProductView.AggregatedReportingContextStatus|keyof typeof google.shopping.merchant.reports.v1.ProductView.AggregatedReportingContextStatus|null);
 
+                        /** ProductView statusPerReportingContext. */
+                        public statusPerReportingContext: google.shopping.merchant.reports.v1.ProductView.IStatusPerReportingContext[];
+
+                        /** ProductView reportingContext. */
+                        public reportingContext?: (google.shopping.type.ReportingContext.ReportingContextEnum|keyof typeof google.shopping.type.ReportingContext.ReportingContextEnum|null);
+
                         /** ProductView itemIssues. */
                         public itemIssues: google.shopping.merchant.reports.v1.ProductView.IItemIssue[];
 
@@ -1420,6 +1438,121 @@ export namespace google {
                             }
                         }
 
+                        /** Properties of a StatusPerReportingContext. */
+                        interface IStatusPerReportingContext {
+
+                            /** StatusPerReportingContext reportingContext */
+                            reportingContext?: (google.shopping.type.ReportingContext.ReportingContextEnum|keyof typeof google.shopping.type.ReportingContext.ReportingContextEnum|null);
+
+                            /** StatusPerReportingContext approvedCountries */
+                            approvedCountries?: (string[]|null);
+
+                            /** StatusPerReportingContext disapprovedCountries */
+                            disapprovedCountries?: (string[]|null);
+
+                            /** StatusPerReportingContext pendingCountries */
+                            pendingCountries?: (string[]|null);
+                        }
+
+                        /** Represents a StatusPerReportingContext. */
+                        class StatusPerReportingContext implements IStatusPerReportingContext {
+
+                            /**
+                             * Constructs a new StatusPerReportingContext.
+                             * @param [properties] Properties to set
+                             */
+                            constructor(properties?: google.shopping.merchant.reports.v1.ProductView.IStatusPerReportingContext);
+
+                            /** StatusPerReportingContext reportingContext. */
+                            public reportingContext?: (google.shopping.type.ReportingContext.ReportingContextEnum|keyof typeof google.shopping.type.ReportingContext.ReportingContextEnum|null);
+
+                            /** StatusPerReportingContext approvedCountries. */
+                            public approvedCountries: string[];
+
+                            /** StatusPerReportingContext disapprovedCountries. */
+                            public disapprovedCountries: string[];
+
+                            /** StatusPerReportingContext pendingCountries. */
+                            public pendingCountries: string[];
+
+                            /**
+                             * Creates a new StatusPerReportingContext instance using the specified properties.
+                             * @param [properties] Properties to set
+                             * @returns StatusPerReportingContext instance
+                             */
+                            public static create(properties?: google.shopping.merchant.reports.v1.ProductView.IStatusPerReportingContext): google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext;
+
+                            /**
+                             * Encodes the specified StatusPerReportingContext message. Does not implicitly {@link google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext.verify|verify} messages.
+                             * @param message StatusPerReportingContext message or plain object to encode
+                             * @param [writer] Writer to encode to
+                             * @returns Writer
+                             */
+                            public static encode(message: google.shopping.merchant.reports.v1.ProductView.IStatusPerReportingContext, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                            /**
+                             * Encodes the specified StatusPerReportingContext message, length delimited. Does not implicitly {@link google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext.verify|verify} messages.
+                             * @param message StatusPerReportingContext message or plain object to encode
+                             * @param [writer] Writer to encode to
+                             * @returns Writer
+                             */
+                            public static encodeDelimited(message: google.shopping.merchant.reports.v1.ProductView.IStatusPerReportingContext, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                            /**
+                             * Decodes a StatusPerReportingContext message from the specified reader or buffer.
+                             * @param reader Reader or buffer to decode from
+                             * @param [length] Message length if known beforehand
+                             * @returns StatusPerReportingContext
+                             * @throws {Error} If the payload is not a reader or valid buffer
+                             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                             */
+                            public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext;
+
+                            /**
+                             * Decodes a StatusPerReportingContext message from the specified reader or buffer, length delimited.
+                             * @param reader Reader or buffer to decode from
+                             * @returns StatusPerReportingContext
+                             * @throws {Error} If the payload is not a reader or valid buffer
+                             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                             */
+                            public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext;
+
+                            /**
+                             * Verifies a StatusPerReportingContext message.
+                             * @param message Plain object to verify
+                             * @returns `null` if valid, otherwise the reason why it is not
+                             */
+                            public static verify(message: { [k: string]: any }): (string|null);
+
+                            /**
+                             * Creates a StatusPerReportingContext message from a plain object. Also converts values to their respective internal types.
+                             * @param object Plain object
+                             * @returns StatusPerReportingContext
+                             */
+                            public static fromObject(object: { [k: string]: any }): google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext;
+
+                            /**
+                             * Creates a plain object from a StatusPerReportingContext message. Also converts values to other types if specified.
+                             * @param message StatusPerReportingContext
+                             * @param [options] Conversion options
+                             * @returns Plain object
+                             */
+                            public static toObject(message: google.shopping.merchant.reports.v1.ProductView.StatusPerReportingContext, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                            /**
+                             * Converts this StatusPerReportingContext to JSON.
+                             * @returns JSON object
+                             */
+                            public toJSON(): { [k: string]: any };
+
+                            /**
+                             * Gets the default type url for StatusPerReportingContext
+                             * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                             * @returns The default type url
+                             */
+                            public static getTypeUrl(typeUrlPrefix?: string): string;
+                        }
+
                         /** AggregatedReportingContextStatus enum. */
                         enum AggregatedReportingContextStatus {
                             AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED = 0,
@@ -2877,6 +3010,107 @@ export namespace google {
                         }
                     }
 
+                    /** Properties of a StoreType. */
+                    interface IStoreType {
+                    }
+
+                    /** Represents a StoreType. */
+                    class StoreType implements IStoreType {
+
+                        /**
+                         * Constructs a new StoreType.
+                         * @param [properties] Properties to set
+                         */
+                        constructor(properties?: google.shopping.merchant.reports.v1.IStoreType);
+
+                        /**
+                         * Creates a new StoreType instance using the specified properties.
+                         * @param [properties] Properties to set
+                         * @returns StoreType instance
+                         */
+                        public static create(properties?: google.shopping.merchant.reports.v1.IStoreType): google.shopping.merchant.reports.v1.StoreType;
+
+                        /**
+                         * Encodes the specified StoreType message. Does not implicitly {@link google.shopping.merchant.reports.v1.StoreType.verify|verify} messages.
+                         * @param message StoreType message or plain object to encode
+                         * @param [writer] Writer to encode to
+                         * @returns Writer
+                         */
+                        public static encode(message: google.shopping.merchant.reports.v1.IStoreType, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                        /**
+                         * Encodes the specified StoreType message, length delimited. Does not implicitly {@link google.shopping.merchant.reports.v1.StoreType.verify|verify} messages.
+                         * @param message StoreType message or plain object to encode
+                         * @param [writer] Writer to encode to
+                         * @returns Writer
+                         */
+                        public static encodeDelimited(message: google.shopping.merchant.reports.v1.IStoreType, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                        /**
+                         * Decodes a StoreType message from the specified reader or buffer.
+                         * @param reader Reader or buffer to decode from
+                         * @param [length] Message length if known beforehand
+                         * @returns StoreType
+                         * @throws {Error} If the payload is not a reader or valid buffer
+                         * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                         */
+                        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.reports.v1.StoreType;
+
+                        /**
+                         * Decodes a StoreType message from the specified reader or buffer, length delimited.
+                         * @param reader Reader or buffer to decode from
+                         * @returns StoreType
+                         * @throws {Error} If the payload is not a reader or valid buffer
+                         * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                         */
+                        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.reports.v1.StoreType;
+
+                        /**
+                         * Verifies a StoreType message.
+                         * @param message Plain object to verify
+                         * @returns `null` if valid, otherwise the reason why it is not
+                         */
+                        public static verify(message: { [k: string]: any }): (string|null);
+
+                        /**
+                         * Creates a StoreType message from a plain object. Also converts values to their respective internal types.
+                         * @param object Plain object
+                         * @returns StoreType
+                         */
+                        public static fromObject(object: { [k: string]: any }): google.shopping.merchant.reports.v1.StoreType;
+
+                        /**
+                         * Creates a plain object from a StoreType message. Also converts values to other types if specified.
+                         * @param message StoreType
+                         * @param [options] Conversion options
+                         * @returns Plain object
+                         */
+                        public static toObject(message: google.shopping.merchant.reports.v1.StoreType, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                        /**
+                         * Converts this StoreType to JSON.
+                         * @returns JSON object
+                         */
+                        public toJSON(): { [k: string]: any };
+
+                        /**
+                         * Gets the default type url for StoreType
+                         * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                         * @returns The default type url
+                         */
+                        public static getTypeUrl(typeUrlPrefix?: string): string;
+                    }
+
+                    namespace StoreType {
+
+                        /** StoreTypeEnum enum. */
+                        enum StoreTypeEnum {
+                            STORE_TYPE_ENUM_UNSPECIFIED = 0,
+                            ONLINE_STORE = 1,
+                            LOCAL_STORES = 2
+                        }
+                    }
+
                     /** Properties of a ReportGranularity. */
                     interface IReportGranularity {
                     }