@google-analytics/data 4.7.0 → 4.9.0

package/build/protos/protos.json

@@ -1,4 +1,7 @@
 {
+  "options": {
+    "syntax": "proto3"
+  },
   "nested": {
     "google": {
       "nested": {
@@ -1514,6 +1517,24 @@
                             }
                           ]
                         },
+                        "GetPropertyQuotasSnapshot": {
+                          "requestType": "GetPropertyQuotasSnapshotRequest",
+                          "responseType": "PropertyQuotasSnapshot",
+                          "options": {
+                            "(google.api.http).get": "/v1alpha/{name=properties/*/propertyQuotasSnapshot}",
+                            "(google.api.method_signature)": "name"
+                          },
+                          "parsedOptions": [
+                            {
+                              "(google.api.http)": {
+                                "get": "/v1alpha/{name=properties/*/propertyQuotasSnapshot}"
+                              }
+                            },
+                            {
+                              "(google.api.method_signature)": "name"
+                            }
+                          ]
+                        },
                         "CreateReportTask": {
                           "requestType": "CreateReportTaskRequest",
                           "responseType": "google.longrunning.Operation",
@@ -1787,6 +1808,47 @@
                         }
                       }
                     },
+                    "GetPropertyQuotasSnapshotRequest": {
+                      "fields": {
+                        "name": {
+                          "type": "string",
+                          "id": 1,
+                          "options": {
+                            "(google.api.field_behavior)": "REQUIRED",
+                            "(google.api.resource_reference).type": "analyticsadmin.googleapis.com/PropertyQuotasSnapshot"
+                          }
+                        }
+                      }
+                    },
+                    "PropertyQuotasSnapshot": {
+                      "options": {
+                        "(google.api.resource).type": "analyticsadmin.googleapis.com/PropertyQuotasSnapshot",
+                        "(google.api.resource).pattern": "properties/{property}/propertyQuotasSnapshot",
+                        "(google.api.resource).plural": "propertyQuotasSnapshots",
+                        "(google.api.resource).singular": "propertyQuotasSnapshot"
+                      },
+                      "fields": {
+                        "name": {
+                          "type": "string",
+                          "id": 4,
+                          "options": {
+                            "(google.api.field_behavior)": "IDENTIFIER"
+                          }
+                        },
+                        "corePropertyQuota": {
+                          "type": "PropertyQuota",
+                          "id": 1
+                        },
+                        "realtimePropertyQuota": {
+                          "type": "PropertyQuota",
+                          "id": 2
+                        },
+                        "funnelPropertyQuota": {
+                          "type": "PropertyQuota",
+                          "id": 3
+                        }
+                      }
+                    },
                     "GetAudienceListRequest": {
                       "fields": {
                         "name": {
@@ -4373,6 +4435,11 @@
                           "rule": "repeated",
                           "type": "MetricMetadata",
                           "id": 2
+                        },
+                        "comparisons": {
+                          "rule": "repeated",
+                          "type": "ComparisonMetadata",
+                          "id": 4
                         }
                       }
                     },
@@ -4438,6 +4505,14 @@
                         "returnPropertyQuota": {
                           "type": "bool",
                           "id": 14
+                        },
+                        "comparisons": {
+                          "rule": "repeated",
+                          "type": "Comparison",
+                          "id": 15,
+                          "options": {
+                            "(google.api.field_behavior)": "OPTIONAL"
+                          }
                         }
                       }
                     },
@@ -4540,6 +4615,14 @@
                         "returnPropertyQuota": {
                           "type": "bool",
                           "id": 11
+                        },
+                        "comparisons": {
+                          "rule": "repeated",
+                          "type": "Comparison",
+                          "id": 12,
+                          "options": {
+                            "(google.api.field_behavior)": "OPTIONAL"
+                          }
                         }
                       }
                     },
@@ -5170,6 +5253,38 @@
                         }
                       }
                     },
+                    "Comparison": {
+                      "oneofs": {
+                        "_name": {
+                          "oneof": [
+                            "name"
+                          ]
+                        },
+                        "oneComparison": {
+                          "oneof": [
+                            "dimensionFilter",
+                            "comparison"
+                          ]
+                        }
+                      },
+                      "fields": {
+                        "name": {
+                          "type": "string",
+                          "id": 1,
+                          "options": {
+                            "proto3_optional": true
+                          }
+                        },
+                        "dimensionFilter": {
+                          "type": "FilterExpression",
+                          "id": 2
+                        },
+                        "comparison": {
+                          "type": "string",
+                          "id": 3
+                        }
+                      }
+                    },
                     "FilterExpression": {
                       "oneofs": {
                         "expr": {
@@ -5872,6 +5987,22 @@
                         }
                       }
                     },
