@google-analytics/data 4.9.0 → 4.11.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.11.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.10.0...data-v4.11.0) (2024-11-21)
+
+
+### Features
+
+* [analytics-data] add `EmptyFilter` type to the Data API v1beta ([#5831](https://github.com/googleapis/google-cloud-node/issues/5831)) ([ced8054](https://github.com/googleapis/google-cloud-node/commit/ced80544ee74321deb881ee42dc5c2db05fbd0a4))
+
+## [4.10.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.9.0...data-v4.10.0) (2024-10-30)
+
+
+### Features
+
+* [analytics-data] add `SamplingLevel` type to Data API v1alpha ([#5759](https://github.com/googleapis/google-cloud-node/issues/5759)) ([96bb1b5](https://github.com/googleapis/google-cloud-node/commit/96bb1b51a7d1481cb16d2d9ca6bc984b3258688d))
+
 ## [4.9.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.8.0...data-v4.9.0) (2024-09-24)
 
 

package/build/protos/google/analytics/data/v1alpha/analytics_data_api.proto

@@ -1086,6 +1086,10 @@ message ReportTask {
     // the `eventName` dimension and  `eventCount` metric will not have a row
     // containing eventName: "purchase" and eventCount: 0.
     bool keep_empty_rows = 13 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The report's sampling level.
+    optional SamplingLevel sampling_level = 14
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // The report metadata for a specific report task.

package/build/protos/google/analytics/data/v1alpha/data.proto

@@ -1573,3 +1573,23 @@ enum RestrictedMetricType {
   // Revenue metrics such as `purchaseRevenue`.
   REVENUE_DATA = 2;
 }
+
+// Categories of sampling levels for the requests.
+enum SamplingLevel {
+  // Unspecified type.
+  SAMPLING_LEVEL_UNSPECIFIED = 0;
+
+  // Applies a sampling level of 10 million to standard properties and
+  // 100 million to Google Analytics 360 properties.
+  LOW = 1;
+
+  // Exclusive to Google Analytics 360 properties with a sampling level of 1
+  // billion.
+  MEDIUM = 2;
+
+  // Exclusive to Google Analytics 360 properties. Unsampled explorations are
+  // more accurate and can reveal insights that aren't visible in standard
+  // explorations. To learn more, see
+  // https://support.google.com/analytics/answer/10896953.
+  UNSAMPLED = 3;
+}

package/build/protos/google/analytics/data/v1beta/analytics_data_api.proto

@@ -71,7 +71,7 @@ service BetaAnalyticsData {
   }
 
   // Returns multiple reports in a batch. All reports must be for the same
-  // GA4 Property.
+  // Google Analytics property.
   rpc BatchRunReports(BatchRunReportsRequest)
       returns (BatchRunReportsResponse) {
     option (google.api.http) = {
@@ -81,7 +81,7 @@ service BetaAnalyticsData {
   }
 
   // Returns multiple pivot reports in a batch. All reports must be for the same
-  // GA4 Property.
+  // Google Analytics property.
   rpc BatchRunPivotReports(BatchRunPivotReportsRequest)
       returns (BatchRunPivotReportsResponse) {
     option (google.api.http) = {
@@ -92,7 +92,7 @@ service BetaAnalyticsData {
 
   // Returns metadata for dimensions and metrics available in reporting methods.
   // Used to explore the dimensions and metrics. In this method, a Google
-  // Analytics GA4 Property Identifier is specified in the request, and
+  // Analytics property identifier is specified in the request, and
   // the metadata response includes Custom dimensions and metrics as well as
   // Universal metadata.
   //
@@ -256,7 +256,7 @@ service BetaAnalyticsData {
 // report; fields shared with the `runReport` request should be the same values
 // as in your `runReport` request.
 message CheckCompatibilityRequest {
-  // A Google Analytics GA4 property identifier whose events are tracked. To
+  // A Google Analytics property identifier whose events are tracked. To
   // learn more, see [where to find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
   // `property` should be the same value as in your `runReport` request.
@@ -318,7 +318,7 @@ message Metadata {
 
 // The request to generate a report.
 message RunReportRequest {
-  // A Google Analytics GA4 property identifier whose events are tracked.
+  // A Google Analytics property identifier whose events are tracked.
   // Specified in the URL path and not the body. To learn more, see [where to
   // find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -378,9 +378,13 @@ message RunReportRequest {
 
   // Aggregation of metrics. Aggregated metric values will be shown in rows
   // where the dimension_values are set to "RESERVED_(MetricAggregation)".
+  // Aggregates including both comparisons and multiple date ranges will
+  // be aggregated based on the date ranges.
   repeated MetricAggregation metric_aggregations = 9;
 
   // Specifies how rows are ordered in the response.
+  // Requests including both comparisons and multiple date ranges will
+  // have order bys applied on the comparisons.
   repeated OrderBy order_bys = 10;
 
   // A currency code in ISO4217 format, such as "AED", "USD", "JPY".
@@ -396,15 +400,15 @@ message RunReportRequest {
   // removed by a filter.
   //
   // Regardless of this `keep_empty_rows` setting, only data recorded by the
-  // Google Analytics (GA4) property can be displayed in a report.
+  // Google Analytics property can be displayed in a report.
   //
   // For example if a property never logs a `purchase` event, then a query for
   // the `eventName` dimension and  `eventCount` metric will not have a row
   // eventName: "purchase" and eventCount: 0.
   bool keep_empty_rows = 13;
 
-  // Toggles whether to return the current state of this Analytics Property's
-  // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+  // Toggles whether to return the current state of this Google Analytics
+  // property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 14;
 
   // Optional. The configuration of comparisons requested and displayed. The
@@ -448,7 +452,7 @@ message RunReportResponse {
   // Metadata for the report.
   ResponseMetaData metadata = 8;
 
-  // This Analytics Property's quota state including this request.
+  // This Google Analytics property's quota state including this request.
   PropertyQuota property_quota = 9;
 
   // Identifies what kind of resource this message is. This `kind` is always the
@@ -459,7 +463,7 @@ message RunReportResponse {
 
 // The request to generate a pivot report.
 message RunPivotReportRequest {
-  // A Google Analytics GA4 property identifier whose events are tracked.
+  // A Google Analytics property identifier whose events are tracked.
   // Specified in the URL path and not the body. To learn more, see [where to
   // find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -513,15 +517,15 @@ message RunPivotReportRequest {
   // removed by a filter.
   //
   // Regardless of this `keep_empty_rows` setting, only data recorded by the
-  // Google Analytics (GA4) property can be displayed in a report.
+  // Google Analytics property can be displayed in a report.
   //
   // For example if a property never logs a `purchase` event, then a query for
   // the `eventName` dimension and  `eventCount` metric will not have a row
   // eventName: "purchase" and eventCount: 0.
   bool keep_empty_rows = 10;
 
-  // Toggles whether to return the current state of this Analytics Property's
-  // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+  // Toggles whether to return the current state of this Google Analytics
+  // property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 11;
 
   // Optional. The configuration of comparisons requested and displayed. The
@@ -590,7 +594,7 @@ message RunPivotReportResponse {
   // Metadata for the report.
   ResponseMetaData metadata = 6;
 
-  // This Analytics Property's quota state including this request.
+  // This Google Analytics property's quota state including this request.
   PropertyQuota property_quota = 7;
 
   // Identifies what kind of resource this message is. This `kind` is always the
@@ -601,7 +605,7 @@ message RunPivotReportResponse {
 
 // The batch request containing multiple report requests.
 message BatchRunReportsRequest {
-  // A Google Analytics GA4 property identifier whose events are tracked.
+  // A Google Analytics property identifier whose events are tracked.
   // Specified in the URL path and not the body. To learn more, see [where to
   // find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -630,7 +634,7 @@ message BatchRunReportsResponse {
 
 // The batch request containing multiple pivot report requests.
 message BatchRunPivotReportsRequest {
-  // A Google Analytics GA4 property identifier whose events are tracked.
+  // A Google Analytics property identifier whose events are tracked.
   // Specified in the URL path and not the body. To learn more, see [where to
   // find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -661,7 +665,7 @@ message BatchRunPivotReportsResponse {
 message GetMetadataRequest {
   // Required. The resource name of the metadata to retrieve. This name field is
   // specified in the URL path and not URL parameters. Property is a numeric
-  // Google Analytics GA4 Property identifier. To learn more, see [where to find
+  // Google Analytics property identifier. To learn more, see [where to find
   // your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
   //
@@ -680,7 +684,7 @@ message GetMetadataRequest {
 
 // The request to generate a realtime report.
 message RunRealtimeReportRequest {
-  // A Google Analytics GA4 property identifier whose events are tracked.
+  // A Google Analytics property identifier whose events are tracked.
   // Specified in the URL path and not the body. To learn more, see [where to
   // find your Property
   // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -719,8 +723,9 @@ message RunRealtimeReportRequest {
   // Specifies how rows are ordered in the response.
   repeated OrderBy order_bys = 8;
 
-  // Toggles whether to return the current state of this Analytics Property's
-  // Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+  // Toggles whether to return the current state of this Google Analytics
+  // property's Realtime quota. Quota is returned in
+  // [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 9;
 
   // The minute ranges of event data to read. If unspecified, one minute range
@@ -760,7 +765,8 @@ message RunRealtimeReportResponse {
   // only 50 rows.
   int32 row_count = 7;
 
-  // This Analytics Property's Realtime quota state including this request.
+  // This Google Analytics property's Realtime quota state including this
+  // request.
   PropertyQuota property_quota = 8;
 
   // Identifies what kind of resource this message is. This `kind` is always the

package/build/protos/google/analytics/data/v1beta/data.proto

@@ -318,6 +318,9 @@ message Filter {
     NumericValue to_value = 2;
   }
 
+  // Filter for empty values.
+  message EmptyFilter {}
+
   // The dimension name or metric name.
   //
   // In most methods, dimensions & metrics can be used for the first time in
@@ -339,6 +342,9 @@ message Filter {
 
     // A filter for two values.
     BetweenFilter between_filter = 6;
+
+    // A filter for empty values such as "(not set)" and "" values.
+    EmptyFilter empty_filter = 8;
   }
 }
 
@@ -1048,8 +1054,8 @@ enum MetricType {
   TYPE_KILOMETERS = 13;
 }
 
-// Categories of data that you may be restricted from viewing on certain GA4
-// properties.
+// Categories of data that you may be restricted from viewing on certain
+// Google Analytics properties.
 enum RestrictedMetricType {
   // Unspecified type.
   RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0;

package/build/protos/protos.d.ts

@@ -7608,6 +7608,9 @@ export namespace google {
 
                         /** ReportDefinition keepEmptyRows */
                         keepEmptyRows?: (boolean|null);
+
+                        /** ReportDefinition samplingLevel */
+                        samplingLevel?: (google.analytics.data.v1alpha.SamplingLevel|keyof typeof google.analytics.data.v1alpha.SamplingLevel|null);
                     }
 
                     /** Represents a ReportDefinition. */
@@ -7655,6 +7658,12 @@ export namespace google {
                         /** ReportDefinition keepEmptyRows. */
                         public keepEmptyRows: boolean;
 
+                        /** ReportDefinition samplingLevel. */
+                        public samplingLevel?: (google.analytics.data.v1alpha.SamplingLevel|keyof typeof google.analytics.data.v1alpha.SamplingLevel|null);
+
+                        /** ReportDefinition _samplingLevel. */
+                        public _samplingLevel?: "samplingLevel";
+
                         /**
                          * Creates a new ReportDefinition instance using the specified properties.
                          * @param [properties] Properties to set
@@ -16209,6 +16218,14 @@ export namespace google {
                     COST_DATA = 1,
                     REVENUE_DATA = 2
                 }
+
+                /** SamplingLevel enum. */
+                enum SamplingLevel {
+                    SAMPLING_LEVEL_UNSPECIFIED = 0,
+                    LOW = 1,
+                    MEDIUM = 2,
+                    UNSAMPLED = 3
+                }
             }
 
             /** Namespace v1beta. */
@@ -20552,6 +20569,9 @@ export namespace google {
 
                     /** Filter betweenFilter */
                     betweenFilter?: (google.analytics.data.v1beta.Filter.IBetweenFilter|null);
+
+                    /** Filter emptyFilter */
+                    emptyFilter?: (google.analytics.data.v1beta.Filter.IEmptyFilter|null);
                 }
 
                 /** Represents a Filter. */
@@ -20578,8 +20598,11 @@ export namespace google {
                     /** Filter betweenFilter. */
                     public betweenFilter?: (google.analytics.data.v1beta.Filter.IBetweenFilter|null);
 
+                    /** Filter emptyFilter. */
+                    public emptyFilter?: (google.analytics.data.v1beta.Filter.IEmptyFilter|null);
+
                     /** Filter oneFilter. */
-                    public oneFilter?: ("stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter");
+                    public oneFilter?: ("stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter"|"emptyFilter");
 
                     /**
                      * Creates a new Filter instance using the specified properties.
@@ -21105,6 +21128,97 @@ export namespace google {
                          */
                         public static getTypeUrl(typeUrlPrefix?: string): string;
                     }
+
+                    /** Properties of an EmptyFilter. */
+                    interface IEmptyFilter {
+                    }
+
+                    /** Represents an EmptyFilter. */
+                    class EmptyFilter implements IEmptyFilter {
+
+                        /**
+                         * Constructs a new EmptyFilter.
+                         * @param [properties] Properties to set
+                         */
+                        constructor(properties?: google.analytics.data.v1beta.Filter.IEmptyFilter);
+
+                        /**
+                         * Creates a new EmptyFilter instance using the specified properties.
+                         * @param [properties] Properties to set
+                         * @returns EmptyFilter instance
+                         */
+                        public static create(properties?: google.analytics.data.v1beta.Filter.IEmptyFilter): google.analytics.data.v1beta.Filter.EmptyFilter;
+
+                        /**
+                         * Encodes the specified EmptyFilter message. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
+                         * @param message EmptyFilter message or plain object to encode
+                         * @param [writer] Writer to encode to
+                         * @returns Writer
+                         */
+                        public static encode(message: google.analytics.data.v1beta.Filter.IEmptyFilter, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                        /**
+                         * Encodes the specified EmptyFilter message, length delimited. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
+                         * @param message EmptyFilter message or plain object to encode
+                         * @param [writer] Writer to encode to
+                         * @returns Writer
+                         */
+                        public static encodeDelimited(message: google.analytics.data.v1beta.Filter.IEmptyFilter, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                        /**
+                         * Decodes an EmptyFilter message from the specified reader or buffer.
+                         * @param reader Reader or buffer to decode from
+                         * @param [length] Message length if known beforehand
+                         * @returns EmptyFilter
+                         * @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.analytics.data.v1beta.Filter.EmptyFilter;
+
+                        /**
+                         * Decodes an EmptyFilter message from the specified reader or buffer, length delimited.
+                         * @param reader Reader or buffer to decode from
+                         * @returns EmptyFilter
+                         * @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.analytics.data.v1beta.Filter.EmptyFilter;
+
+                        /**
+                         * Verifies an EmptyFilter 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 an EmptyFilter message from a plain object. Also converts values to their respective internal types.
+                         * @param object Plain object
+                         * @returns EmptyFilter
+                         */
+                        public static fromObject(object: { [k: string]: any }): google.analytics.data.v1beta.Filter.EmptyFilter;
+
+                        /**
+                         * Creates a plain object from an EmptyFilter message. Also converts values to other types if specified.
+                         * @param message EmptyFilter
+                         * @param [options] Conversion options
+                         * @returns Plain object
+                         */
+                        public static toObject(message: google.analytics.data.v1beta.Filter.EmptyFilter, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                        /**
+                         * Converts this EmptyFilter to JSON.
+                         * @returns JSON object
+                         */
+                        public toJSON(): { [k: string]: any };
+
+                        /**
+                         * Gets the default type url for EmptyFilter
+                         * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                         * @returns The default type url
+                         */
+                        public static getTypeUrl(typeUrlPrefix?: string): string;
+                    }
                 }
 
                 /** Properties of an OrderBy. */

package/build/protos/protos.js

@@ -20326,6 +20326,7 @@
                              * @property {string|null} [currencyCode] ReportDefinition currencyCode
                              * @property {google.analytics.data.v1alpha.ICohortSpec|null} [cohortSpec] ReportDefinition cohortSpec
                              * @property {boolean|null} [keepEmptyRows] ReportDefinition keepEmptyRows
+                             * @property {google.analytics.data.v1alpha.SamplingLevel|null} [samplingLevel] ReportDefinition samplingLevel
                              */
     
                             /**
@@ -20444,6 +20445,28 @@
                              */
                             ReportDefinition.prototype.keepEmptyRows = false;
     
+                            /**
+                             * ReportDefinition samplingLevel.
+                             * @member {google.analytics.data.v1alpha.SamplingLevel|null|undefined} samplingLevel
+                             * @memberof google.analytics.data.v1alpha.ReportTask.ReportDefinition
+                             * @instance
+                             */
+                            ReportDefinition.prototype.samplingLevel = null;
+    
+                            // OneOf field names bound to virtual getters and setters
+                            var $oneOfFields;
+    
+                            /**
+                             * ReportDefinition _samplingLevel.
+                             * @member {"samplingLevel"|undefined} _samplingLevel
+                             * @memberof google.analytics.data.v1alpha.ReportTask.ReportDefinition
+                             * @instance
+                             */
+                            Object.defineProperty(ReportDefinition.prototype, "_samplingLevel", {
+                                get: $util.oneOfGetter($oneOfFields = ["samplingLevel"]),
+                                set: $util.oneOfSetter($oneOfFields)
+                            });
+    
                             /**
                              * Creates a new ReportDefinition instance using the specified properties.
                              * @function create
@@ -20500,6 +20523,8 @@
                                     $root.google.analytics.data.v1alpha.CohortSpec.encode(message.cohortSpec, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim();
                                 if (message.keepEmptyRows != null && Object.hasOwnProperty.call(message, "keepEmptyRows"))
                                     writer.uint32(/* id 13, wireType 0 =*/104).bool(message.keepEmptyRows);
+                                if (message.samplingLevel != null && Object.hasOwnProperty.call(message, "samplingLevel"))
+                                    writer.uint32(/* id 14, wireType 0 =*/112).int32(message.samplingLevel);
                                 return writer;
                             };
     
@@ -20597,6 +20622,10 @@
                                             message.keepEmptyRows = reader.bool();
                                             break;
                                         }
+                                    case 14: {
+                                            message.samplingLevel = reader.int32();
+                                            break;
+                                        }
                                     default:
                                         reader.skipType(tag & 7);
                                         break;
@@ -20632,6 +20661,7 @@
                             ReportDefinition.verify = function verify(message) {
                                 if (typeof message !== "object" || message === null)
                                     return "object expected";
+                                var properties = {};
                                 if (message.dimensions != null && message.hasOwnProperty("dimensions")) {
                                     if (!Array.isArray(message.dimensions))
                                         return "dimensions: array expected";
@@ -20710,6 +20740,18 @@
                                 if (message.keepEmptyRows != null && message.hasOwnProperty("keepEmptyRows"))
                                     if (typeof message.keepEmptyRows !== "boolean")
                                         return "keepEmptyRows: boolean expected";
+                                if (message.samplingLevel != null && message.hasOwnProperty("samplingLevel")) {
+                                    properties._samplingLevel = 1;
+                                    switch (message.samplingLevel) {
+                                    default:
+                                        return "samplingLevel: enum value expected";
+                                    case 0:
+                                    case 1:
+                                    case 2:
+                                    case 3:
+                                        break;
+                                    }
+                                }
                                 return null;
                             };
     
@@ -20835,6 +20877,30 @@
                                 }
                                 if (object.keepEmptyRows != null)
                                     message.keepEmptyRows = Boolean(object.keepEmptyRows);
+                                switch (object.samplingLevel) {
+                                default:
+                                    if (typeof object.samplingLevel === "number") {
+                                        message.samplingLevel = object.samplingLevel;
+                                        break;
+                                    }
+                                    break;
+                                case "SAMPLING_LEVEL_UNSPECIFIED":
+                                case 0:
+                                    message.samplingLevel = 0;
+                                    break;
+                                case "LOW":
+                                case 1:
+                                    message.samplingLevel = 1;
+                                    break;
+                                case "MEDIUM":
+                                case 2:
+                                    message.samplingLevel = 2;
+                                    break;
+                                case "UNSAMPLED":
+                                case 3:
+                                    message.samplingLevel = 3;
+                                    break;
+                                }
                                 return message;
                             };
     
@@ -20920,6 +20986,11 @@
                                     object.cohortSpec = $root.google.analytics.data.v1alpha.CohortSpec.toObject(message.cohortSpec, options);
                                 if (message.keepEmptyRows != null && message.hasOwnProperty("keepEmptyRows"))
                                     object.keepEmptyRows = message.keepEmptyRows;
+                                if (message.samplingLevel != null && message.hasOwnProperty("samplingLevel")) {
+                                    object.samplingLevel = options.enums === String ? $root.google.analytics.data.v1alpha.SamplingLevel[message.samplingLevel] === undefined ? message.samplingLevel : $root.google.analytics.data.v1alpha.SamplingLevel[message.samplingLevel] : message.samplingLevel;
+                                    if (options.oneofs)
+                                        object._samplingLevel = "samplingLevel";
+                                }
                                 return object;
                             };
     
@@ -42328,6 +42399,24 @@
                         return values;
                     })();
     
+                    /**
+                     * SamplingLevel enum.
+                     * @name google.analytics.data.v1alpha.SamplingLevel
+                     * @enum {number}
+                     * @property {number} SAMPLING_LEVEL_UNSPECIFIED=0 SAMPLING_LEVEL_UNSPECIFIED value
+                     * @property {number} LOW=1 LOW value
+                     * @property {number} MEDIUM=2 MEDIUM value
+                     * @property {number} UNSAMPLED=3 UNSAMPLED value
+                     */
+                    v1alpha.SamplingLevel = (function() {
+                        var valuesById = {}, values = Object.create(valuesById);
+                        values[valuesById[0] = "SAMPLING_LEVEL_UNSPECIFIED"] = 0;
+                        values[valuesById[1] = "LOW"] = 1;
+                        values[valuesById[2] = "MEDIUM"] = 2;
+                        values[valuesById[3] = "UNSAMPLED"] = 3;
+                        return values;
+                    })();
+    
                     return v1alpha;
                 })();
     
@@ -53926,6 +54015,7 @@
                          * @property {google.analytics.data.v1beta.Filter.IInListFilter|null} [inListFilter] Filter inListFilter
                          * @property {google.analytics.data.v1beta.Filter.INumericFilter|null} [numericFilter] Filter numericFilter
                          * @property {google.analytics.data.v1beta.Filter.IBetweenFilter|null} [betweenFilter] Filter betweenFilter
+                         * @property {google.analytics.data.v1beta.Filter.IEmptyFilter|null} [emptyFilter] Filter emptyFilter
                          */
     
                         /**
@@ -53983,17 +54073,25 @@
                          */
                         Filter.prototype.betweenFilter = null;
     
+                        /**
+                         * Filter emptyFilter.
+                         * @member {google.analytics.data.v1beta.Filter.IEmptyFilter|null|undefined} emptyFilter
+                         * @memberof google.analytics.data.v1beta.Filter
+                         * @instance
+                         */
+                        Filter.prototype.emptyFilter = null;
+    
                         // OneOf field names bound to virtual getters and setters
                         var $oneOfFields;
     
                         /**
                          * Filter oneFilter.
-                         * @member {"stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter"|undefined} oneFilter
+                         * @member {"stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter"|"emptyFilter"|undefined} oneFilter
                          * @memberof google.analytics.data.v1beta.Filter
                          * @instance
                          */
                         Object.defineProperty(Filter.prototype, "oneFilter", {
-                            get: $util.oneOfGetter($oneOfFields = ["stringFilter", "inListFilter", "numericFilter", "betweenFilter"]),
+                            get: $util.oneOfGetter($oneOfFields = ["stringFilter", "inListFilter", "numericFilter", "betweenFilter", "emptyFilter"]),
                             set: $util.oneOfSetter($oneOfFields)
                         });
     
@@ -54031,6 +54129,8 @@
                                 $root.google.analytics.data.v1beta.Filter.NumericFilter.encode(message.numericFilter, writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim();
                             if (message.betweenFilter != null && Object.hasOwnProperty.call(message, "betweenFilter"))
                                 $root.google.analytics.data.v1beta.Filter.BetweenFilter.encode(message.betweenFilter, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
+                            if (message.emptyFilter != null && Object.hasOwnProperty.call(message, "emptyFilter"))
+                                $root.google.analytics.data.v1beta.Filter.EmptyFilter.encode(message.emptyFilter, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim();
                             return writer;
                         };
     
@@ -54085,6 +54185,10 @@
                                         message.betweenFilter = $root.google.analytics.data.v1beta.Filter.BetweenFilter.decode(reader, reader.uint32());
                                         break;
                                     }
+                                case 8: {
+                                        message.emptyFilter = $root.google.analytics.data.v1beta.Filter.EmptyFilter.decode(reader, reader.uint32());
+                                        break;
+                                    }
                                 default:
                                     reader.skipType(tag & 7);
                                     break;
@@ -54162,6 +54266,16 @@
                                         return "betweenFilter." + error;
                                 }
                             }
+                            if (message.emptyFilter != null && message.hasOwnProperty("emptyFilter")) {
+                                if (properties.oneFilter === 1)
+                                    return "oneFilter: multiple values";
+                                properties.oneFilter = 1;
+                                {
+                                    var error = $root.google.analytics.data.v1beta.Filter.EmptyFilter.verify(message.emptyFilter);
+                                    if (error)
+                                        return "emptyFilter." + error;
+                                }
+                            }
                             return null;
                         };
     
@@ -54199,6 +54313,11 @@
                                     throw TypeError(".google.analytics.data.v1beta.Filter.betweenFilter: object expected");
                                 message.betweenFilter = $root.google.analytics.data.v1beta.Filter.BetweenFilter.fromObject(object.betweenFilter);
                             }
+                            if (object.emptyFilter != null) {
+                                if (typeof object.emptyFilter !== "object")
+                                    throw TypeError(".google.analytics.data.v1beta.Filter.emptyFilter: object expected");
+                                message.emptyFilter = $root.google.analytics.data.v1beta.Filter.EmptyFilter.fromObject(object.emptyFilter);
+                            }
                             return message;
                         };
     
@@ -54239,6 +54358,11 @@
                                 if (options.oneofs)
                                     object.oneFilter = "betweenFilter";
                             }
+                            if (message.emptyFilter != null && message.hasOwnProperty("emptyFilter")) {
+                                object.emptyFilter = $root.google.analytics.data.v1beta.Filter.EmptyFilter.toObject(message.emptyFilter, options);
+                                if (options.oneofs)
+                                    object.oneFilter = "emptyFilter";
+                            }
                             return object;
                         };
     
@@ -55359,6 +55483,181 @@
                             return BetweenFilter;
                         })();
     
+                        Filter.EmptyFilter = (function() {
+    
+                            /**
+                             * Properties of an EmptyFilter.
+                             * @memberof google.analytics.data.v1beta.Filter
+                             * @interface IEmptyFilter
+                             */
+    
+                            /**
+                             * Constructs a new EmptyFilter.
+                             * @memberof google.analytics.data.v1beta.Filter
+                             * @classdesc Represents an EmptyFilter.
+                             * @implements IEmptyFilter
+                             * @constructor
+                             * @param {google.analytics.data.v1beta.Filter.IEmptyFilter=} [properties] Properties to set
+                             */
+                            function EmptyFilter(properties) {
+                                if (properties)
+                                    for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                                        if (properties[keys[i]] != null)
+                                            this[keys[i]] = properties[keys[i]];
+                            }
+    
+                            /**
+                             * Creates a new EmptyFilter instance using the specified properties.
+                             * @function create
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {google.analytics.data.v1beta.Filter.IEmptyFilter=} [properties] Properties to set
+                             * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter instance
+                             */
+                            EmptyFilter.create = function create(properties) {
+                                return new EmptyFilter(properties);
+                            };
+    
+                            /**
+                             * Encodes the specified EmptyFilter message. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
+                             * @function encode
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {google.analytics.data.v1beta.Filter.IEmptyFilter} message EmptyFilter message or plain object to encode
+                             * @param {$protobuf.Writer} [writer] Writer to encode to
+                             * @returns {$protobuf.Writer} Writer
+                             */
+                            EmptyFilter.encode = function encode(message, writer) {
+                                if (!writer)
+                                    writer = $Writer.create();
+                                return writer;
+                            };
+    
+                            /**
+                             * Encodes the specified EmptyFilter message, length delimited. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
+                             * @function encodeDelimited
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {google.analytics.data.v1beta.Filter.IEmptyFilter} message EmptyFilter message or plain object to encode
+                             * @param {$protobuf.Writer} [writer] Writer to encode to
+                             * @returns {$protobuf.Writer} Writer
+                             */
+                            EmptyFilter.encodeDelimited = function encodeDelimited(message, writer) {
+                                return this.encode(message, writer).ldelim();
+                            };
+    
+                            /**
+                             * Decodes an EmptyFilter message from the specified reader or buffer.
+                             * @function decode
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                             * @param {number} [length] Message length if known beforehand
+                             * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter
+                             * @throws {Error} If the payload is not a reader or valid buffer
+                             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                             */
+                            EmptyFilter.decode = function decode(reader, length) {
+                                if (!(reader instanceof $Reader))
+                                    reader = $Reader.create(reader);
+                                var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.analytics.data.v1beta.Filter.EmptyFilter();
+                                while (reader.pos < end) {
+                                    var tag = reader.uint32();
+                                    switch (tag >>> 3) {
+                                    default:
+                                        reader.skipType(tag & 7);
+                                        break;
+                                    }
+                                }
+                                return message;
+                            };
+    
+                            /**
+                             * Decodes an EmptyFilter message from the specified reader or buffer, length delimited.
+                             * @function decodeDelimited
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                             * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter
+                             * @throws {Error} If the payload is not a reader or valid buffer
+                             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                             */
+                            EmptyFilter.decodeDelimited = function decodeDelimited(reader) {
+                                if (!(reader instanceof $Reader))
+                                    reader = new $Reader(reader);
+                                return this.decode(reader, reader.uint32());
+                            };
+    
+                            /**
+                             * Verifies an EmptyFilter message.
+                             * @function verify
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {Object.<string,*>} message Plain object to verify
+                             * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                             */
+                            EmptyFilter.verify = function verify(message) {
+                                if (typeof message !== "object" || message === null)
+                                    return "object expected";
+                                return null;
+                            };
+    
+                            /**
+                             * Creates an EmptyFilter message from a plain object. Also converts values to their respective internal types.
+                             * @function fromObject
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {Object.<string,*>} object Plain object
+                             * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter
+                             */
+                            EmptyFilter.fromObject = function fromObject(object) {
+                                if (object instanceof $root.google.analytics.data.v1beta.Filter.EmptyFilter)
+                                    return object;
+                                return new $root.google.analytics.data.v1beta.Filter.EmptyFilter();
+                            };
+    
+                            /**
+                             * Creates a plain object from an EmptyFilter message. Also converts values to other types if specified.
+                             * @function toObject
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {google.analytics.data.v1beta.Filter.EmptyFilter} message EmptyFilter
+                             * @param {$protobuf.IConversionOptions} [options] Conversion options
+                             * @returns {Object.<string,*>} Plain object
+                             */
+                            EmptyFilter.toObject = function toObject() {
+                                return {};
+                            };
+    
+                            /**
+                             * Converts this EmptyFilter to JSON.
+                             * @function toJSON
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @instance
+                             * @returns {Object.<string,*>} JSON object
+                             */
+                            EmptyFilter.prototype.toJSON = function toJSON() {
+                                return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+                            };
+    
+                            /**
+                             * Gets the default type url for EmptyFilter
+                             * @function getTypeUrl
+                             * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
+                             * @static
+                             * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                             * @returns {string} The default type url
+                             */
+                            EmptyFilter.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+                                if (typeUrlPrefix === undefined) {
+                                    typeUrlPrefix = "type.googleapis.com";
+                                }
+                                return typeUrlPrefix + "/google.analytics.data.v1beta.Filter.EmptyFilter";
+                            };
+    
+                            return EmptyFilter;
+                        })();
+    
                         return Filter;
                     })();
     

package/build/protos/protos.json

@@ -2393,6 +2393,13 @@
                       },
                       "nested": {
                         "ReportDefinition": {
+                          "oneofs": {
+                            "_samplingLevel": {
+                              "oneof": [
+                                "samplingLevel"
+                              ]
+                            }
+                          },
                           "fields": {
                             "dimensions": {
                               "rule": "repeated",
@@ -2482,6 +2489,14 @@
                               "options": {
                                 "(google.api.field_behavior)": "OPTIONAL"
                               }
+                            },
+                            "samplingLevel": {
+                              "type": "SamplingLevel",
+                              "id": 14,
+                              "options": {
+                                "(google.api.field_behavior)": "OPTIONAL",
+                                "proto3_optional": true
+                              }
                             }
                           }
                         },
@@ -4153,6 +4168,14 @@
                         "COST_DATA": 1,
                         "REVENUE_DATA": 2
                       }
+                    },
+                    "SamplingLevel": {
+                      "values": {
+                        "SAMPLING_LEVEL_UNSPECIFIED": 0,
+                        "LOW": 1,
+                        "MEDIUM": 2,
+                        "UNSAMPLED": 3
+                      }
                     }
                   }
                 },
@@ -5331,7 +5354,8 @@
                             "stringFilter",
                             "inListFilter",
                             "numericFilter",
-                            "betweenFilter"
+                            "betweenFilter",
+                            "emptyFilter"
                           ]
                         }
                       },
@@ -5355,6 +5379,10 @@
                         "betweenFilter": {
                           "type": "BetweenFilter",
                           "id": 6
+                        },
+                        "emptyFilter": {
+                          "type": "EmptyFilter",
+                          "id": 8
                         }
                       },
                       "nested": {
@@ -5435,6 +5463,9 @@
                               "id": 2
                             }
                           }
