@google-analytics/data 4.10.0 → 4.12.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.12.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.11.0...data-v4.12.0) (2024-12-18)
+
+
+### Features
+
+* [analytics-data] add the `EmptyFilter` type to the Data API v1alpha ([#5845](https://github.com/googleapis/google-cloud-node/issues/5845)) ([1bcd241](https://github.com/googleapis/google-cloud-node/commit/1bcd2412bd72ce3c3d9b03128c44138964c8a0e6))
+
+## [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)
 
 

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

@@ -201,6 +201,9 @@ message Filter {
 
     // A filter for between two values.
     BetweenFilter between_filter = 5;
+
+    // A filter for empty values such as "(not set)" and "" values.
+    EmptyFilter empty_filter = 6;
   }
 }
 
@@ -341,6 +344,9 @@ message BetweenFilter {
   NumericValue to_value = 2;
 }
 
+// Filter for empty values.
+message EmptyFilter {}
+
 // To represent a number.
 message NumericValue {
   // One of a numeric value
@@ -554,6 +560,16 @@ message ResponseMetaData {
   // Demographics and
   // Interests](https://support.google.com/analytics/answer/2799357).
   optional bool subject_to_thresholding = 8;
+
+  // If this report's results are
+  // [sampled](https://support.google.com/analytics/answer/13331292), this
+  // describes the percentage of events used in this report. One
+  // `samplingMetadatas` is populated for each date range. Each
+  // `samplingMetadatas` corresponds to a date range in the order that date
+  // ranges were specified in the request.
+  //
+  // However if the results are not sampled, this field will not be defined.
+  repeated SamplingMetadata sampling_metadatas = 9;
 }
 
 // Describes a dimension column in the report. Dimensions requested in a report
@@ -1472,8 +1488,8 @@ message FunnelResponseMetadata {
   // [sampled](https://support.google.com/analytics/answer/13331292), this
   // describes what percentage of events were used in this funnel report. One
   // `samplingMetadatas` is populated for each date range. Each
-  // `samplingMetadatas` corresponds to a date range in order that date ranges
-  // were specified in the request.
+  // `samplingMetadatas` corresponds to a date range in the order that date
+  // ranges were specified in the request.
   //
   // However if the results are not sampled, this field will not be defined.
   repeated SamplingMetadata sampling_metadatas = 1;

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

@@ -9518,6 +9518,9 @@ export namespace google {
 
                     /** Filter betweenFilter */
                     betweenFilter?: (google.analytics.data.v1alpha.IBetweenFilter|null);
+
+                    /** Filter emptyFilter */
+                    emptyFilter?: (google.analytics.data.v1alpha.IEmptyFilter|null);
                 }
 
                 /** Represents a Filter. */
@@ -9544,8 +9547,11 @@ export namespace google {
                     /** Filter betweenFilter. */
                     public betweenFilter?: (google.analytics.data.v1alpha.IBetweenFilter|null);
 
+                    /** Filter emptyFilter. */
+                    public emptyFilter?: (google.analytics.data.v1alpha.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.
@@ -10396,6 +10402,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.v1alpha.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.v1alpha.IEmptyFilter): google.analytics.data.v1alpha.EmptyFilter;
+
+                    /**
+                     * Encodes the specified EmptyFilter message. Does not implicitly {@link google.analytics.data.v1alpha.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.v1alpha.IEmptyFilter, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified EmptyFilter message, length delimited. Does not implicitly {@link google.analytics.data.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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 a NumericValue. */
                 interface INumericValue {
 
@@ -10957,6 +11054,9 @@ export namespace google {
 
                     /** ResponseMetaData subjectToThresholding */
                     subjectToThresholding?: (boolean|null);
+
+                    /** ResponseMetaData samplingMetadatas */
+                    samplingMetadatas?: (google.analytics.data.v1alpha.ISamplingMetadata[]|null);
                 }
 
                 /** Represents a ResponseMetaData. */
@@ -10986,6 +11086,9 @@ export namespace google {
                     /** ResponseMetaData subjectToThresholding. */
                     public subjectToThresholding?: (boolean|null);
 
+                    /** ResponseMetaData samplingMetadatas. */
+                    public samplingMetadatas: google.analytics.data.v1alpha.ISamplingMetadata[];
+
                     /** ResponseMetaData _schemaRestrictionResponse. */
                     public _schemaRestrictionResponse?: "schemaRestrictionResponse";
 
@@ -20569,6 +20672,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. */
@@ -20595,8 +20701,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.
@@ -21122,6 +21231,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. */