@maxim_mazurok/gapi.client.analyticsdata-v1beta 0.0.20231128 → 0.0.20231203

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