@maxim_mazurok/gapi.client.analyticsdata-v1beta 0.0.20230425 → 0.0.20230426
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 +699 -350
- package/package.json +1 -1
- 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://analyticsdata.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230426
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,57 +24,75 @@ declare namespace gapi.client {
|
|
|
24
24
|
namespace analyticsdata {
|
|
25
25
|
interface ActiveMetricRestriction {
|
|
26
26
|
/** The name of the restricted metric. */
|
|
27
|
-
metricName?:
|
|
27
|
+
metricName?:
|
|
28
|
+
string;
|
|
28
29
|
/** The reason for this metric's restriction. */
|
|
29
|
-
restrictedMetricTypes?:
|
|
30
|
+
restrictedMetricTypes?:
|
|
31
|
+
string[];
|
|
30
32
|
}
|
|
31
33
|
interface BatchRunPivotReportsRequest {
|
|
32
34
|
/** Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests. */
|
|
33
|
-
requests?:
|
|
35
|
+
requests?:
|
|
36
|
+
RunPivotReportRequest[];
|
|
34
37
|
}
|
|
35
38
|
interface BatchRunPivotReportsResponse {
|
|
36
39
|
/** Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#batchRunPivotReports". Useful to distinguish between response types in JSON. */
|
|
37
|
-
kind?:
|
|
40
|
+
kind?:
|
|
41
|
+
string;
|
|
38
42
|
/** Individual responses. Each response has a separate pivot report request. */
|
|
39
|
-
pivotReports?:
|
|
43
|
+
pivotReports?:
|
|
44
|
+
RunPivotReportResponse[];
|
|
40
45
|
}
|
|
41
46
|
interface BatchRunReportsRequest {
|
|
42
47
|
/** Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests. */
|
|
43
|
-
requests?:
|
|
48
|
+
requests?:
|
|
49
|
+
RunReportRequest[];
|
|
44
50
|
}
|
|
45
51
|
interface BatchRunReportsResponse {
|
|
46
52
|
/** Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#batchRunReports". Useful to distinguish between response types in JSON. */
|
|
47
|
-
kind?:
|
|
53
|
+
kind?:
|
|
54
|
+
string;
|
|
48
55
|
/** Individual responses. Each response has a separate report request. */
|
|
49
|
-
reports?:
|
|
56
|
+
reports?:
|
|
57
|
+
RunReportResponse[];
|
|
50
58
|
}
|
|
51
59
|
interface BetweenFilter {
|
|
52
60
|
/** Begins with this number. */
|
|
53
|
-
fromValue?:
|
|
61
|
+
fromValue?:
|
|
62
|
+
NumericValue;
|
|
54
63
|
/** Ends with this number. */
|
|
55
|
-
toValue?:
|
|
64
|
+
toValue?:
|
|
65
|
+
NumericValue;
|
|
56
66
|
}
|
|
57
67
|
interface CaseExpression {
|
|
58
68
|
/** Name of a dimension. The name must refer back to a name in dimensions field of the request. */
|
|
59
|
-
dimensionName?:
|
|
69
|
+
dimensionName?:
|
|
70
|
+
string;
|
|
60
71
|
}
|
|
61
72
|
interface CheckCompatibilityRequest {
|
|
62
73
|
/** Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics. */
|
|
63
|
-
compatibilityFilter?:
|
|
74
|
+
compatibilityFilter?:
|
|
75
|
+
string;
|
|
64
76
|
/** The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request. */
|
|
65
|
-
dimensionFilter?:
|
|
77
|
+
dimensionFilter?:
|
|
78
|
+
FilterExpression;
|
|
66
79
|
/** The dimensions in this report. `dimensions` should be the same value as in your `runReport` request. */
|
|
67
|
-
dimensions?:
|
|
80
|
+
dimensions?:
|
|
81
|
+
Dimension[];
|
|
68
82
|
/** The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request */
|
|
69
|
-
metricFilter?:
|
|
83
|
+
metricFilter?:
|
|
84
|
+
FilterExpression;
|
|
70
85
|
/** The metrics in this report. `metrics` should be the same value as in your `runReport` request. */
|
|
71
|
-
metrics?:
|
|
86
|
+
metrics?:
|
|
87
|
+
Metric[];
|
|
72
88
|
}
|
|
73
89
|
interface CheckCompatibilityResponse {
|
|
74
90
|
/** The compatibility of each dimension. */
|
|
75
|
-
dimensionCompatibilities?:
|
|
91
|
+
dimensionCompatibilities?:
|
|
92
|
+
DimensionCompatibility[];
|
|
76
93
|
/** The compatibility of each metric. */
|
|
77
|
-
metricCompatibilities?:
|
|
94
|
+
metricCompatibilities?:
|
|
95
|
+
MetricCompatibility[];
|
|
78
96
|
}
|
|
79
97
|
interface Cohort {
|
|
80
98
|
/**
|
|
@@ -85,29 +103,36 @@ declare namespace gapi.client {
|
|
|
85
103
|
* `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this
|
|
86
104
|
* `dateRange` can be aligned to a month, starting at the first and ending on the last day of the month.
|
|
87
105
|
*/
|
|
88
|
-
dateRange?:
|
|
106
|
+
dateRange?:
|
|
107
|
+
DateRange;
|
|
89
108
|
/** Dimension used by the cohort. Required and only supports `firstSessionDate`. */
|
|
90
|
-
dimension?:
|
|
109
|
+
dimension?:
|
|
110
|
+
string;
|
|
91
111
|
/**
|
|
92
112
|
* Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named
|
|
93
113
|
* by their zero based index `cohort_0`, `cohort_1`, etc.
|
|
94
114
|
*/
|
|
95
|
-
name?:
|
|
115
|
+
name?:
|
|
116
|
+
string;
|
|
96
117
|
}
|
|
97
118
|
interface CohortReportSettings {
|
|
98
119
|
/** If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`. */
|
|
99
|
-
accumulate?:
|
|
120
|
+
accumulate?:
|
|
121
|
+
boolean;
|
|
100
122
|
}
|
|
101
123
|
interface CohortSpec {
|
|
102
124
|
/** Optional settings for a cohort report. */
|
|
103
|
-
cohortReportSettings?:
|
|
125
|
+
cohortReportSettings?:
|
|
126
|
+
CohortReportSettings;
|
|
104
127
|
/**
|
|
105
128
|
* Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the
|
|
106
129
|
* report by their name.
|
|
107
130
|
*/
|
|
108
|
-
cohorts?:
|
|
131
|
+
cohorts?:
|
|
132
|
+
Cohort[];
|
|
109
133
|
/** Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over. */
|
|
110
|
-
cohortsRange?:
|
|
134
|
+
cohortsRange?:
|
|
135
|
+
CohortsRange;
|
|
111
136
|
}
|
|
112
137
|
interface CohortsRange {
|
|
113
138
|
/**
|
|
@@ -116,16 +141,19 @@ declare namespace gapi.client {
|
|
|
116
141
|
* 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`
|
|
117
142
|
* is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days.
|
|
118
143
|
*/
|
|
119
|
-
endOffset?:
|
|
144
|
+
endOffset?:
|
|
145
|
+
number;
|
|
120
146
|
/** Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report. */
|
|
121
|
-
granularity?:
|
|
147
|
+
granularity?:
|
|
148
|
+
string;
|
|
122
149
|
/**
|
|
123
150
|
* `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
|
|
124
151
|
* 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
|
|
125
152
|
* `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
|
|
126
153
|
* extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days.
|
|
127
154
|
*/
|
|
128
|
-
startOffset?:
|
|
155
|
+
startOffset?:
|
|
156
|
+
number;
|
|
129
157
|
}
|
|
130
158
|
interface ConcatenateExpression {
|
|
131
159
|
/**
|
|
@@ -133,191 +161,246 @@ declare namespace gapi.client {
|
|
|
133
161
|
* 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
|
|
134
162
|
* "US,FR,JP".
|
|
135
163
|
*/
|
|
136
|
-
delimiter?:
|
|
164
|
+
delimiter?:
|
|
165
|
+
string;
|
|
137
166
|
/** Names of dimensions. The names must refer back to names in the dimensions field of the request. */
|
|
138
|
-
dimensionNames?:
|
|
167
|
+
dimensionNames?:
|
|
168
|
+
string[];
|
|
139
169
|
}
|
|
140
170
|
interface DateRange {
|
|
141
171
|
/**
|
|
142
172
|
* The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case,
|
|
143
173
|
* the date is inferred based on the property's reporting time zone.
|
|
144
174
|
*/
|
|
145
|
-
endDate?:
|
|
175
|
+
endDate?:
|
|
176
|
+
string;
|
|
146
177
|
/**
|
|
147
178
|
* Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date
|
|
148
179
|
* ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.
|
|
149
180
|
*/
|
|
150
|
-
name?:
|
|
181
|
+
name?:
|
|
182
|
+
string;
|
|
151
183
|
/**
|
|
152
184
|
* The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the
|
|
153
185
|
* date is inferred based on the property's reporting time zone.
|
|
154
186
|
*/
|
|
155
|
-
startDate?:
|
|
187
|
+
startDate?:
|
|
188
|
+
string;
|
|
156
189
|
}
|
|
157
190
|
interface Dimension {
|
|
158
191
|
/** One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). */
|
|
159
|
-
dimensionExpression?:
|
|
192
|
+
dimensionExpression?:
|
|
193
|
+
DimensionExpression;
|
|
160
194
|
/**
|
|
161
195
|
* The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If
|
|
162
196
|
* `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and
|
|
163
197
|
* `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in
|
|
164
198
|
* `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
|
|
165
199
|
*/
|
|
166
|
-
name?:
|
|
200
|
+
name?:
|
|
201
|
+
string;
|
|
167
202
|
}
|
|
168
203
|
interface DimensionCompatibility {
|
|
169
204
|
/** The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report. */
|
|
170
|
-
compatibility?:
|
|
205
|
+
compatibility?:
|
|
206
|
+
string;
|
|
171
207
|
/** 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. */
|
|
172
|
-
dimensionMetadata?:
|
|
208
|
+
dimensionMetadata?:
|
|
209
|
+
DimensionMetadata;
|
|
173
210
|
}
|
|
174
211
|
interface DimensionExpression {
|
|
175
212
|
/** Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). */
|
|
176
|
-
concatenate?:
|
|
213
|
+
concatenate?:
|
|
214
|
+
ConcatenateExpression;
|
|
177
215
|
/** Used to convert a dimension value to lower case. */
|
|
178
|
-
lowerCase?:
|
|
216
|
+
lowerCase?:
|
|
217
|
+
CaseExpression;
|
|
179
218
|
/** Used to convert a dimension value to upper case. */
|
|
180
|
-
upperCase?:
|
|
219
|
+
upperCase?:
|
|
220
|
+
CaseExpression;
|
|
181
221
|
}
|
|
182
222
|
interface DimensionHeader {
|
|
183
223
|
/** The dimension's name. */
|
|
184
|
-
name?:
|
|
224
|
+
name?:
|
|
225
|
+
string;
|
|
185
226
|
}
|
|
186
227
|
interface DimensionMetadata {
|
|
187
228
|
/** This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`. */
|
|
188
|
-
apiName?:
|
|
229
|
+
apiName?:
|
|
230
|
+
string;
|
|
189
231
|
/** The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. */
|
|
190
|
-
category?:
|
|
232
|
+
category?:
|
|
233
|
+
string;
|
|
191
234
|
/** True if the dimension is a custom dimension for this property. */
|
|
192
|
-
customDefinition?:
|
|
235
|
+
customDefinition?:
|
|
236
|
+
boolean;
|
|
193
237
|
/**
|
|
194
238
|
* Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the
|
|
195
239
|
* deprecation period, the dimension will be available only by `apiName`.
|
|
196
240
|
*/
|
|
197
|
-
deprecatedApiNames?:
|
|
241
|
+
deprecatedApiNames?:
|
|
242
|
+
string[];
|
|
198
243
|
/** Description of how this dimension is used and calculated. */
|
|
199
|
-
description?:
|
|
244
|
+
description?:
|
|
245
|
+
string;
|
|
200
246
|
/** This dimension's name within the Google Analytics user interface. For example, `Event name`. */
|
|
201
|
-
uiName?:
|
|
247
|
+
uiName?:
|
|
248
|
+
string;
|
|
202
249
|
}
|
|
203
250
|
interface DimensionOrderBy {
|
|
204
251
|
/** A dimension name in the request to order by. */
|
|
205
|
-
dimensionName?:
|
|
252
|
+
dimensionName?:
|
|
253
|
+
string;
|
|
206
254
|
/** Controls the rule for dimension value ordering. */
|
|
207
|
-
orderType?:
|
|
255
|
+
orderType?:
|
|
256
|
+
string;
|
|
208
257
|
}
|
|
209
258
|
interface DimensionValue {
|
|
210
259
|
/** Value as a string if the dimension type is a string. */
|
|
211
|
-
value?:
|
|
260
|
+
value?:
|
|
261
|
+
string;
|
|
212
262
|
}
|
|
213
263
|
interface Filter {
|
|
214
264
|
/** A filter for two values. */
|
|
215
|
-
betweenFilter?:
|
|
265
|
+
betweenFilter?:
|
|
266
|
+
BetweenFilter;
|
|
216
267
|
/**
|
|
217
268
|
* The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be
|
|
218
269
|
* additionally specified by name in the RunPivotReportRequest's dimensions or metrics.
|
|
219
270
|
*/
|
|
220
|
-
fieldName?:
|
|
271
|
+
fieldName?:
|
|
272
|
+
string;
|
|
221
273
|
/** A filter for in list values. */
|
|
222
|
-
inListFilter?:
|
|
274
|
+
inListFilter?:
|
|
275
|
+
InListFilter;
|
|
223
276
|
/** A filter for numeric or date values. */
|
|
224
|
-
numericFilter?:
|
|
277
|
+
numericFilter?:
|
|
278
|
+
NumericFilter;
|
|
225
279
|
/** Strings related filter. */
|
|
226
|
-
stringFilter?:
|
|
280
|
+
stringFilter?:
|
|
281
|
+
StringFilter;
|
|
227
282
|
}
|
|
228
283
|
interface FilterExpression {
|
|
229
284
|
/** The FilterExpressions in and_group have an AND relationship. */
|
|
230
|
-
andGroup?:
|
|
285
|
+
andGroup?:
|
|
286
|
+
FilterExpressionList;
|
|
231
287
|
/** A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. */
|
|
232
|
-
filter?:
|
|
288
|
+
filter?:
|
|
289
|
+
Filter;
|
|
233
290
|
/** The FilterExpression is NOT of not_expression. */
|
|
234
|
-
notExpression?:
|
|
291
|
+
notExpression?:
|
|
292
|
+
FilterExpression;
|
|
235
293
|
/** The FilterExpressions in or_group have an OR relationship. */
|
|
236
|
-
orGroup?:
|
|
294
|
+
orGroup?:
|
|
295
|
+
FilterExpressionList;
|
|
237
296
|
}
|
|
238
297
|
interface FilterExpressionList {
|
|
239
298
|
/** A list of filter expressions. */
|
|
240
|
-
expressions?:
|
|
299
|
+
expressions?:
|
|
300
|
+
FilterExpression[];
|
|
241
301
|
}
|
|
242
302
|
interface InListFilter {
|
|
243
303
|
/** If true, the string value is case sensitive. */
|
|
244
|
-
caseSensitive?:
|
|
304
|
+
caseSensitive?:
|
|
305
|
+
boolean;
|
|
245
306
|
/** The list of string values. Must be non-empty. */
|
|
246
|
-
values?:
|
|
307
|
+
values?:
|
|
308
|
+
string[];
|
|
247
309
|
}
|
|
248
310
|
interface Metadata {
|
|
249
311
|
/** The dimension descriptions. */
|
|
250
|
-
dimensions?:
|
|
312
|
+
dimensions?:
|
|
313
|
+
DimensionMetadata[];
|
|
251
314
|
/** The metric descriptions. */
|
|
252
|
-
metrics?:
|
|
315
|
+
metrics?:
|
|
316
|
+
MetricMetadata[];
|
|
253
317
|
/** Resource name of this metadata. */
|
|
254
|
-
name?:
|
|
318
|
+
name?:
|
|
319
|
+
string;
|
|
255
320
|
}
|
|
256
321
|
interface Metric {
|
|
257
322
|
/** A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`. */
|
|
258
|
-
expression?:
|
|
323
|
+
expression?:
|
|
324
|
+
string;
|
|
259
325
|
/**
|
|
260
326
|
* Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`,
|
|
261
327
|
* `orderBys`, or a metric `expression`.
|
|
262
328
|
*/
|
|
263
|
-
invisible?:
|
|
329
|
+
invisible?:
|
|
330
|
+
boolean;
|
|
264
331
|
/**
|
|
265
332
|
* The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression`
|
|
266
333
|
* is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's
|
|
267
334
|
* name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
|
|
268
335
|
* `expression`.
|
|
269
336
|
*/
|
|
270
|
-
name?:
|
|
337
|
+
name?:
|
|
338
|
+
string;
|
|
271
339
|
}
|
|
272
340
|
interface MetricCompatibility {
|
|
273
341
|
/** The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report. */
|
|
274
|
-
compatibility?:
|
|
342
|
+
compatibility?:
|
|
343
|
+
string;
|
|
275
344
|
/** 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. */
|
|
276
|
-
metricMetadata?:
|
|
345
|
+
metricMetadata?:
|
|
346
|
+
MetricMetadata;
|
|
277
347
|
}
|
|
278
348
|
interface MetricHeader {
|
|
279
349
|
/** The metric's name. */
|
|
280
|
-
name?:
|
|
350
|
+
name?:
|
|
351
|
+
string;
|
|
281
352
|
/** The metric's data type. */
|
|
282
|
-
type?:
|
|
353
|
+
type?:
|
|
354
|
+
string;
|
|
283
355
|
}
|
|
284
356
|
interface MetricMetadata {
|
|
285
357
|
/** A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`. */
|
|
286
|
-
apiName?:
|
|
358
|
+
apiName?:
|
|
359
|
+
string;
|
|
287
360
|
/**
|
|
288
361
|
* 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
|
|
289
362
|
* 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
|
|
290
363
|
* and data-restriction management](https://support.google.com/analytics/answer/10851388).
|
|
291
364
|
*/
|
|
292
|
-
blockedReasons?:
|
|
365
|
+
blockedReasons?:
|
|
366
|
+
string[];
|
|
293
367
|
/** The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together. */
|
|
294
|
-
category?:
|
|
368
|
+
category?:
|
|
369
|
+
string;
|
|
295
370
|
/** True if the metric is a custom metric for this property. */
|
|
296
|
-
customDefinition?:
|
|
371
|
+
customDefinition?:
|
|
372
|
+
boolean;
|
|
297
373
|
/**
|
|
298
374
|
* Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the
|
|
299
375
|
* deprecation period, the metric will be available only by `apiName`.
|
|
300
376
|
*/
|
|
301
|
-
deprecatedApiNames?:
|
|
377
|
+
deprecatedApiNames?:
|
|
378
|
+
string[];
|
|
302
379
|
/** Description of how this metric is used and calculated. */
|
|
303
|
-
description?:
|
|
380
|
+
description?:
|
|
381
|
+
string;
|
|
304
382
|
/**
|
|
305
383
|
* 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
|
|
306
384
|
* non-expressions, this field is empty.
|
|
307
385
|
*/
|
|
308
|
-
expression?:
|
|
386
|
+
expression?:
|
|
387
|
+
string;
|
|
309
388
|
/** The type of this metric. */
|
|
310
|
-
type?:
|
|
389
|
+
type?:
|
|
390
|
+
string;
|
|
311
391
|
/** This metric's name within the Google Analytics user interface. For example, `Event count`. */
|
|
312
|
-
uiName?:
|
|
392
|
+
uiName?:
|
|
393
|
+
string;
|
|
313
394
|
}
|
|
314
395
|
interface MetricOrderBy {
|
|
315
396
|
/** A metric name in the request to order by. */
|
|
316
|
-
metricName?:
|
|
397
|
+
metricName?:
|
|
398
|
+
string;
|
|
317
399
|
}
|
|
318
400
|
interface MetricValue {
|
|
319
401
|
/** Measurement value. See MetricHeader for type. */
|
|
320
|
-
value?:
|
|
402
|
+
value?:
|
|
403
|
+
string;
|
|
321
404
|
}
|
|
322
405
|
interface MinuteRange {
|
|
323
406
|
/**
|
|
@@ -325,120 +408,151 @@ declare namespace gapi.client {
|
|
|
325
408
|
* event data from prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics properties can request any minute in the last 30 minutes of event data
|
|
326
409
|
* (`endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
|
|
327
410
|
*/
|
|
328
|
-
endMinutesAgo?:
|
|
411
|
+
endMinutesAgo?:
|
|
412
|
+
number;
|
|
329
413
|
/**
|
|
330
414
|
* Assigns a name to this minute range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set,
|
|
331
415
|
* minute ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.
|
|
332
416
|
*/
|
|
333
|
-
name?:
|
|
417
|
+
name?:
|
|
418
|
+
string;
|
|
334
419
|
/**
|
|
335
420
|
* The inclusive start minute for the query as a number of minutes before now. For example, `"startMinutesAgo": 29` specifies the report should include event data from 29 minutes ago
|
|
336
421
|
* and after. Cannot be after `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics properties can request up to the last 30 minutes of event data
|
|
337
422
|
* (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to the last 60 minutes of event data (`startMinutesAgo <= 59`).
|
|
338
423
|
*/
|
|
339
|
-
startMinutesAgo?:
|
|
424
|
+
startMinutesAgo?:
|
|
425
|
+
number;
|
|
340
426
|
}
|
|
341
427
|
interface NumericFilter {
|
|
342
428
|
/** The operation type for this filter. */
|
|
343
|
-
operation?:
|
|
429
|
+
operation?:
|
|
430
|
+
string;
|
|
344
431
|
/** A numeric value or a date value. */
|
|
345
|
-
value?:
|
|
432
|
+
value?:
|
|
433
|
+
NumericValue;
|
|
346
434
|
}
|
|
347
435
|
interface NumericValue {
|
|
348
436
|
/** Double value */
|
|
349
|
-
doubleValue?:
|
|
437
|
+
doubleValue?:
|
|
438
|
+
number;
|
|
350
439
|
/** Integer value */
|
|
351
|
-
int64Value?:
|
|
440
|
+
int64Value?:
|
|
441
|
+
string;
|
|
352
442
|
}
|
|
353
443
|
interface OrderBy {
|
|
354
444
|
/** If true, sorts by descending order. */
|
|
355
|
-
desc?:
|
|
445
|
+
desc?:
|
|
446
|
+
boolean;
|
|
356
447
|
/** Sorts results by a dimension's values. */
|
|
357
|
-
dimension?:
|
|
448
|
+
dimension?:
|
|
449
|
+
DimensionOrderBy;
|
|
358
450
|
/** Sorts results by a metric's values. */
|
|
359
|
-
metric?:
|
|
451
|
+
metric?:
|
|
452
|
+
MetricOrderBy;
|
|
360
453
|
/** Sorts results by a metric's values within a pivot column group. */
|
|
361
|
-
pivot?:
|
|
454
|
+
pivot?:
|
|
455
|
+
PivotOrderBy;
|
|
362
456
|
}
|
|
363
457
|
interface Pivot {
|
|
364
458
|
/**
|
|
365
459
|
* Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range
|
|
366
460
|
* column will indicate the corresponding date range from the request.
|
|
367
461
|
*/
|
|
368
|
-
fieldNames?:
|
|
462
|
+
fieldNames?:
|
|
463
|
+
string[];
|
|
369
464
|
/**
|
|
370
465
|
* 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
|
|
371
466
|
* 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
|
|
372
467
|
* product is `1,000,000`.
|
|
373
468
|
*/
|
|
374
|
-
limit?:
|
|
469
|
+
limit?:
|
|
470
|
+
string;
|
|
375
471
|
/** Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations. */
|
|
376
|
-
metricAggregations?:
|
|
472
|
+
metricAggregations?:
|
|
473
|
+
string[];
|
|
377
474
|
/** The row count of the start row. The first row is counted as row 0. */
|
|
378
|
-
offset?:
|
|
475
|
+
offset?:
|
|
476
|
+
string;
|
|
379
477
|
/**
|
|
380
478
|
* 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
|
|
381
479
|
* only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
|
|
382
480
|
*/
|
|
383
|
-
orderBys?:
|
|
481
|
+
orderBys?:
|
|
482
|
+
OrderBy[];
|
|
384
483
|
}
|
|
385
484
|
interface PivotDimensionHeader {
|
|
386
485
|
/** Values of multiple dimensions in a pivot. */
|
|
387
|
-
dimensionValues?:
|
|
486
|
+
dimensionValues?:
|
|
487
|
+
DimensionValue[];
|
|
388
488
|
}
|
|
389
489
|
interface PivotHeader {
|
|
390
490
|
/** The size is the same as the cardinality of the corresponding dimension combinations. */
|
|
391
|
-
pivotDimensionHeaders?:
|
|
491
|
+
pivotDimensionHeaders?:
|
|
492
|
+
PivotDimensionHeader[];
|
|
392
493
|
/** The cardinality of the pivot. The total number of rows for this pivot's fields regardless of how the parameters `offset` and `limit` are specified in the request. */
|
|
393
|
-
rowCount?:
|
|
494
|
+
rowCount?:
|
|
495
|
+
number;
|
|
394
496
|
}
|
|
395
497
|
interface PivotOrderBy {
|
|
396
498
|
/** In the response to order by, order rows by this column. Must be a metric name from the request. */
|
|
397
|
-
metricName?:
|
|
499
|
+
metricName?:
|
|
500
|
+
string;
|
|
398
501
|
/**
|
|
399
502
|
* Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the
|
|
400
503
|
* row's dimension name and value pair.
|
|
401
504
|
*/
|
|
402
|
-
pivotSelections?:
|
|
505
|
+
pivotSelections?:
|
|
506
|
+
PivotSelection[];
|
|
403
507
|
}
|
|
404
508
|
interface PivotSelection {
|
|
405
509
|
/** Must be a dimension name from the request. */
|
|
406
|
-
dimensionName?:
|
|
510
|
+
dimensionName?:
|
|
511
|
+
string;
|
|
407
512
|
/** Order by only when the named dimension is this value. */
|
|
408
|
-
dimensionValue?:
|
|
513
|
+
dimensionValue?:
|
|
514
|
+
string;
|
|
409
515
|
}
|
|
410
516
|
interface PropertyQuota {
|
|
411
517
|
/** Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests. */
|
|
412
|
-
concurrentRequests?:
|
|
518
|
+
concurrentRequests?:
|
|
519
|
+
QuotaStatus;
|
|
413
520
|
/**
|
|
414
521
|
* Analytics Properties can send up to 120 requests with potentially thresholded dimensions per hour. In a batch request, each report request is individually counted for this quota if
|
|
415
522
|
* the request contains potentially thresholded dimensions.
|
|
416
523
|
*/
|
|
417
|
-
potentiallyThresholdedRequestsPerHour?:
|
|
524
|
+
potentiallyThresholdedRequestsPerHour?:
|
|
525
|
+
QuotaStatus;
|
|
418
526
|
/**
|
|
419
527
|
* Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per
|
|
420
528
|
* hour.
|
|
421
529
|
*/
|
|
422
|
-
serverErrorsPerProjectPerHour?:
|
|
530
|
+
serverErrorsPerProjectPerHour?:
|
|
531
|
+
QuotaStatus;
|
|
423
532
|
/** Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. */
|
|
424
|
-
tokensPerDay?:
|
|
533
|
+
tokensPerDay?:
|
|
534
|
+
QuotaStatus;
|
|
425
535
|
/**
|
|
426
536
|
* Standard Analytics Properties can use up to 5,000 tokens per hour; Analytics 360 Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and
|
|
427
537
|
* that number is deducted from all of the hourly, daily, and per project hourly quotas.
|
|
428
538
|
*/
|
|
429
|
-
tokensPerHour?:
|
|
539
|
+
tokensPerHour?:
|
|
540
|
+
QuotaStatus;
|
|
430
541
|
/**
|
|
431
542
|
* Analytics Properties can use up to 25% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 1,250 tokens per project per hour, and
|
|
432
543
|
* Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily,
|
|
433
544
|
* and per project hourly quotas.
|
|
434
545
|
*/
|
|
435
|
-
tokensPerProjectPerHour?:
|
|
546
|
+
tokensPerProjectPerHour?:
|
|
547
|
+
QuotaStatus;
|
|
436
548
|
}
|
|
437
549
|
interface QuotaStatus {
|
|
438
550
|
/** Quota consumed by this request. */
|
|
439
|
-
consumed?:
|
|
551
|
+
consumed?:
|
|
552
|
+
number;
|
|
440
553
|
/** Quota remaining after this request. */
|
|
441
|
-
remaining?:
|
|
554
|
+
remaining?:
|
|
555
|
+
number;
|
|
442
556
|
}
|
|
443
557
|
interface ResponseMetaData {
|
|
444
558
|
/**
|
|
@@ -446,7 +560,8 @@ declare namespace gapi.client {
|
|
|
446
560
|
* this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency
|
|
447
561
|
* types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.
|
|
448
562
|
*/
|
|
449
|
-
currencyCode?:
|
|
563
|
+
currencyCode?:
|
|
564
|
+
string;
|
|
450
565
|
/**
|
|
451
566
|
* If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is
|
|
452
567
|
* populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the
|
|
@@ -454,370 +569,492 @@ declare namespace gapi.client {
|
|
|
454
569
|
* present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data
|
|
455
570
|
* sampling](https://support.google.com/analytics/answer/13208658#reports).
|
|
456
571
|
*/
|
|
457
|
-
dataLossFromOtherRow?:
|
|
572
|
+
dataLossFromOtherRow?:
|
|
573
|
+
boolean;
|
|
458
574
|
/** If empty reason is specified, the report is empty for this reason. */
|
|
459
|
-
emptyReason?:
|
|
575
|
+
emptyReason?:
|
|
576
|
+
string;
|
|
460
577
|
/**
|
|
461
578
|
* Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction
|
|
462
579
|
* management](https://support.google.com/analytics/answer/10851388).
|
|
463
580
|
*/
|
|
464
|
-
schemaRestrictionResponse?:
|
|
581
|
+
schemaRestrictionResponse?:
|
|
582
|
+
SchemaRestrictionResponse;
|
|
465
583
|
/**
|
|
466
584
|
* If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be
|
|
467
585
|
* subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data
|
|
468
586
|
* thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).
|
|
469
587
|
*/
|
|
470
|
-
subjectToThresholding?:
|
|
588
|
+
subjectToThresholding?:
|
|
589
|
+
boolean;
|
|
471
590
|
/**
|
|
472
591
|
* The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database
|
|
473
592
|
* (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
|
|
474
593
|
*/
|
|
475
|
-
timeZone?:
|
|
594
|
+
timeZone?:
|
|
595
|
+
string;
|
|
476
596
|
}
|
|
477
597
|
interface Row {
|
|
478
598
|
/** List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot. */
|
|
479
|
-
dimensionValues?:
|
|
599
|
+
dimensionValues?:
|
|
600
|
+
DimensionValue[];
|
|
480
601
|
/** List of requested visible metric values. */
|
|
481
|
-
metricValues?:
|
|
602
|
+
metricValues?:
|
|
603
|
+
MetricValue[];
|
|
482
604
|
}
|
|
483
605
|
interface RunPivotReportRequest {
|
|
484
606
|
/** Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. */
|
|
485
|
-
cohortSpec?:
|
|
607
|
+
cohortSpec?:
|
|
608
|
+
CohortSpec;
|
|
486
609
|
/** A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. */
|
|
487
|
-
currencyCode?:
|
|
610
|
+
currencyCode?:
|
|
611
|
+
string;
|
|
488
612
|
/**
|
|
489
613
|
* 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
|
|
490
614
|
* 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.
|
|
491
615
|
*/
|
|
492
|
-
dateRanges?:
|
|
616
|
+
dateRanges?:
|
|
617
|
+
DateRange[];
|
|
493
618
|
/** The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter. */
|
|
494
|
-
dimensionFilter?:
|
|
619
|
+
dimensionFilter?:
|
|
620
|
+
FilterExpression;
|
|
495
621
|
/** The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. */
|
|
496
|
-
dimensions?:
|
|
622
|
+
dimensions?:
|
|
623
|
+
Dimension[];
|
|
497
624
|
/**
|
|
498
625
|
* If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless
|
|
499
626
|
* of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event,
|
|
500
627
|
* then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.
|
|
501
628
|
*/
|
|
502
|
-
keepEmptyRows?:
|
|
629
|
+
keepEmptyRows?:
|
|
630
|
+
boolean;
|
|
503
631
|
/**
|
|
504
632
|
* The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this
|
|
505
633
|
* filter.
|
|
506
634
|
*/
|
|
507
|
-
metricFilter?:
|
|
635
|
+
metricFilter?:
|
|
636
|
+
FilterExpression;
|
|
508
637
|
/** The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys. */
|
|
509
|
-
metrics?:
|
|
638
|
+
metrics?:
|
|
639
|
+
Metric[];
|
|
510
640
|
/**
|
|
511
641
|
* Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in
|
|
512
642
|
* Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
|
|
513
643
|
*/
|
|
514
|
-
pivots?:
|
|
644
|
+
pivots?:
|
|
645
|
+
Pivot[];
|
|
515
646
|
/**
|
|
516
647
|
* 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
|
|
517
648
|
* 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
|
|
518
649
|
* batch-level property. Example: properties/1234
|
|
519
650
|
*/
|
|
520
|
-
property?:
|
|
651
|
+
property?:
|
|
652
|
+
string;
|
|
521
653
|
/** Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
|
|
522
|
-
returnPropertyQuota?:
|
|
654
|
+
returnPropertyQuota?:
|
|
655
|
+
boolean;
|
|
523
656
|
}
|
|
524
657
|
interface RunPivotReportResponse {
|
|
525
658
|
/**
|
|
526
659
|
* Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation
|
|
527
660
|
* returned in each row is shown by the dimension_values which are set to "RESERVED_".
|
|
528
661
|
*/
|
|
529
|
-
aggregates?:
|
|
662
|
+
aggregates?:
|
|
663
|
+
Row[];
|
|
530
664
|
/** Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. */
|
|
531
|
-
dimensionHeaders?:
|
|
665
|
+
dimensionHeaders?:
|
|
666
|
+
DimensionHeader[];
|
|
532
667
|
/** Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON. */
|
|
533
|
-
kind?:
|
|
668
|
+
kind?:
|
|
669
|
+
string;
|
|
534
670
|
/** Metadata for the report. */
|
|
535
|
-
metadata?:
|
|
671
|
+
metadata?:
|
|
672
|
+
ResponseMetaData;
|
|
536
673
|
/** Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. */
|
|
537
|
-
metricHeaders?:
|
|
674
|
+
metricHeaders?:
|
|
675
|
+
MetricHeader[];
|
|
538
676
|
/**
|
|
539
677
|
* Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames":
|
|
540
678
|
* ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ {
|
|
541
679
|
* "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{
|
|
542
680
|
* "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]
|
|
543
681
|
*/
|
|
544
|
-
pivotHeaders?:
|
|
682
|
+
pivotHeaders?:
|
|
683
|
+
PivotHeader[];
|
|
545
684
|
/** This Analytics Property's quota state including this request. */
|
|
546
|
-
propertyQuota?:
|
|
685
|
+
propertyQuota?:
|
|
686
|
+
PropertyQuota;
|
|
547
687
|
/** Rows of dimension value combinations and metric values in the report. */
|
|
548
|
-
rows?:
|
|
688
|
+
rows?:
|
|
689
|
+
Row[];
|
|
549
690
|
}
|
|
550
691
|
interface RunRealtimeReportRequest {
|
|
551
692
|
/** The filter clause of dimensions. Metrics cannot be used in this filter. */
|
|
552
|
-
dimensionFilter?:
|
|
693
|
+
dimensionFilter?:
|
|
694
|
+
FilterExpression;
|
|
553
695
|
/** The dimensions requested and displayed. */
|
|
554
|
-
dimensions?:
|
|
696
|
+
dimensions?:
|
|
697
|
+
Dimension[];
|
|
555
698
|
/**
|
|
556
699
|
* 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
|
|
557
700
|
* 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
|
|
558
701
|
* 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.
|
|
559
702
|
*/
|
|
560
|
-
limit?:
|
|
703
|
+
limit?:
|
|
704
|
+
string;
|
|
561
705
|
/** Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". */
|
|
562
|
-
metricAggregations?:
|
|
706
|
+
metricAggregations?:
|
|
707
|
+
string[];
|
|
563
708
|
/** The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter. */
|
|
564
|
-
metricFilter?:
|
|
709
|
+
metricFilter?:
|
|
710
|
+
FilterExpression;
|
|
565
711
|
/** The metrics requested and displayed. */
|
|
566
|
-
metrics?:
|
|
712
|
+
metrics?:
|
|
713
|
+
Metric[];
|
|
567
714
|
/**
|
|
568
715
|
* The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will
|
|
569
716
|
* contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.
|
|
570
717
|
*/
|
|
571
|
-
minuteRanges?:
|
|
718
|
+
minuteRanges?:
|
|
719
|
+
MinuteRange[];
|
|
572
720
|
/** Specifies how rows are ordered in the response. */
|
|
573
|
-
orderBys?:
|
|
721
|
+
orderBys?:
|
|
722
|
+
OrderBy[];
|
|
574
723
|
/** Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
|
|
575
|
-
returnPropertyQuota?:
|
|
724
|
+
returnPropertyQuota?:
|
|
725
|
+
boolean;
|
|
576
726
|
}
|
|
577
727
|
interface RunRealtimeReportResponse {
|
|
578
728
|
/** Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. */
|
|
579
|
-
dimensionHeaders?:
|
|
729
|
+
dimensionHeaders?:
|
|
730
|
+
DimensionHeader[];
|
|
580
731
|
/** Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runRealtimeReport". Useful to distinguish between response types in JSON. */
|
|
581
|
-
kind?:
|
|
732
|
+
kind?:
|
|
733
|
+
string;
|
|
582
734
|
/** If requested, the maximum values of metrics. */
|
|
583
|
-
maximums?:
|
|
735
|
+
maximums?:
|
|
736
|
+
Row[];
|
|
584
737
|
/** Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. */
|
|
585
|
-
metricHeaders?:
|
|
738
|
+
metricHeaders?:
|
|
739
|
+
MetricHeader[];
|
|
586
740
|
/** If requested, the minimum values of metrics. */
|
|
587
|
-
minimums?:
|
|
741
|
+
minimums?:
|
|
742
|
+
Row[];
|
|
588
743
|
/** This Analytics Property's Realtime quota state including this request. */
|
|
589
|
-
propertyQuota?:
|
|
744
|
+
propertyQuota?:
|
|
745
|
+
PropertyQuota;
|
|
590
746
|
/**
|
|
591
747
|
* The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response and the `limit` request parameter. For example if a query
|
|
592
748
|
* returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows.
|
|
593
749
|
*/
|
|
594
|
-
rowCount?:
|
|
750
|
+
rowCount?:
|
|
751
|
+
number;
|
|
595
752
|
/** Rows of dimension value combinations and metric values in the report. */
|
|
596
|
-
rows?:
|
|
753
|
+
rows?:
|
|
754
|
+
Row[];
|
|
597
755
|
/** If requested, the totaled values of metrics. */
|
|
598
|
-
totals?:
|
|
756
|
+
totals?:
|
|
757
|
+
Row[];
|
|
599
758
|
}
|
|
600
759
|
interface RunReportRequest {
|
|
601
760
|
/** Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. */
|
|
602
|
-
cohortSpec?:
|
|
761
|
+
cohortSpec?:
|
|
762
|
+
CohortSpec;
|
|
603
763
|
/** A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. */
|
|
604
|
-
currencyCode?:
|
|
764
|
+
currencyCode?:
|
|
765
|
+
string;
|
|
605
766
|
/**
|
|
606
767
|
* 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
|
|
607
768
|
* overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.
|
|
608
769
|
*/
|
|
609
|
-
dateRanges?:
|
|
770
|
+
dateRanges?:
|
|
771
|
+
DateRange[];
|
|
610
772
|
/**
|
|
611
773
|
* Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension
|
|
612
774
|
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
|
|
613
775
|
*/
|
|
614
|
-
dimensionFilter?:
|
|
776
|
+
dimensionFilter?:
|
|
777
|
+
FilterExpression;
|
|
615
778
|
/** The dimensions requested and displayed. */
|
|
616
|
-
dimensions?:
|
|
779
|
+
dimensions?:
|
|
780
|
+
Dimension[];
|
|
617
781
|
/**
|
|
618
782
|
* If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless
|
|
619
783
|
* of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event,
|
|
620
784
|
* then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.
|
|
621
785
|
*/
|
|
622
|
-
keepEmptyRows?:
|
|
786
|
+
keepEmptyRows?:
|
|
787
|
+
boolean;
|
|
623
788
|
/**
|
|
624
789
|
* 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
|
|
625
790
|
* 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
|
|
626
791
|
* 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
|
|
627
792
|
* pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
628
793
|
*/
|
|
629
|
-
limit?:
|
|
794
|
+
limit?:
|
|
795
|
+
string;
|
|
630
796
|
/** Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". */
|
|
631
|
-
metricAggregations?:
|
|
797
|
+
metricAggregations?:
|
|
798
|
+
string[];
|
|
632
799
|
/** The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. */
|
|
633
|
-
metricFilter?:
|
|
800
|
+
metricFilter?:
|
|
801
|
+
FilterExpression;
|
|
634
802
|
/** The metrics requested and displayed. */
|
|
635
|
-
metrics?:
|
|
803
|
+
metrics?:
|
|
804
|
+
Metric[];
|
|
636
805
|
/**
|
|
637
806
|
* The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request
|
|
638
807
|
* returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about
|
|
639
808
|
* this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
640
809
|
*/
|
|
641
|
-
offset?:
|
|
810
|
+
offset?:
|
|
811
|
+
string;
|
|
642
812
|
/** Specifies how rows are ordered in the response. */
|
|
643
|
-
orderBys?:
|
|
813
|
+
orderBys?:
|
|
814
|
+
OrderBy[];
|
|
644
815
|
/**
|
|
645
816
|
* 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
|
|
646
817
|
* 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
|
|
647
818
|
* batch-level property. Example: properties/1234
|
|
648
819
|
*/
|
|
649
|
-
property?:
|
|
820
|
+
property?:
|
|
821
|
+
string;
|
|
650
822
|
/** Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
|
|
651
|
-
returnPropertyQuota?:
|
|
823
|
+
returnPropertyQuota?:
|
|
824
|
+
boolean;
|
|
652
825
|
}
|
|
653
826
|
interface RunReportResponse {
|
|
654
827
|
/** Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. */
|
|
655
|
-
dimensionHeaders?:
|
|
828
|
+
dimensionHeaders?:
|
|
829
|
+
DimensionHeader[];
|
|
656
830
|
/** Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runReport". Useful to distinguish between response types in JSON. */
|
|
657
|
-
kind?:
|
|
831
|
+
kind?:
|
|
832
|
+
string;
|
|
658
833
|
/** If requested, the maximum values of metrics. */
|
|
659
|
-
maximums?:
|
|
834
|
+
maximums?:
|
|
835
|
+
Row[];
|
|
660
836
|
/** Metadata for the report. */
|
|
661
|
-
metadata?:
|
|
837
|
+
metadata?:
|
|
838
|
+
ResponseMetaData;
|
|
662
839
|
/** Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. */
|
|
663
|
-
metricHeaders?:
|
|
840
|
+
metricHeaders?:
|
|
841
|
+
MetricHeader[];
|
|
664
842
|
/** If requested, the minimum values of metrics. */
|
|
665
|
-
minimums?:
|
|
843
|
+
minimums?:
|
|
844
|
+
Row[];
|
|
666
845
|
/** This Analytics Property's quota state including this request. */
|
|
667
|
-
propertyQuota?:
|
|
846
|
+
propertyQuota?:
|
|
847
|
+
PropertyQuota;
|
|
668
848
|
/**
|
|
669
849
|
* The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request
|
|
670
850
|
* parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about
|
|
671
851
|
* this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
672
852
|
*/
|
|
673
|
-
rowCount?:
|
|
853
|
+
rowCount?:
|
|
854
|
+
number;
|
|
674
855
|
/** Rows of dimension value combinations and metric values in the report. */
|
|
675
|
-
rows?:
|
|
856
|
+
rows?:
|
|
857
|
+
Row[];
|
|
676
858
|
/** If requested, the totaled values of metrics. */
|
|
677
|
-
totals?:
|
|
859
|
+
totals?:
|
|
860
|
+
Row[];
|
|
678
861
|
}
|
|
679
862
|
interface SchemaRestrictionResponse {
|
|
680
863
|
/**
|
|
681
864
|
* All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction
|
|
682
865
|
* is only populated if the user's custom role disallows access to `REVENUE_DATA`.
|
|
683
866
|
*/
|
|
684
|
-
activeMetricRestrictions?:
|
|
867
|
+
activeMetricRestrictions?:
|
|
868
|
+
ActiveMetricRestriction[];
|
|
685
869
|
}
|
|
686
870
|
interface StringFilter {
|
|
687
871
|
/** If true, the string value is case sensitive. */
|
|
688
|
-
caseSensitive?:
|
|
872
|
+
caseSensitive?:
|
|
873
|
+
boolean;
|
|
689
874
|
/** The match type for this filter. */
|
|
690
|
-
matchType?:
|
|
875
|
+
matchType?:
|
|
876
|
+
string;
|
|
691
877
|
/** The string value used for the matching. */
|
|
692
|
-
value?:
|
|
878
|
+
value?:
|
|
879
|
+
string;
|
|
693
880
|
}
|
|
694
881
|
interface PropertiesResource {
|
|
695
882
|
/** Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property. */
|
|
696
883
|
batchRunPivotReports(request: {
|
|
697
884
|
/** V1 error format. */
|
|
698
|
-
"$.xgafv"?:
|
|
885
|
+
"$.xgafv"?:
|
|
886
|
+
string;
|
|
699
887
|
/** OAuth access token. */
|
|
700
|
-
access_token?:
|
|
888
|
+
access_token?:
|
|
889
|
+
string;
|
|
701
890
|
/** Data format for response. */
|
|
702
|
-
alt?:
|
|
891
|
+
alt?:
|
|
892
|
+
string;
|
|
703
893
|
/** JSONP */
|
|
704
|
-
callback?:
|
|
894
|
+
callback?:
|
|
895
|
+
string;
|
|
705
896
|
/** Selector specifying which fields to include in a partial response. */
|
|
706
|
-
fields?:
|
|
897
|
+
fields?:
|
|
898
|
+
string;
|
|
707
899
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
708
|
-
key?:
|
|
900
|
+
key?:
|
|
901
|
+
string;
|
|
709
902
|
/** OAuth 2.0 token for the current user. */
|
|
710
|
-
oauth_token?:
|
|
903
|
+
oauth_token?:
|
|
904
|
+
string;
|
|
711
905
|
/** Returns response with indentations and line breaks. */
|
|
712
|
-
prettyPrint?:
|
|
906
|
+
prettyPrint?:
|
|
907
|
+
boolean;
|
|
713
908
|
/**
|
|
714
909
|
* 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
|
|
715
910
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest
|
|
716
911
|
* may either be unspecified or consistent with this property. Example: properties/1234
|
|
717
912
|
*/
|
|
718
|
-
property:
|
|
913
|
+
property:
|
|
914
|
+
string;
|
|
719
915
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
720
|
-
quotaUser?:
|
|
916
|
+
quotaUser?:
|
|
917
|
+
string;
|
|
721
918
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
722
|
-
upload_protocol?:
|
|
919
|
+
upload_protocol?:
|
|
920
|
+
string;
|
|
723
921
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
724
|
-
uploadType?:
|
|
922
|
+
uploadType?:
|
|
923
|
+
string;
|
|
725
924
|
/** Request body */
|
|
726
|
-
resource:
|
|
925
|
+
resource:
|
|
926
|
+
BatchRunPivotReportsRequest;
|
|
727
927
|
}): Request<BatchRunPivotReportsResponse>;
|
|
728
928
|
batchRunPivotReports(request: {
|
|
729
929
|
/** V1 error format. */
|
|
730
|
-
"$.xgafv"?:
|
|
930
|
+
"$.xgafv"?:
|
|
931
|
+
string;
|
|
731
932
|
/** OAuth access token. */
|
|
732
|
-
access_token?:
|
|
933
|
+
access_token?:
|
|
934
|
+
string;
|
|
733
935
|
/** Data format for response. */
|
|
734
|
-
alt?:
|
|
936
|
+
alt?:
|
|
937
|
+
string;
|
|
735
938
|
/** JSONP */
|
|
736
|
-
callback?:
|
|
939
|
+
callback?:
|
|
940
|
+
string;
|
|
737
941
|
/** Selector specifying which fields to include in a partial response. */
|
|
738
|
-
fields?:
|
|
942
|
+
fields?:
|
|
943
|
+
string;
|
|
739
944
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
740
|
-
key?:
|
|
945
|
+
key?:
|
|
946
|
+
string;
|
|
741
947
|
/** OAuth 2.0 token for the current user. */
|
|
742
|
-
oauth_token?:
|
|
948
|
+
oauth_token?:
|
|
949
|
+
string;
|
|
743
950
|
/** Returns response with indentations and line breaks. */
|
|
744
|
-
prettyPrint?:
|
|
951
|
+
prettyPrint?:
|
|
952
|
+
boolean;
|
|
745
953
|
/**
|
|
746
954
|
* 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
|
|
747
955
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest
|
|
748
956
|
* may either be unspecified or consistent with this property. Example: properties/1234
|
|
749
957
|
*/
|
|
750
|
-
property:
|
|
958
|
+
property:
|
|
959
|
+
string;
|
|
751
960
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
752
|
-
quotaUser?:
|
|
961
|
+
quotaUser?:
|
|
962
|
+
string;
|
|
753
963
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
754
|
-
upload_protocol?:
|
|
964
|
+
upload_protocol?:
|
|
965
|
+
string;
|
|
755
966
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
756
|
-
uploadType?:
|
|
967
|
+
uploadType?:
|
|
968
|
+
string;
|
|
757
969
|
},
|
|
758
970
|
body: BatchRunPivotReportsRequest): Request<BatchRunPivotReportsResponse>;
|
|
759
971
|
/** Returns multiple reports in a batch. All reports must be for the same GA4 Property. */
|
|
760
972
|
batchRunReports(request: {
|
|
761
973
|
/** V1 error format. */
|
|
762
|
-
"$.xgafv"?:
|
|
974
|
+
"$.xgafv"?:
|
|
975
|
+
string;
|
|
763
976
|
/** OAuth access token. */
|
|
764
|
-
access_token?:
|
|
977
|
+
access_token?:
|
|
978
|
+
string;
|
|
765
979
|
/** Data format for response. */
|
|
766
|
-
alt?:
|
|
980
|
+
alt?:
|
|
981
|
+
string;
|
|
767
982
|
/** JSONP */
|
|
768
|
-
callback?:
|
|
983
|
+
callback?:
|
|
984
|
+
string;
|
|
769
985
|
/** Selector specifying which fields to include in a partial response. */
|
|
770
|
-
fields?:
|
|
986
|
+
fields?:
|
|
987
|
+
string;
|
|
771
988
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
772
|
-
key?:
|
|
989
|
+
key?:
|
|
990
|
+
string;
|
|
773
991
|
/** OAuth 2.0 token for the current user. */
|
|
774
|
-
oauth_token?:
|
|
992
|
+
oauth_token?:
|
|
993
|
+
string;
|
|
775
994
|
/** Returns response with indentations and line breaks. */
|
|
776
|
-
prettyPrint?:
|
|
995
|
+
prettyPrint?:
|
|
996
|
+
boolean;
|
|
777
997
|
/**
|
|
778
998
|
* 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
|
|
779
999
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may
|
|
780
1000
|
* either be unspecified or consistent with this property. Example: properties/1234
|
|
781
1001
|
*/
|
|
782
|
-
property:
|
|
1002
|
+
property:
|
|
1003
|
+
string;
|
|
783
1004
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
784
|
-
quotaUser?:
|
|
1005
|
+
quotaUser?:
|
|
1006
|
+
string;
|
|
785
1007
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
786
|
-
upload_protocol?:
|
|
1008
|
+
upload_protocol?:
|
|
1009
|
+
string;
|
|
787
1010
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
788
|
-
uploadType?:
|
|
1011
|
+
uploadType?:
|
|
1012
|
+
string;
|
|
789
1013
|
/** Request body */
|
|
790
|
-
resource:
|
|
1014
|
+
resource:
|
|
1015
|
+
BatchRunReportsRequest;
|
|
791
1016
|
}): Request<BatchRunReportsResponse>;
|
|
792
1017
|
batchRunReports(request: {
|
|
793
1018
|
/** V1 error format. */
|
|
794
|
-
"$.xgafv"?:
|
|
1019
|
+
"$.xgafv"?:
|
|
1020
|
+
string;
|
|
795
1021
|
/** OAuth access token. */
|
|
796
|
-
access_token?:
|
|
1022
|
+
access_token?:
|
|
1023
|
+
string;
|
|
797
1024
|
/** Data format for response. */
|
|
798
|
-
alt?:
|
|
1025
|
+
alt?:
|
|
1026
|
+
string;
|
|
799
1027
|
/** JSONP */
|
|
800
|
-
callback?:
|
|
1028
|
+
callback?:
|
|
1029
|
+
string;
|
|
801
1030
|
/** Selector specifying which fields to include in a partial response. */
|
|
802
|
-
fields?:
|
|
1031
|
+
fields?:
|
|
1032
|
+
string;
|
|
803
1033
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
804
|
-
key?:
|
|
1034
|
+
key?:
|
|
1035
|
+
string;
|
|
805
1036
|
/** OAuth 2.0 token for the current user. */
|
|
806
|
-
oauth_token?:
|
|
1037
|
+
oauth_token?:
|
|
1038
|
+
string;
|
|
807
1039
|
/** Returns response with indentations and line breaks. */
|
|
808
|
-
prettyPrint?:
|
|
1040
|
+
prettyPrint?:
|
|
1041
|
+
boolean;
|
|
809
1042
|
/**
|
|
810
1043
|
* 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
|
|
811
1044
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may
|
|
812
1045
|
* either be unspecified or consistent with this property. Example: properties/1234
|
|
813
1046
|
*/
|
|
814
|
-
property:
|
|
1047
|
+
property:
|
|
1048
|
+
string;
|
|
815
1049
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
816
|
-
quotaUser?:
|
|
1050
|
+
quotaUser?:
|
|
1051
|
+
string;
|
|
817
1052
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
818
|
-
upload_protocol?:
|
|
1053
|
+
upload_protocol?:
|
|
1054
|
+
string;
|
|
819
1055
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
820
|
-
uploadType?:
|
|
1056
|
+
uploadType?:
|
|
1057
|
+
string;
|
|
821
1058
|
},
|
|
822
1059
|
body: BatchRunReportsRequest): Request<BatchRunReportsResponse>;
|
|
823
1060
|
/**
|
|
@@ -827,65 +1064,90 @@ declare namespace gapi.client {
|
|
|
827
1064
|
*/
|
|
828
1065
|
checkCompatibility(request: {
|
|
829
1066
|
/** V1 error format. */
|
|
830
|
-
"$.xgafv"?:
|
|
1067
|
+
"$.xgafv"?:
|
|
1068
|
+
string;
|
|
831
1069
|
/** OAuth access token. */
|
|
832
|
-
access_token?:
|
|
1070
|
+
access_token?:
|
|
1071
|
+
string;
|
|
833
1072
|
/** Data format for response. */
|
|
834
|
-
alt?:
|
|
1073
|
+
alt?:
|
|
1074
|
+
string;
|
|
835
1075
|
/** JSONP */
|
|
836
|
-
callback?:
|
|
1076
|
+
callback?:
|
|
1077
|
+
string;
|
|
837
1078
|
/** Selector specifying which fields to include in a partial response. */
|
|
838
|
-
fields?:
|
|
1079
|
+
fields?:
|
|
1080
|
+
string;
|
|
839
1081
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
840
|
-
key?:
|
|
1082
|
+
key?:
|
|
1083
|
+
string;
|
|
841
1084
|
/** OAuth 2.0 token for the current user. */
|
|
842
|
-
oauth_token?:
|
|
1085
|
+
oauth_token?:
|
|
1086
|
+
string;
|
|
843
1087
|
/** Returns response with indentations and line breaks. */
|
|
844
|
-
prettyPrint?:
|
|
1088
|
+
prettyPrint?:
|
|
1089
|
+
boolean;
|
|
845
1090
|
/**
|
|
846
1091
|
* A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property
|
|
847
1092
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example:
|
|
848
1093
|
* properties/1234
|
|
849
1094
|
*/
|
|
850
|
-
property:
|
|
1095
|
+
property:
|
|
1096
|
+
string;
|
|
851
1097
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
852
|
-
quotaUser?:
|
|
1098
|
+
quotaUser?:
|
|
1099
|
+
string;
|
|
853
1100
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
854
|
-
upload_protocol?:
|
|
1101
|
+
upload_protocol?:
|
|
1102
|
+
string;
|
|
855
1103
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
856
|
-
uploadType?:
|
|
1104
|
+
uploadType?:
|
|
1105
|
+
string;
|
|
857
1106
|
/** Request body */
|
|
858
|
-
resource:
|
|
1107
|
+
resource:
|
|
1108
|
+
CheckCompatibilityRequest;
|
|
859
1109
|
}): Request<CheckCompatibilityResponse>;
|
|
860
1110
|
checkCompatibility(request: {
|
|
861
1111
|
/** V1 error format. */
|
|
862
|
-
"$.xgafv"?:
|
|
1112
|
+
"$.xgafv"?:
|
|
1113
|
+
string;
|
|
863
1114
|
/** OAuth access token. */
|
|
864
|
-
access_token?:
|
|
1115
|
+
access_token?:
|
|
1116
|
+
string;
|
|
865
1117
|
/** Data format for response. */
|
|
866
|
-
alt?:
|
|
1118
|
+
alt?:
|
|
1119
|
+
string;
|
|
867
1120
|
/** JSONP */
|
|
868
|
-
callback?:
|
|
1121
|
+
callback?:
|
|
1122
|
+
string;
|
|
869
1123
|
/** Selector specifying which fields to include in a partial response. */
|
|
870
|
-
fields?:
|
|
1124
|
+
fields?:
|
|
1125
|
+
string;
|
|
871
1126
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
872
|
-
key?:
|
|
1127
|
+
key?:
|
|
1128
|
+
string;
|
|
873
1129
|
/** OAuth 2.0 token for the current user. */
|
|
874
|
-
oauth_token?:
|
|
1130
|
+
oauth_token?:
|
|
1131
|
+
string;
|
|
875
1132
|
/** Returns response with indentations and line breaks. */
|
|
876
|
-
prettyPrint?:
|
|
1133
|
+
prettyPrint?:
|
|
1134
|
+
boolean;
|
|
877
1135
|
/**
|
|
878
1136
|
* A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property
|
|
879
1137
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example:
|
|
880
1138
|
* properties/1234
|
|
881
1139
|
*/
|
|
882
|
-
property:
|
|
1140
|
+
property:
|
|
1141
|
+
string;
|
|
883
1142
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
884
|
-
quotaUser?:
|
|
1143
|
+
quotaUser?:
|
|
1144
|
+
string;
|
|
885
1145
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
886
|
-
upload_protocol?:
|
|
1146
|
+
upload_protocol?:
|
|
1147
|
+
string;
|
|
887
1148
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
888
|
-
uploadType?:
|
|
1149
|
+
uploadType?:
|
|
1150
|
+
string;
|
|
889
1151
|
},
|
|
890
1152
|
body: CheckCompatibilityRequest): Request<CheckCompatibilityResponse>;
|
|
891
1153
|
/**
|
|
@@ -896,34 +1158,46 @@ declare namespace gapi.client {
|
|
|
896
1158
|
*/
|
|
897
1159
|
getMetadata(request?: {
|
|
898
1160
|
/** V1 error format. */
|
|
899
|
-
"$.xgafv"?:
|
|
1161
|
+
"$.xgafv"?:
|
|
1162
|
+
string;
|
|
900
1163
|
/** OAuth access token. */
|
|
901
|
-
access_token?:
|
|
1164
|
+
access_token?:
|
|
1165
|
+
string;
|
|
902
1166
|
/** Data format for response. */
|
|
903
|
-
alt?:
|
|
1167
|
+
alt?:
|
|
1168
|
+
string;
|
|
904
1169
|
/** JSONP */
|
|
905
|
-
callback?:
|
|
1170
|
+
callback?:
|
|
1171
|
+
string;
|
|
906
1172
|
/** Selector specifying which fields to include in a partial response. */
|
|
907
|
-
fields?:
|
|
1173
|
+
fields?:
|
|
1174
|
+
string;
|
|
908
1175
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
909
|
-
key?:
|
|
1176
|
+
key?:
|
|
1177
|
+
string;
|
|
910
1178
|
/**
|
|
911
1179
|
* 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
|
|
912
1180
|
* identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example:
|
|
913
1181
|
* properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and
|
|
914
1182
|
* metrics.
|
|
915
1183
|
*/
|
|
916
|
-
name:
|
|
1184
|
+
name:
|
|
1185
|
+
string;
|
|
917
1186
|
/** OAuth 2.0 token for the current user. */
|
|
918
|
-
oauth_token?:
|
|
1187
|
+
oauth_token?:
|
|
1188
|
+
string;
|
|
919
1189
|
/** Returns response with indentations and line breaks. */
|
|
920
|
-
prettyPrint?:
|
|
1190
|
+
prettyPrint?:
|
|
1191
|
+
boolean;
|
|
921
1192
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
922
|
-
quotaUser?:
|
|
1193
|
+
quotaUser?:
|
|
1194
|
+
string;
|
|
923
1195
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
924
|
-
upload_protocol?:
|
|
1196
|
+
upload_protocol?:
|
|
1197
|
+
string;
|
|
925
1198
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
926
|
-
uploadType?:
|
|
1199
|
+
uploadType?:
|
|
1200
|
+
string;
|
|
927
1201
|
}): Request<Metadata>;
|
|
928
1202
|
/**
|
|
929
1203
|
* 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
|
|
@@ -931,65 +1205,90 @@ declare namespace gapi.client {
|
|
|
931
1205
|
*/
|
|
932
1206
|
runPivotReport(request: {
|
|
933
1207
|
/** V1 error format. */
|
|
934
|
-
"$.xgafv"?:
|
|
1208
|
+
"$.xgafv"?:
|
|
1209
|
+
string;
|
|
935
1210
|
/** OAuth access token. */
|
|
936
|
-
access_token?:
|
|
1211
|
+
access_token?:
|
|
1212
|
+
string;
|
|
937
1213
|
/** Data format for response. */
|
|
938
|
-
alt?:
|
|
1214
|
+
alt?:
|
|
1215
|
+
string;
|
|
939
1216
|
/** JSONP */
|
|
940
|
-
callback?:
|
|
1217
|
+
callback?:
|
|
1218
|
+
string;
|
|
941
1219
|
/** Selector specifying which fields to include in a partial response. */
|
|
942
|
-
fields?:
|
|
1220
|
+
fields?:
|
|
1221
|
+
string;
|
|
943
1222
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
944
|
-
key?:
|
|
1223
|
+
key?:
|
|
1224
|
+
string;
|
|
945
1225
|
/** OAuth 2.0 token for the current user. */
|
|
946
|
-
oauth_token?:
|
|
1226
|
+
oauth_token?:
|
|
1227
|
+
string;
|
|
947
1228
|
/** Returns response with indentations and line breaks. */
|
|
948
|
-
prettyPrint?:
|
|
1229
|
+
prettyPrint?:
|
|
1230
|
+
boolean;
|
|
949
1231
|
/**
|
|
950
1232
|
* 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
|
|
951
1233
|
* 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
|
|
952
1234
|
* batch-level property. Example: properties/1234
|
|
953
1235
|
*/
|
|
954
|
-
property:
|
|
1236
|
+
property:
|
|
1237
|
+
string;
|
|
955
1238
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
956
|
-
quotaUser?:
|
|
1239
|
+
quotaUser?:
|
|
1240
|
+
string;
|
|
957
1241
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
958
|
-
upload_protocol?:
|
|
1242
|
+
upload_protocol?:
|
|
1243
|
+
string;
|
|
959
1244
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
960
|
-
uploadType?:
|
|
1245
|
+
uploadType?:
|
|
1246
|
+
string;
|
|
961
1247
|
/** Request body */
|
|
962
|
-
resource:
|
|
1248
|
+
resource:
|
|
1249
|
+
RunPivotReportRequest;
|
|
963
1250
|
}): Request<RunPivotReportResponse>;
|
|
964
1251
|
runPivotReport(request: {
|
|
965
1252
|
/** V1 error format. */
|
|
966
|
-
"$.xgafv"?:
|
|
1253
|
+
"$.xgafv"?:
|
|
1254
|
+
string;
|
|
967
1255
|
/** OAuth access token. */
|
|
968
|
-
access_token?:
|
|
1256
|
+
access_token?:
|
|
1257
|
+
string;
|
|
969
1258
|
/** Data format for response. */
|
|
970
|
-
alt?:
|
|
1259
|
+
alt?:
|
|
1260
|
+
string;
|
|
971
1261
|
/** JSONP */
|
|
972
|
-
callback?:
|
|
1262
|
+
callback?:
|
|
1263
|
+
string;
|
|
973
1264
|
/** Selector specifying which fields to include in a partial response. */
|
|
974
|
-
fields?:
|
|
1265
|
+
fields?:
|
|
1266
|
+
string;
|
|
975
1267
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
976
|
-
key?:
|
|
1268
|
+
key?:
|
|
1269
|
+
string;
|
|
977
1270
|
/** OAuth 2.0 token for the current user. */
|
|
978
|
-
oauth_token?:
|
|
1271
|
+
oauth_token?:
|
|
1272
|
+
string;
|
|
979
1273
|
/** Returns response with indentations and line breaks. */
|
|
980
|
-
prettyPrint?:
|
|
1274
|
+
prettyPrint?:
|
|
1275
|
+
boolean;
|
|
981
1276
|
/**
|
|
982
1277
|
* 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
|
|
983
1278
|
* 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
|
|
984
1279
|
* batch-level property. Example: properties/1234
|
|
985
1280
|
*/
|
|
986
|
-
property:
|
|
1281
|
+
property:
|
|
1282
|
+
string;
|
|
987
1283
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
988
|
-
quotaUser?:
|
|
1284
|
+
quotaUser?:
|
|
1285
|
+
string;
|
|
989
1286
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
990
|
-
upload_protocol?:
|
|
1287
|
+
upload_protocol?:
|
|
1288
|
+
string;
|
|
991
1289
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
992
|
-
uploadType?:
|
|
1290
|
+
uploadType?:
|
|
1291
|
+
string;
|
|
993
1292
|
},
|
|
994
1293
|
body: RunPivotReportRequest): Request<RunPivotReportResponse>;
|
|
995
1294
|
/**
|
|
@@ -999,63 +1298,88 @@ declare namespace gapi.client {
|
|
|
999
1298
|
*/
|
|
1000
1299
|
runRealtimeReport(request: {
|
|
1001
1300
|
/** V1 error format. */
|
|
1002
|
-
"$.xgafv"?:
|
|
1301
|
+
"$.xgafv"?:
|
|
1302
|
+
string;
|
|
1003
1303
|
/** OAuth access token. */
|
|
1004
|
-
access_token?:
|
|
1304
|
+
access_token?:
|
|
1305
|
+
string;
|
|
1005
1306
|
/** Data format for response. */
|
|
1006
|
-
alt?:
|
|
1307
|
+
alt?:
|
|
1308
|
+
string;
|
|
1007
1309
|
/** JSONP */
|
|
1008
|
-
callback?:
|
|
1310
|
+
callback?:
|
|
1311
|
+
string;
|
|
1009
1312
|
/** Selector specifying which fields to include in a partial response. */
|
|
1010
|
-
fields?:
|
|
1313
|
+
fields?:
|
|
1314
|
+
string;
|
|
1011
1315
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1012
|
-
key?:
|
|
1316
|
+
key?:
|
|
1317
|
+
string;
|
|
1013
1318
|
/** OAuth 2.0 token for the current user. */
|
|
1014
|
-
oauth_token?:
|
|
1319
|
+
oauth_token?:
|
|
1320
|
+
string;
|
|
1015
1321
|
/** Returns response with indentations and line breaks. */
|
|
1016
|
-
prettyPrint?:
|
|
1322
|
+
prettyPrint?:
|
|
1323
|
+
boolean;
|
|
1017
1324
|
/**
|
|
1018
1325
|
* 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
|
|
1019
1326
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234
|
|
1020
1327
|
*/
|
|
1021
|
-
property:
|
|
1328
|
+
property:
|
|
1329
|
+
string;
|
|
1022
1330
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1023
|
-
quotaUser?:
|
|
1331
|
+
quotaUser?:
|
|
1332
|
+
string;
|
|
1024
1333
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1025
|
-
upload_protocol?:
|
|
1334
|
+
upload_protocol?:
|
|
1335
|
+
string;
|
|
1026
1336
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1027
|
-
uploadType?:
|
|
1337
|
+
uploadType?:
|
|
1338
|
+
string;
|
|
1028
1339
|
/** Request body */
|
|
1029
|
-
resource:
|
|
1340
|
+
resource:
|
|
1341
|
+
RunRealtimeReportRequest;
|
|
1030
1342
|
}): Request<RunRealtimeReportResponse>;
|
|
1031
1343
|
runRealtimeReport(request: {
|
|
1032
1344
|
/** V1 error format. */
|
|
1033
|
-
"$.xgafv"?:
|
|
1345
|
+
"$.xgafv"?:
|
|
1346
|
+
string;
|
|
1034
1347
|
/** OAuth access token. */
|
|
1035
|
-
access_token?:
|
|
1348
|
+
access_token?:
|
|
1349
|
+
string;
|
|
1036
1350
|
/** Data format for response. */
|
|
1037
|
-
alt?:
|
|
1351
|
+
alt?:
|
|
1352
|
+
string;
|
|
1038
1353
|
/** JSONP */
|
|
1039
|
-
callback?:
|
|
1354
|
+
callback?:
|
|
1355
|
+
string;
|
|
1040
1356
|
/** Selector specifying which fields to include in a partial response. */
|
|
1041
|
-
fields?:
|
|
1357
|
+
fields?:
|
|
1358
|
+
string;
|
|
1042
1359
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1043
|
-
key?:
|
|
1360
|
+
key?:
|
|
1361
|
+
string;
|
|
1044
1362
|
/** OAuth 2.0 token for the current user. */
|
|
1045
|
-
oauth_token?:
|
|
1363
|
+
oauth_token?:
|
|
1364
|
+
string;
|
|
1046
1365
|
/** Returns response with indentations and line breaks. */
|
|
1047
|
-
prettyPrint?:
|
|
1366
|
+
prettyPrint?:
|
|
1367
|
+
boolean;
|
|
1048
1368
|
/**
|
|
1049
1369
|
* 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
|
|
1050
1370
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234
|
|
1051
1371
|
*/
|
|
1052
|
-
property:
|
|
1372
|
+
property:
|
|
1373
|
+
string;
|
|
1053
1374
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1054
|
-
quotaUser?:
|
|
1375
|
+
quotaUser?:
|
|
1376
|
+
string;
|
|
1055
1377
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1056
|
-
upload_protocol?:
|
|
1378
|
+
upload_protocol?:
|
|
1379
|
+
string;
|
|
1057
1380
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1058
|
-
uploadType?:
|
|
1381
|
+
uploadType?:
|
|
1382
|
+
string;
|
|
1059
1383
|
},
|
|
1060
1384
|
body: RunRealtimeReportRequest): Request<RunRealtimeReportResponse>;
|
|
1061
1385
|
/**
|
|
@@ -1066,65 +1390,90 @@ declare namespace gapi.client {
|
|
|
1066
1390
|
*/
|
|
1067
1391
|
runReport(request: {
|
|
1068
1392
|
/** V1 error format. */
|
|
1069
|
-
"$.xgafv"?:
|
|
1393
|
+
"$.xgafv"?:
|
|
1394
|
+
string;
|
|
1070
1395
|
/** OAuth access token. */
|
|
1071
|
-
access_token?:
|
|
1396
|
+
access_token?:
|
|
1397
|
+
string;
|
|
1072
1398
|
/** Data format for response. */
|
|
1073
|
-
alt?:
|
|
1399
|
+
alt?:
|
|
1400
|
+
string;
|
|
1074
1401
|
/** JSONP */
|
|
1075
|
-
callback?:
|
|
1402
|
+
callback?:
|
|
1403
|
+
string;
|
|
1076
1404
|
/** Selector specifying which fields to include in a partial response. */
|
|
1077
|
-
fields?:
|
|
1405
|
+
fields?:
|
|
1406
|
+
string;
|
|
1078
1407
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1079
|
-
key?:
|
|
1408
|
+
key?:
|
|
1409
|
+
string;
|
|
1080
1410
|
/** OAuth 2.0 token for the current user. */
|
|
1081
|
-
oauth_token?:
|
|
1411
|
+
oauth_token?:
|
|
1412
|
+
string;
|
|
1082
1413
|
/** Returns response with indentations and line breaks. */
|
|
1083
|
-
prettyPrint?:
|
|
1414
|
+
prettyPrint?:
|
|
1415
|
+
boolean;
|
|
1084
1416
|
/**
|
|
1085
1417
|
* 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
|
|
1086
1418
|
* 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
|
|
1087
1419
|
* batch-level property. Example: properties/1234
|
|
1088
1420
|
*/
|
|
1089
|
-
property:
|
|
1421
|
+
property:
|
|
1422
|
+
string;
|
|
1090
1423
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1091
|
-
quotaUser?:
|
|
1424
|
+
quotaUser?:
|
|
1425
|
+
string;
|
|
1092
1426
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1093
|
-
upload_protocol?:
|
|
1427
|
+
upload_protocol?:
|
|
1428
|
+
string;
|
|
1094
1429
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1095
|
-
uploadType?:
|
|
1430
|
+
uploadType?:
|
|
1431
|
+
string;
|
|
1096
1432
|
/** Request body */
|
|
1097
|
-
resource:
|
|
1433
|
+
resource:
|
|
1434
|
+
RunReportRequest;
|
|
1098
1435
|
}): Request<RunReportResponse>;
|
|
1099
1436
|
runReport(request: {
|
|
1100
1437
|
/** V1 error format. */
|
|
1101
|
-
"$.xgafv"?:
|
|
1438
|
+
"$.xgafv"?:
|
|
1439
|
+
string;
|
|
1102
1440
|
/** OAuth access token. */
|
|
1103
|
-
access_token?:
|
|
1441
|
+
access_token?:
|
|
1442
|
+
string;
|
|
1104
1443
|
/** Data format for response. */
|
|
1105
|
-
alt?:
|
|
1444
|
+
alt?:
|
|
1445
|
+
string;
|
|
1106
1446
|
/** JSONP */
|
|
1107
|
-
callback?:
|
|
1447
|
+
callback?:
|
|
1448
|
+
string;
|
|
1108
1449
|
/** Selector specifying which fields to include in a partial response. */
|
|
1109
|
-
fields?:
|
|
1450
|
+
fields?:
|
|
1451
|
+
string;
|
|
1110
1452
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1111
|
-
key?:
|
|
1453
|
+
key?:
|
|
1454
|
+
string;
|
|
1112
1455
|
/** OAuth 2.0 token for the current user. */
|
|
1113
|
-
oauth_token?:
|
|
1456
|
+
oauth_token?:
|
|
1457
|
+
string;
|
|
1114
1458
|
/** Returns response with indentations and line breaks. */
|
|
1115
|
-
prettyPrint?:
|
|
1459
|
+
prettyPrint?:
|
|
1460
|
+
boolean;
|
|
1116
1461
|
/**
|
|
1117
1462
|
* 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
|
|
1118
1463
|
* 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
|
|
1119
1464
|
* batch-level property. Example: properties/1234
|
|
1120
1465
|
*/
|
|
1121
|
-
property:
|
|
1466
|
+
property:
|
|
1467
|
+
string;
|
|
1122
1468
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1123
|
-
quotaUser?:
|
|
1469
|
+
quotaUser?:
|
|
1470
|
+
string;
|
|
1124
1471
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1125
|
-
upload_protocol?:
|
|
1472
|
+
upload_protocol?:
|
|
1473
|
+
string;
|
|
1126
1474
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1127
|
-
uploadType?:
|
|
1475
|
+
uploadType?:
|
|
1476
|
+
string;
|
|
1128
1477
|
},
|
|
1129
1478
|
body: RunReportRequest): Request<RunReportResponse>;
|
|
1130
1479
|
}
|