+                        },
+                        "EmptyFilter": {
+                          "fields": {}
                         }
                       }
                     },

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

@@ -131,7 +131,7 @@ export declare class BetaAnalyticsDataClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.property
-     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   A Google Analytics property identifier whose events are tracked.
      *   Specified in the URL path and not the body. To learn more, see [where to
      *   find your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -183,8 +183,12 @@ export declare class BetaAnalyticsDataClient {
      * @param {number[]} request.metricAggregations
      *   Aggregation of metrics. Aggregated metric values will be shown in rows
      *   where the dimension_values are set to "RESERVED_(MetricAggregation)".
+     *   Aggregates including both comparisons and multiple date ranges will
+     *   be aggregated based on the date ranges.
      * @param {number[]} request.orderBys
      *   Specifies how rows are ordered in the response.
+     *   Requests including both comparisons and multiple date ranges will
+     *   have order bys applied on the comparisons.
      * @param {string} request.currencyCode
      *   A currency code in ISO4217 format, such as "AED", "USD", "JPY".
      *   If the field is empty, the report uses the property's default currency.
@@ -197,14 +201,14 @@ export declare class BetaAnalyticsDataClient {
      *   removed by a filter.
      *
      *   Regardless of this `keep_empty_rows` setting, only data recorded by the
-     *   Google Analytics (GA4) property can be displayed in a report.
+     *   Google Analytics property can be displayed in a report.
      *
      *   For example if a property never logs a `purchase` event, then a query for
      *   the `eventName` dimension and  `eventCount` metric will not have a row
      *   eventName: "purchase" and eventCount: 0.
      * @param {boolean} request.returnPropertyQuota
-     *   Toggles whether to return the current state of this Analytics Property's
-     *   quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+     *   Toggles whether to return the current state of this Google Analytics
+     *   property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      * @param {number[]} [request.comparisons]
      *   Optional. The configuration of comparisons requested and displayed. The
      *   request only requires a comparisons field in order to receive a comparison
@@ -235,7 +239,7 @@ export declare class BetaAnalyticsDataClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.property
-     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   A Google Analytics property identifier whose events are tracked.
      *   Specified in the URL path and not the body. To learn more, see [where to
      *   find your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -280,14 +284,14 @@ export declare class BetaAnalyticsDataClient {
      *   removed by a filter.
      *
      *   Regardless of this `keep_empty_rows` setting, only data recorded by the
-     *   Google Analytics (GA4) property can be displayed in a report.
+     *   Google Analytics property can be displayed in a report.
      *
      *   For example if a property never logs a `purchase` event, then a query for
      *   the `eventName` dimension and  `eventCount` metric will not have a row
      *   eventName: "purchase" and eventCount: 0.
      * @param {boolean} request.returnPropertyQuota
-     *   Toggles whether to return the current state of this Analytics Property's
-     *   quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+     *   Toggles whether to return the current state of this Google Analytics
+     *   property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      * @param {number[]} [request.comparisons]
      *   Optional. The configuration of comparisons requested and displayed. The
      *   request requires both a comparisons field and a comparisons dimension to
@@ -310,12 +314,12 @@ export declare class BetaAnalyticsDataClient {
     runPivotReport(request: protos.google.analytics.data.v1beta.IRunPivotReportRequest, callback: Callback<protos.google.analytics.data.v1beta.IRunPivotReportResponse, protos.google.analytics.data.v1beta.IRunPivotReportRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Returns multiple reports in a batch. All reports must be for the same
-     * GA4 Property.
+     * Google Analytics property.
      *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.property
-     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   A Google Analytics property identifier whose events are tracked.
      *   Specified in the URL path and not the body. To learn more, see [where to
      *   find your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -345,12 +349,12 @@ export declare class BetaAnalyticsDataClient {
     batchRunReports(request: protos.google.analytics.data.v1beta.IBatchRunReportsRequest, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunReportsResponse, protos.google.analytics.data.v1beta.IBatchRunReportsRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Returns multiple pivot reports in a batch. All reports must be for the same
-     * GA4 Property.
+     * Google Analytics property.
      *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.property
-     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   A Google Analytics property identifier whose events are tracked.
      *   Specified in the URL path and not the body. To learn more, see [where to
      *   find your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -381,7 +385,7 @@ export declare class BetaAnalyticsDataClient {
     /**
      * Returns metadata for dimensions and metrics available in reporting methods.
      * Used to explore the dimensions and metrics. In this method, a Google
-     * Analytics GA4 Property Identifier is specified in the request, and
+     * Analytics property identifier is specified in the request, and
      * the metadata response includes Custom dimensions and metrics as well as
      * Universal metadata.
      *
@@ -395,7 +399,7 @@ export declare class BetaAnalyticsDataClient {
      * @param {string} request.name
      *   Required. The resource name of the metadata to retrieve. This name field is
      *   specified in the URL path and not URL parameters. Property is a numeric
-     *   Google Analytics GA4 Property identifier. To learn more, see [where to find
+     *   Google Analytics property identifier. To learn more, see [where to find
      *   your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
      *
@@ -434,7 +438,7 @@ export declare class BetaAnalyticsDataClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.property
-     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   A Google Analytics property identifier whose events are tracked.
      *   Specified in the URL path and not the body. To learn more, see [where to
      *   find your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -465,8 +469,9 @@ export declare class BetaAnalyticsDataClient {
      * @param {number[]} request.orderBys
      *   Specifies how rows are ordered in the response.
      * @param {boolean} request.returnPropertyQuota
-     *   Toggles whether to return the current state of this Analytics Property's
-     *   Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+     *   Toggles whether to return the current state of this Google Analytics
+     *   property's Realtime quota. Quota is returned in
+     *   [PropertyQuota](#PropertyQuota).
      * @param {number[]} request.minuteRanges
      *   The minute ranges of event data to read. If unspecified, one minute range
      *   for the last 30 minutes will be used. If multiple minute ranges are
@@ -504,7 +509,7 @@ export declare class BetaAnalyticsDataClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.property
-     *   A Google Analytics GA4 property identifier whose events are tracked. To
+     *   A Google Analytics property identifier whose events are tracked. To
      *   learn more, see [where to find your Property
      *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
      *   `property` should be the same value as in your `runReport` request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "4.9.0",
+  "version": "4.11.0",
   "description": "Data client for Node.js",
   "repository": {
     "type": "git",