@maxim_mazurok/gapi.client.analyticsdata-v1beta 0.0.20240507 → 0.0.20240512

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta
-// Revision: 20240507
+// Revision: 20240512
 
 /// <reference types="gapi.client" />
 
@@ -133,6 +133,22 @@ declare namespace gapi.client {
       /** `startOffset` specifies the start date of the extended reporting date range for a cohort report. `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days. */
       startOffset?: number;
     }
+    interface Comparison {
+      /** A saved comparison identified by the comparison's resource name. For example, 'comparisons/1234'. */
+      comparison?: string;
+      /** A basic comparison. */
+      dimensionFilter?: FilterExpression;
+      /** Each comparison produces separate rows in the response. In the response, this comparison is identified by this name. If name is unspecified, we will use the saved comparisons display name. */
+      name?: string;
+    }
+    interface ComparisonMetadata {
+      /** This comparison's resource name. Useable in [Comparison](#Comparison)'s `comparison` field. For example, 'comparisons/1234'. */
+      apiName?: string;
+      /** This comparison's description. */
+      description?: string;
+      /** This comparison's name within the Google Analytics user interface. */
+      uiName?: string;
+    }
     interface ConcatenateExpression {
       /** The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". */
       delimiter?: string;
@@ -234,6 +250,8 @@ declare namespace gapi.client {
       nextPageToken?: string;
     }
     interface Metadata {
+      /** The comparison descriptions. */
+      comparisons?: ComparisonMetadata[];
       /** The dimension descriptions. */
       dimensions?: DimensionMetadata[];
       /** The metric descriptions. */
@@ -424,6 +442,8 @@ declare namespace gapi.client {
     interface RunPivotReportRequest {
       /** Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. */
       cohortSpec?: CohortSpec;
+      /** 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. */
+      comparisons?: Comparison[];
       /** A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. */
       currencyCode?: string;
       /** The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified. */
@@ -506,6 +526,8 @@ declare namespace gapi.client {
     interface RunReportRequest {
       /** Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. */
       cohortSpec?: CohortSpec;
+      /** 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. */
+      comparisons?: Comparison[];
       /** A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. */
       currencyCode?: string;
       /** Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.analyticsdata-v1beta",
-  "version": "0.0.20240507",
+  "version": "0.0.20240512",
   "description": "TypeScript typings for Google Analytics Data API v1beta",
   "repository": {
     "type": "git",