+                    "ComparisonMetadata": {
+                      "fields": {
+                        "apiName": {
+                          "type": "string",
+                          "id": 1
+                        },
+                        "uiName": {
+                          "type": "string",
+                          "id": 2
+                        },
+                        "description": {
+                          "type": "string",
+                          "id": 3
+                        }
+                      }
+                    },
                     "DimensionCompatibility": {
                       "oneofs": {
                         "_dimensionMetadata": {

package/build/src/v1alpha/alpha_analytics_data_client.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type * as gax from 'google-gax';
 import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
 import { Transform } from 'stream';
@@ -137,9 +136,9 @@ export declare class AlphaAnalyticsDataClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} [request.property]
-     *   Optional. A Google Analytics GA4 property identifier whose events are
-     *   tracked. Specified in the URL path and not the body. To learn more, see
-     *   [where to find your Property
+     *   Optional. 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).
      *   Within a batch request, this property should either be unspecified or
      *   consistent with the batch-level property.
@@ -451,6 +450,31 @@ export declare class AlphaAnalyticsDataClient {
     ]>;
     getRecurringAudienceList(request: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
     getRecurringAudienceList(request: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Get all property quotas organized by quota category for a given property.
+     * This will charge 1 property quota from the category with the most quota.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. Quotas from this property will be listed in the response.
+     *   Format: `properties/{property}/propertyQuotasSnapshot`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.PropertyQuotasSnapshot|PropertyQuotasSnapshot}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.get_property_quotas_snapshot.js</caption>
+     * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_GetPropertyQuotasSnapshot_async
+     */
+    getPropertyQuotasSnapshot(request?: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot,
+        (protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | undefined),
+        {} | undefined
+    ]>;
+    getPropertyQuotasSnapshot(request: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot, protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | null | undefined, {} | null | undefined>): void;
+    getPropertyQuotasSnapshot(request: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, callback: Callback<protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot, protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Retrieves a report task's content. After requesting the `CreateReportTask`,
      * you are able to retrieve the report content once the report is
@@ -600,6 +624,12 @@ export declare class AlphaAnalyticsDataClient {
      * asynchronous request to form a customized report of your Google Analytics
      * event data.
      *
+     * A report task will be retained and available for querying for 72 hours
+     * after it has been created.
+     *
+     * A report task created by one user can be listed and queried by all users
+     * who have access to the property.
+     *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
@@ -1111,6 +1141,21 @@ export declare class AlphaAnalyticsDataClient {
      * @returns {string} A string representing the property.
      */
     matchPropertyFromPropertyName(propertyName: string): string | number;
+    /**
+     * Return a fully-qualified propertyQuotasSnapshot resource name string.
+     *
+     * @param {string} property
+     * @returns {string} Resource name string.
+     */
+    propertyQuotasSnapshotPath(property: string): string;
+    /**
+     * Parse the property from PropertyQuotasSnapshot resource.
+     *
+     * @param {string} propertyQuotasSnapshotName
+     *   A fully-qualified path representing PropertyQuotasSnapshot resource.
+     * @returns {string} A string representing the property.
+     */
+    matchPropertyFromPropertyQuotasSnapshotName(propertyQuotasSnapshotName: string): string | number;
     /**
      * Return a fully-qualified recurringAudienceList resource name string.
      *

package/build/src/v1alpha/alpha_analytics_data_client.js

@@ -150,6 +150,7 @@ class AlphaAnalyticsDataClient {
         this.pathTemplates = {
             audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/audienceLists/{audience_list}'),
             propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{property}'),
+            propertyQuotasSnapshotPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/propertyQuotasSnapshot'),
             recurringAudienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/recurringAudienceLists/{recurring_audience_list}'),
             reportTaskPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/reportTasks/{report_task}'),
         };
@@ -228,6 +229,7 @@ class AlphaAnalyticsDataClient {
             'createRecurringAudienceList',
             'getRecurringAudienceList',
             'listRecurringAudienceLists',
+            'getPropertyQuotasSnapshot',
             'createReportTask',
             'queryReportTask',
             'getReportTask',
@@ -443,6 +445,27 @@ class AlphaAnalyticsDataClient {
         this.initialize();
         return this.innerApiCalls.getRecurringAudienceList(request, options, callback);
     }
+    getPropertyQuotasSnapshot(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.getPropertyQuotasSnapshot(request, options, callback);
+    }
     queryReportTask(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -1076,6 +1099,27 @@ class AlphaAnalyticsDataClient {
     matchPropertyFromPropertyName(propertyName) {
         return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
     }
+    /**
+     * Return a fully-qualified propertyQuotasSnapshot resource name string.
+     *
+     * @param {string} property
+     * @returns {string} Resource name string.
+     */
+    propertyQuotasSnapshotPath(property) {
+        return this.pathTemplates.propertyQuotasSnapshotPathTemplate.render({
+            property: property,
+        });
+    }
+    /**
+     * Parse the property from PropertyQuotasSnapshot resource.
+     *
+     * @param {string} propertyQuotasSnapshotName
+     *   A fully-qualified path representing PropertyQuotasSnapshot resource.
+     * @returns {string} A string representing the property.
+     */
+    matchPropertyFromPropertyQuotasSnapshotName(propertyQuotasSnapshotName) {
+        return this.pathTemplates.propertyQuotasSnapshotPathTemplate.match(propertyQuotasSnapshotName).property;
+    }
     /**
      * Return a fully-qualified recurringAudienceList resource name string.
      *

package/build/src/v1alpha/alpha_analytics_data_client_config.json

@@ -77,6 +77,11 @@
                     "retry_codes_name": "unknown",
                     "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
                 },
+                "GetPropertyQuotasSnapshot": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
                 "CreateReportTask": {
                     "timeout_millis": 60000,
                     "retry_codes_name": "unknown",

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type * as gax from 'google-gax';
 import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
 import { Transform } from 'stream';
@@ -206,6 +205,10 @@ export declare class BetaAnalyticsDataClient {
      * @param {boolean} request.returnPropertyQuota
      *   Toggles whether to return the current state of this 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
+     *   column in the response.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -285,6 +288,10 @@ export declare class BetaAnalyticsDataClient {
      * @param {boolean} request.returnPropertyQuota
      *   Toggles whether to return the current state of this 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
+     *   receive a comparison column in the response.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "4.7.0",
+  "version": "4.9.0",
   "description": "Data client for Node.js",
   "repository": {
     "type": "git",
@@ -61,7 +61,7 @@
     "long": "^5.2.3",
     "mocha": "^9.2.2",
     "pack-n-play": "^2.0.0",
-    "sinon": "^17.0.0",
+    "sinon": "^18.0.0",
     "typescript": "^5.1.6"
   },
   "engines": {