@maxim_mazurok/gapi.client.analyticsdata-v1beta 0.1.20260317 → 0.2.20260317
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.
- package/index.d.ts +126 -53
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -32,7 +32,10 @@ declare namespace gapi.client {
|
|
|
32
32
|
/** The name of the restricted metric. */
|
|
33
33
|
metricName?: string;
|
|
34
34
|
/** The reason for this metric's restriction. */
|
|
35
|
-
restrictedMetricTypes?:
|
|
35
|
+
restrictedMetricTypes?:
|
|
36
|
+
| 'RESTRICTED_METRIC_TYPE_UNSPECIFIED'
|
|
37
|
+
| 'COST_DATA'
|
|
38
|
+
| 'REVENUE_DATA'[];
|
|
36
39
|
}
|
|
37
40
|
interface AudienceExport {
|
|
38
41
|
/** Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}` */
|
|
@@ -54,7 +57,7 @@ declare namespace gapi.client {
|
|
|
54
57
|
/** Output only. The total number of rows in the AudienceExport result. */
|
|
55
58
|
rowCount?: number;
|
|
56
59
|
/** Output only. The current state for this AudienceExport. */
|
|
57
|
-
state?:
|
|
60
|
+
state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'FAILED';
|
|
58
61
|
}
|
|
59
62
|
interface AudienceListMetadata {}
|
|
60
63
|
interface BatchRunPivotReportsRequest {
|
|
@@ -89,7 +92,10 @@ declare namespace gapi.client {
|
|
|
89
92
|
}
|
|
90
93
|
interface CheckCompatibilityRequest {
|
|
91
94
|
/** Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics. */
|
|
92
|
-
compatibilityFilter?:
|
|
95
|
+
compatibilityFilter?:
|
|
96
|
+
| 'COMPATIBILITY_UNSPECIFIED'
|
|
97
|
+
| 'COMPATIBLE'
|
|
98
|
+
| 'INCOMPATIBLE';
|
|
93
99
|
/** The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request. */
|
|
94
100
|
dimensionFilter?: FilterExpression;
|
|
95
101
|
/** The dimensions in this report. `dimensions` should be the same value as in your `runReport` request. */
|
|
@@ -129,7 +135,7 @@ declare namespace gapi.client {
|
|
|
129
135
|
/** Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days. */
|
|
130
136
|
endOffset?: number;
|
|
131
137
|
/** Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report. */
|
|
132
|
-
granularity?:
|
|
138
|
+
granularity?: 'GRANULARITY_UNSPECIFIED' | 'DAILY' | 'WEEKLY' | 'MONTHLY';
|
|
133
139
|
/** `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. */
|
|
134
140
|
startOffset?: number;
|
|
135
141
|
}
|
|
@@ -171,7 +177,10 @@ declare namespace gapi.client {
|
|
|
171
177
|
}
|
|
172
178
|
interface DimensionCompatibility {
|
|
173
179
|
/** The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report. */
|
|
174
|
-
compatibility?:
|
|
180
|
+
compatibility?:
|
|
181
|
+
| 'COMPATIBILITY_UNSPECIFIED'
|
|
182
|
+
| 'COMPATIBLE'
|
|
183
|
+
| 'INCOMPATIBLE';
|
|
175
184
|
/** The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description. */
|
|
176
185
|
dimensionMetadata?: DimensionMetadata;
|
|
177
186
|
}
|
|
@@ -205,7 +214,11 @@ declare namespace gapi.client {
|
|
|
205
214
|
/** A dimension name in the request to order by. */
|
|
206
215
|
dimensionName?: string;
|
|
207
216
|
/** Controls the rule for dimension value ordering. */
|
|
208
|
-
orderType?:
|
|
217
|
+
orderType?:
|
|
218
|
+
| 'ORDER_TYPE_UNSPECIFIED'
|
|
219
|
+
| 'ALPHANUMERIC'
|
|
220
|
+
| 'CASE_INSENSITIVE_ALPHANUMERIC'
|
|
221
|
+
| 'NUMERIC';
|
|
209
222
|
}
|
|
210
223
|
interface DimensionValue {
|
|
211
224
|
/** Value as a string if the dimension type is a string. */
|
|
@@ -272,7 +285,10 @@ declare namespace gapi.client {
|
|
|
272
285
|
}
|
|
273
286
|
interface MetricCompatibility {
|
|
274
287
|
/** The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report. */
|
|
275
|
-
compatibility?:
|
|
288
|
+
compatibility?:
|
|
289
|
+
| 'COMPATIBILITY_UNSPECIFIED'
|
|
290
|
+
| 'COMPATIBLE'
|
|
291
|
+
| 'INCOMPATIBLE';
|
|
276
292
|
/** The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description. */
|
|
277
293
|
metricMetadata?: MetricMetadata;
|
|
278
294
|
}
|
|
@@ -280,13 +296,29 @@ declare namespace gapi.client {
|
|
|
280
296
|
/** The metric's name. */
|
|
281
297
|
name?: string;
|
|
282
298
|
/** The metric's data type. */
|
|
283
|
-
type?:
|
|
299
|
+
type?:
|
|
300
|
+
| 'METRIC_TYPE_UNSPECIFIED'
|
|
301
|
+
| 'TYPE_INTEGER'
|
|
302
|
+
| 'TYPE_FLOAT'
|
|
303
|
+
| 'TYPE_SECONDS'
|
|
304
|
+
| 'TYPE_MILLISECONDS'
|
|
305
|
+
| 'TYPE_MINUTES'
|
|
306
|
+
| 'TYPE_HOURS'
|
|
307
|
+
| 'TYPE_STANDARD'
|
|
308
|
+
| 'TYPE_CURRENCY'
|
|
309
|
+
| 'TYPE_FEET'
|
|
310
|
+
| 'TYPE_MILES'
|
|
311
|
+
| 'TYPE_METERS'
|
|
312
|
+
| 'TYPE_KILOMETERS';
|
|
284
313
|
}
|
|
285
314
|
interface MetricMetadata {
|
|
286
315
|
/** A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`. */
|
|
287
316
|
apiName?: string;
|
|
288
317
|
/** If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). */
|
|
289
|
-
blockedReasons?:
|
|
318
|
+
blockedReasons?:
|
|
319
|
+
| 'BLOCKED_REASON_UNSPECIFIED'
|
|
320
|
+
| 'NO_REVENUE_METRICS'
|
|
321
|
+
| 'NO_COST_METRICS'[];
|
|
290
322
|
/** The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together. */
|
|
291
323
|
category?: string;
|
|
292
324
|
/** True if the metric is a custom metric for this property. */
|
|
@@ -298,7 +330,20 @@ declare namespace gapi.client {
|
|
|
298
330
|
/** The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty. */
|
|
299
331
|
expression?: string;
|
|
300
332
|
/** The type of this metric. */
|
|
301
|
-
type?:
|
|
333
|
+
type?:
|
|
334
|
+
| 'METRIC_TYPE_UNSPECIFIED'
|
|
335
|
+
| 'TYPE_INTEGER'
|
|
336
|
+
| 'TYPE_FLOAT'
|
|
337
|
+
| 'TYPE_SECONDS'
|
|
338
|
+
| 'TYPE_MILLISECONDS'
|
|
339
|
+
| 'TYPE_MINUTES'
|
|
340
|
+
| 'TYPE_HOURS'
|
|
341
|
+
| 'TYPE_STANDARD'
|
|
342
|
+
| 'TYPE_CURRENCY'
|
|
343
|
+
| 'TYPE_FEET'
|
|
344
|
+
| 'TYPE_MILES'
|
|
345
|
+
| 'TYPE_METERS'
|
|
346
|
+
| 'TYPE_KILOMETERS';
|
|
302
347
|
/** This metric's name within the Google Analytics user interface. For example, `Event count`. */
|
|
303
348
|
uiName?: string;
|
|
304
349
|
}
|
|
@@ -320,7 +365,13 @@ declare namespace gapi.client {
|
|
|
320
365
|
}
|
|
321
366
|
interface NumericFilter {
|
|
322
367
|
/** The operation type for this filter. */
|
|
323
|
-
operation?:
|
|
368
|
+
operation?:
|
|
369
|
+
| 'OPERATION_UNSPECIFIED'
|
|
370
|
+
| 'EQUAL'
|
|
371
|
+
| 'LESS_THAN'
|
|
372
|
+
| 'LESS_THAN_OR_EQUAL'
|
|
373
|
+
| 'GREATER_THAN'
|
|
374
|
+
| 'GREATER_THAN_OR_EQUAL';
|
|
324
375
|
/** A numeric value or a date value. */
|
|
325
376
|
value?: NumericValue;
|
|
326
377
|
}
|
|
@@ -358,7 +409,12 @@ declare namespace gapi.client {
|
|
|
358
409
|
/** The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`. */
|
|
359
410
|
limit?: string;
|
|
360
411
|
/** Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations. */
|
|
361
|
-
metricAggregations?:
|
|
412
|
+
metricAggregations?:
|
|
413
|
+
| 'METRIC_AGGREGATION_UNSPECIFIED'
|
|
414
|
+
| 'TOTAL'
|
|
415
|
+
| 'MINIMUM'
|
|
416
|
+
| 'MAXIMUM'
|
|
417
|
+
| 'COUNT'[];
|
|
362
418
|
/** The row count of the start row. The first row is counted as row 0. */
|
|
363
419
|
offset?: string;
|
|
364
420
|
/** Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names. */
|
|
@@ -494,7 +550,12 @@ declare namespace gapi.client {
|
|
|
494
550
|
/** The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. */
|
|
495
551
|
limit?: string;
|
|
496
552
|
/** Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". */
|
|
497
|
-
metricAggregations?:
|
|
553
|
+
metricAggregations?:
|
|
554
|
+
| 'METRIC_AGGREGATION_UNSPECIFIED'
|
|
555
|
+
| 'TOTAL'
|
|
556
|
+
| 'MINIMUM'
|
|
557
|
+
| 'MAXIMUM'
|
|
558
|
+
| 'COUNT'[];
|
|
498
559
|
/** The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter. */
|
|
499
560
|
metricFilter?: FilterExpression;
|
|
500
561
|
/** The metrics requested and displayed. */
|
|
@@ -544,7 +605,12 @@ declare namespace gapi.client {
|
|
|
544
605
|
/** The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). */
|
|
545
606
|
limit?: string;
|
|
546
607
|
/** 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. */
|
|
547
|
-
metricAggregations?:
|
|
608
|
+
metricAggregations?:
|
|
609
|
+
| 'METRIC_AGGREGATION_UNSPECIFIED'
|
|
610
|
+
| 'TOTAL'
|
|
611
|
+
| 'MINIMUM'
|
|
612
|
+
| 'MAXIMUM'
|
|
613
|
+
| 'COUNT'[];
|
|
548
614
|
/** The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. */
|
|
549
615
|
metricFilter?: FilterExpression;
|
|
550
616
|
/** The metrics requested and displayed. */
|
|
@@ -602,7 +668,14 @@ declare namespace gapi.client {
|
|
|
602
668
|
/** If true, the string value is case sensitive. */
|
|
603
669
|
caseSensitive?: boolean;
|
|
604
670
|
/** The match type for this filter. */
|
|
605
|
-
matchType?:
|
|
671
|
+
matchType?:
|
|
672
|
+
| 'MATCH_TYPE_UNSPECIFIED'
|
|
673
|
+
| 'EXACT'
|
|
674
|
+
| 'BEGINS_WITH'
|
|
675
|
+
| 'ENDS_WITH'
|
|
676
|
+
| 'CONTAINS'
|
|
677
|
+
| 'FULL_REGEXP'
|
|
678
|
+
| 'PARTIAL_REGEXP';
|
|
606
679
|
/** The string value used for the matching. */
|
|
607
680
|
value?: string;
|
|
608
681
|
}
|
|
@@ -622,11 +695,11 @@ declare namespace gapi.client {
|
|
|
622
695
|
/** Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. */
|
|
623
696
|
create(request: {
|
|
624
697
|
/** V1 error format. */
|
|
625
|
-
'$.xgafv'?:
|
|
698
|
+
'$.xgafv'?: '1' | '2';
|
|
626
699
|
/** OAuth access token. */
|
|
627
700
|
access_token?: string;
|
|
628
701
|
/** Data format for response. */
|
|
629
|
-
alt?:
|
|
702
|
+
alt?: 'json' | 'media' | 'proto';
|
|
630
703
|
/** JSONP */
|
|
631
704
|
callback?: string;
|
|
632
705
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -651,11 +724,11 @@ declare namespace gapi.client {
|
|
|
651
724
|
create(
|
|
652
725
|
request: {
|
|
653
726
|
/** V1 error format. */
|
|
654
|
-
'$.xgafv'?:
|
|
727
|
+
'$.xgafv'?: '1' | '2';
|
|
655
728
|
/** OAuth access token. */
|
|
656
729
|
access_token?: string;
|
|
657
730
|
/** Data format for response. */
|
|
658
|
-
alt?:
|
|
731
|
+
alt?: 'json' | 'media' | 'proto';
|
|
659
732
|
/** JSONP */
|
|
660
733
|
callback?: string;
|
|
661
734
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -680,11 +753,11 @@ declare namespace gapi.client {
|
|
|
680
753
|
/** Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. */
|
|
681
754
|
get(request?: {
|
|
682
755
|
/** V1 error format. */
|
|
683
|
-
'$.xgafv'?:
|
|
756
|
+
'$.xgafv'?: '1' | '2';
|
|
684
757
|
/** OAuth access token. */
|
|
685
758
|
access_token?: string;
|
|
686
759
|
/** Data format for response. */
|
|
687
|
-
alt?:
|
|
760
|
+
alt?: 'json' | 'media' | 'proto';
|
|
688
761
|
/** JSONP */
|
|
689
762
|
callback?: string;
|
|
690
763
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -707,11 +780,11 @@ declare namespace gapi.client {
|
|
|
707
780
|
/** Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. */
|
|
708
781
|
list(request?: {
|
|
709
782
|
/** V1 error format. */
|
|
710
|
-
'$.xgafv'?:
|
|
783
|
+
'$.xgafv'?: '1' | '2';
|
|
711
784
|
/** OAuth access token. */
|
|
712
785
|
access_token?: string;
|
|
713
786
|
/** Data format for response. */
|
|
714
|
-
alt?:
|
|
787
|
+
alt?: 'json' | 'media' | 'proto';
|
|
715
788
|
/** JSONP */
|
|
716
789
|
callback?: string;
|
|
717
790
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -738,11 +811,11 @@ declare namespace gapi.client {
|
|
|
738
811
|
/** Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. */
|
|
739
812
|
query(request: {
|
|
740
813
|
/** V1 error format. */
|
|
741
|
-
'$.xgafv'?:
|
|
814
|
+
'$.xgafv'?: '1' | '2';
|
|
742
815
|
/** OAuth access token. */
|
|
743
816
|
access_token?: string;
|
|
744
817
|
/** Data format for response. */
|
|
745
|
-
alt?:
|
|
818
|
+
alt?: 'json' | 'media' | 'proto';
|
|
746
819
|
/** JSONP */
|
|
747
820
|
callback?: string;
|
|
748
821
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -767,11 +840,11 @@ declare namespace gapi.client {
|
|
|
767
840
|
query(
|
|
768
841
|
request: {
|
|
769
842
|
/** V1 error format. */
|
|
770
|
-
'$.xgafv'?:
|
|
843
|
+
'$.xgafv'?: '1' | '2';
|
|
771
844
|
/** OAuth access token. */
|
|
772
845
|
access_token?: string;
|
|
773
846
|
/** Data format for response. */
|
|
774
|
-
alt?:
|
|
847
|
+
alt?: 'json' | 'media' | 'proto';
|
|
775
848
|
/** JSONP */
|
|
776
849
|
callback?: string;
|
|
777
850
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -798,11 +871,11 @@ declare namespace gapi.client {
|
|
|
798
871
|
/** Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property. */
|
|
799
872
|
batchRunPivotReports(request: {
|
|
800
873
|
/** V1 error format. */
|
|
801
|
-
'$.xgafv'?:
|
|
874
|
+
'$.xgafv'?: '1' | '2';
|
|
802
875
|
/** OAuth access token. */
|
|
803
876
|
access_token?: string;
|
|
804
877
|
/** Data format for response. */
|
|
805
|
-
alt?:
|
|
878
|
+
alt?: 'json' | 'media' | 'proto';
|
|
806
879
|
/** JSONP */
|
|
807
880
|
callback?: string;
|
|
808
881
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -827,11 +900,11 @@ declare namespace gapi.client {
|
|
|
827
900
|
batchRunPivotReports(
|
|
828
901
|
request: {
|
|
829
902
|
/** V1 error format. */
|
|
830
|
-
'$.xgafv'?:
|
|
903
|
+
'$.xgafv'?: '1' | '2';
|
|
831
904
|
/** OAuth access token. */
|
|
832
905
|
access_token?: string;
|
|
833
906
|
/** Data format for response. */
|
|
834
|
-
alt?:
|
|
907
|
+
alt?: 'json' | 'media' | 'proto';
|
|
835
908
|
/** JSONP */
|
|
836
909
|
callback?: string;
|
|
837
910
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -856,11 +929,11 @@ declare namespace gapi.client {
|
|
|
856
929
|
/** Returns multiple reports in a batch. All reports must be for the same Google Analytics property. */
|
|
857
930
|
batchRunReports(request: {
|
|
858
931
|
/** V1 error format. */
|
|
859
|
-
'$.xgafv'?:
|
|
932
|
+
'$.xgafv'?: '1' | '2';
|
|
860
933
|
/** OAuth access token. */
|
|
861
934
|
access_token?: string;
|
|
862
935
|
/** Data format for response. */
|
|
863
|
-
alt?:
|
|
936
|
+
alt?: 'json' | 'media' | 'proto';
|
|
864
937
|
/** JSONP */
|
|
865
938
|
callback?: string;
|
|
866
939
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -885,11 +958,11 @@ declare namespace gapi.client {
|
|
|
885
958
|
batchRunReports(
|
|
886
959
|
request: {
|
|
887
960
|
/** V1 error format. */
|
|
888
|
-
'$.xgafv'?:
|
|
961
|
+
'$.xgafv'?: '1' | '2';
|
|
889
962
|
/** OAuth access token. */
|
|
890
963
|
access_token?: string;
|
|
891
964
|
/** Data format for response. */
|
|
892
|
-
alt?:
|
|
965
|
+
alt?: 'json' | 'media' | 'proto';
|
|
893
966
|
/** JSONP */
|
|
894
967
|
callback?: string;
|
|
895
968
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -914,11 +987,11 @@ declare namespace gapi.client {
|
|
|
914
987
|
/** This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports. */
|
|
915
988
|
checkCompatibility(request: {
|
|
916
989
|
/** V1 error format. */
|
|
917
|
-
'$.xgafv'?:
|
|
990
|
+
'$.xgafv'?: '1' | '2';
|
|
918
991
|
/** OAuth access token. */
|
|
919
992
|
access_token?: string;
|
|
920
993
|
/** Data format for response. */
|
|
921
|
-
alt?:
|
|
994
|
+
alt?: 'json' | 'media' | 'proto';
|
|
922
995
|
/** JSONP */
|
|
923
996
|
callback?: string;
|
|
924
997
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -943,11 +1016,11 @@ declare namespace gapi.client {
|
|
|
943
1016
|
checkCompatibility(
|
|
944
1017
|
request: {
|
|
945
1018
|
/** V1 error format. */
|
|
946
|
-
'$.xgafv'?:
|
|
1019
|
+
'$.xgafv'?: '1' | '2';
|
|
947
1020
|
/** OAuth access token. */
|
|
948
1021
|
access_token?: string;
|
|
949
1022
|
/** Data format for response. */
|
|
950
|
-
alt?:
|
|
1023
|
+
alt?: 'json' | 'media' | 'proto';
|
|
951
1024
|
/** JSONP */
|
|
952
1025
|
callback?: string;
|
|
953
1026
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -972,11 +1045,11 @@ declare namespace gapi.client {
|
|
|
972
1045
|
/** Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`. */
|
|
973
1046
|
getMetadata(request?: {
|
|
974
1047
|
/** V1 error format. */
|
|
975
|
-
'$.xgafv'?:
|
|
1048
|
+
'$.xgafv'?: '1' | '2';
|
|
976
1049
|
/** OAuth access token. */
|
|
977
1050
|
access_token?: string;
|
|
978
1051
|
/** Data format for response. */
|
|
979
|
-
alt?:
|
|
1052
|
+
alt?: 'json' | 'media' | 'proto';
|
|
980
1053
|
/** JSONP */
|
|
981
1054
|
callback?: string;
|
|
982
1055
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -999,11 +1072,11 @@ declare namespace gapi.client {
|
|
|
999
1072
|
/** Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data. */
|
|
1000
1073
|
runPivotReport(request: {
|
|
1001
1074
|
/** V1 error format. */
|
|
1002
|
-
'$.xgafv'?:
|
|
1075
|
+
'$.xgafv'?: '1' | '2';
|
|
1003
1076
|
/** OAuth access token. */
|
|
1004
1077
|
access_token?: string;
|
|
1005
1078
|
/** Data format for response. */
|
|
1006
|
-
alt?:
|
|
1079
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1007
1080
|
/** JSONP */
|
|
1008
1081
|
callback?: string;
|
|
1009
1082
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1028,11 +1101,11 @@ declare namespace gapi.client {
|
|
|
1028
1101
|
runPivotReport(
|
|
1029
1102
|
request: {
|
|
1030
1103
|
/** V1 error format. */
|
|
1031
|
-
'$.xgafv'?:
|
|
1104
|
+
'$.xgafv'?: '1' | '2';
|
|
1032
1105
|
/** OAuth access token. */
|
|
1033
1106
|
access_token?: string;
|
|
1034
1107
|
/** Data format for response. */
|
|
1035
|
-
alt?:
|
|
1108
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1036
1109
|
/** JSONP */
|
|
1037
1110
|
callback?: string;
|
|
1038
1111
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1057,11 +1130,11 @@ declare namespace gapi.client {
|
|
|
1057
1130
|
/** Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). */
|
|
1058
1131
|
runRealtimeReport(request: {
|
|
1059
1132
|
/** V1 error format. */
|
|
1060
|
-
'$.xgafv'?:
|
|
1133
|
+
'$.xgafv'?: '1' | '2';
|
|
1061
1134
|
/** OAuth access token. */
|
|
1062
1135
|
access_token?: string;
|
|
1063
1136
|
/** Data format for response. */
|
|
1064
|
-
alt?:
|
|
1137
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1065
1138
|
/** JSONP */
|
|
1066
1139
|
callback?: string;
|
|
1067
1140
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1086,11 +1159,11 @@ declare namespace gapi.client {
|
|
|
1086
1159
|
runRealtimeReport(
|
|
1087
1160
|
request: {
|
|
1088
1161
|
/** V1 error format. */
|
|
1089
|
-
'$.xgafv'?:
|
|
1162
|
+
'$.xgafv'?: '1' | '2';
|
|
1090
1163
|
/** OAuth access token. */
|
|
1091
1164
|
access_token?: string;
|
|
1092
1165
|
/** Data format for response. */
|
|
1093
|
-
alt?:
|
|
1166
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1094
1167
|
/** JSONP */
|
|
1095
1168
|
callback?: string;
|
|
1096
1169
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1115,11 +1188,11 @@ declare namespace gapi.client {
|
|
|
1115
1188
|
/** Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). */
|
|
1116
1189
|
runReport(request: {
|
|
1117
1190
|
/** V1 error format. */
|
|
1118
|
-
'$.xgafv'?:
|
|
1191
|
+
'$.xgafv'?: '1' | '2';
|
|
1119
1192
|
/** OAuth access token. */
|
|
1120
1193
|
access_token?: string;
|
|
1121
1194
|
/** Data format for response. */
|
|
1122
|
-
alt?:
|
|
1195
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1123
1196
|
/** JSONP */
|
|
1124
1197
|
callback?: string;
|
|
1125
1198
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1144,11 +1217,11 @@ declare namespace gapi.client {
|
|
|
1144
1217
|
runReport(
|
|
1145
1218
|
request: {
|
|
1146
1219
|
/** V1 error format. */
|
|
1147
|
-
'$.xgafv'?:
|
|
1220
|
+
'$.xgafv'?: '1' | '2';
|
|
1148
1221
|
/** OAuth access token. */
|
|
1149
1222
|
access_token?: string;
|
|
1150
1223
|
/** Data format for response. */
|
|
1151
|
-
alt?:
|
|
1224
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1152
1225
|
/** JSONP */
|
|
1153
1226
|
callback?: string;
|
|
1154
1227
|
/** Selector specifying which fields to include in a partial response. */
|