@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230420 → 0.0.20230424

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +17 -10
  2. package/package.json +1 -1
  3. package/tests.ts +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20230420
12
+ // Revision: 20230424
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -272,12 +272,16 @@ declare namespace gapi.client {
272
272
  atAnyPointInTime?: boolean;
273
273
  /** A filter for numeric or date values between certain values on a dimension or metric. */
274
274
  betweenFilter?: GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter;
275
- /** Required. Immutable. The dimension name or metric name to filter. */
275
+ /**
276
+ * Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom
277
+ * dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation]
278
+ * (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
279
+ */
276
280
  fieldName?: string;
277
281
  /**
278
- * Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time
279
- * window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be
280
- * set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
282
+ * Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite
283
+ * time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only
284
+ * be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
281
285
  */
282
286
  inAnyNDayPeriod?: number;
283
287
  /** A filter for a string dimension that matches a particular list of options. */
@@ -324,8 +328,8 @@ declare namespace gapi.client {
324
328
  eventName?: string;
325
329
  /**
326
330
  * Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter
327
- * expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not
328
- * supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.
331
+ * expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are
332
+ * not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.
329
333
  */
330
334
  eventParameterFilterExpression?: GoogleAnalyticsAdminV1alphaAudienceFilterExpression;
331
335
  }
@@ -350,7 +354,10 @@ declare namespace gapi.client {
350
354
  dimensionOrMetricFilter?: GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter;
351
355
  /** Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. */
352
356
  eventFilter?: GoogleAnalyticsAdminV1alphaAudienceEventFilter;
353
- /** A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. */
357
+ /**
358
+ * A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level
359
+ * AudienceFilterExpression.
360
+ */
354
361
  notExpression?: GoogleAnalyticsAdminV1alphaAudienceFilterExpression;
355
362
  /** A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. */
356
363
  orGroup?: GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList;
@@ -369,8 +376,8 @@ declare namespace gapi.client {
369
376
  }
370
377
  interface GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep {
371
378
  /**
372
- * Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration
373
- * requirement (the duration is effectively unlimited). It is ignored for the first step.
379
+ * Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no
380
+ * duration requirement (the duration is effectively unlimited). It is ignored for the first step.
374
381
  */
375
382
  constraintDuration?: string;
376
383
  /** Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
3
- "version": "0.0.20230420",
3
+ "version": "0.0.20230424",
4
4
  "description": "TypeScript typings for Google Analytics Admin API v1alpha",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230420
6
+ // Revision: 20230424
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */