@maxim_mazurok/gapi.client.analyticsdata-v1beta 0.0.20240821 → 0.0.20240825

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +27 -27
  2. package/package.json +1 -1
  3. package/readme.md +3 -3
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20240821
12
+ // Revision: 20240825
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -452,7 +452,7 @@ declare namespace gapi.client {
452
452
  dimensionFilter?: FilterExpression;
453
453
  /** The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. */
454
454
  dimensions?: Dimension[];
455
- /** 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. */
455
+ /** 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 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. */
456
456
  keepEmptyRows?: boolean;
457
457
  /** 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. */
458
458
  metricFilter?: FilterExpression;
@@ -460,9 +460,9 @@ declare namespace gapi.client {
460
460
  metrics?: Metric[];
461
461
  /** 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. */
462
462
  pivots?: Pivot[];
463
- /** 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 */
463
+ /** A Google Analytics 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 */
464
464
  property?: string;
465
- /** Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
465
+ /** Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
466
466
  returnPropertyQuota?: boolean;
467
467
  }
468
468
  interface RunPivotReportResponse {
@@ -478,7 +478,7 @@ declare namespace gapi.client {
478
478
  metricHeaders?: MetricHeader[];
479
479
  /** 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" }] }] }] */
480
480
  pivotHeaders?: PivotHeader[];
481
- /** This Analytics Property's quota state including this request. */
481
+ /** This Google Analytics property's quota state including this request. */
482
482
  propertyQuota?: PropertyQuota;
483
483
  /** Rows of dimension value combinations and metric values in the report. */
484
484
  rows?: Row[];
@@ -500,7 +500,7 @@ declare namespace gapi.client {
500
500
  minuteRanges?: MinuteRange[];
501
501
  /** Specifies how rows are ordered in the response. */
502
502
  orderBys?: OrderBy[];
503
- /** Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
503
+ /** Toggles whether to return the current state of this Google Analytics property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
504
504
  returnPropertyQuota?: boolean;
505
505
  }
506
506
  interface RunRealtimeReportResponse {
@@ -514,7 +514,7 @@ declare namespace gapi.client {
514
514
  metricHeaders?: MetricHeader[];
515
515
  /** If requested, the minimum values of metrics. */
516
516
  minimums?: Row[];
517
- /** This Analytics Property's Realtime quota state including this request. */
517
+ /** This Google Analytics property's Realtime quota state including this request. */
518
518
  propertyQuota?: PropertyQuota;
519
519
  /** 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. */
520
520
  rowCount?: number;
@@ -536,7 +536,7 @@ declare namespace gapi.client {
536
536
  dimensionFilter?: FilterExpression;
537
537
  /** The dimensions requested and displayed. */
538
538
  dimensions?: Dimension[];
539
- /** 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. */
539
+ /** 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 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. */
540
540
  keepEmptyRows?: boolean;
541
541
  /** 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). */
542
542
  limit?: string;
@@ -550,9 +550,9 @@ declare namespace gapi.client {
550
550
  offset?: string;
551
551
  /** Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons. */
552
552
  orderBys?: OrderBy[];
553
- /** 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 */
553
+ /** A Google Analytics 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 */
554
554
  property?: string;
555
- /** Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
555
+ /** Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
556
556
  returnPropertyQuota?: boolean;
557
557
  }
558
558
  interface RunReportResponse {
@@ -568,7 +568,7 @@ declare namespace gapi.client {
568
568
  metricHeaders?: MetricHeader[];
569
569
  /** If requested, the minimum values of metrics. */
570
570
  minimums?: Row[];
571
- /** This Analytics Property's quota state including this request. */
571
+ /** This Google Analytics property's quota state including this request. */
572
572
  propertyQuota?: PropertyQuota;
573
573
  /** 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). */
574
574
  rowCount?: number;
@@ -792,7 +792,7 @@ declare namespace gapi.client {
792
792
  ): Request<QueryAudienceExportResponse>;
793
793
  }
794
794
  interface PropertiesResource {
795
- /** Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property. */
795
+ /** Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property. */
796
796
  batchRunPivotReports(request: {
797
797
  /** V1 error format. */
798
798
  '$.xgafv'?: string;
@@ -810,7 +810,7 @@ declare namespace gapi.client {
810
810
  oauth_token?: string;
811
811
  /** Returns response with indentations and line breaks. */
812
812
  prettyPrint?: boolean;
813
- /** 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 */
813
+ /** A Google Analytics 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 */
814
814
  property: string;
815
815
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
816
816
  quotaUser?: string;
@@ -839,7 +839,7 @@ declare namespace gapi.client {
839
839
  oauth_token?: string;
840
840
  /** Returns response with indentations and line breaks. */
841
841
  prettyPrint?: boolean;
842
- /** 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 */
842
+ /** A Google Analytics 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 */
843
843
  property: string;
844
844
  /** 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. */
845
845
  quotaUser?: string;
@@ -850,7 +850,7 @@ declare namespace gapi.client {
850
850
  },
851
851
  body: BatchRunPivotReportsRequest
852
852
  ): Request<BatchRunPivotReportsResponse>;
853
- /** Returns multiple reports in a batch. All reports must be for the same GA4 Property. */
853
+ /** Returns multiple reports in a batch. All reports must be for the same Google Analytics property. */
854
854
  batchRunReports(request: {
855
855
  /** V1 error format. */
856
856
  '$.xgafv'?: string;
@@ -868,7 +868,7 @@ declare namespace gapi.client {
868
868
  oauth_token?: string;
869
869
  /** Returns response with indentations and line breaks. */
870
870
  prettyPrint?: boolean;
871
- /** 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 */
871
+ /** A Google Analytics 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 */
872
872
  property: string;
873
873
  /** 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. */
874
874
  quotaUser?: string;
@@ -897,7 +897,7 @@ declare namespace gapi.client {
897
897
  oauth_token?: string;
898
898
  /** Returns response with indentations and line breaks. */
899
899
  prettyPrint?: boolean;
900
- /** 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 */
900
+ /** A Google Analytics 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 */
901
901
  property: string;
902
902
  /** 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. */
903
903
  quotaUser?: string;
@@ -926,7 +926,7 @@ declare namespace gapi.client {
926
926
  oauth_token?: string;
927
927
  /** Returns response with indentations and line breaks. */
928
928
  prettyPrint?: boolean;
929
- /** 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 */
929
+ /** A Google Analytics 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 */
930
930
  property: string;
931
931
  /** 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. */
932
932
  quotaUser?: string;
@@ -955,7 +955,7 @@ declare namespace gapi.client {
955
955
  oauth_token?: string;
956
956
  /** Returns response with indentations and line breaks. */
957
957
  prettyPrint?: boolean;
958
- /** 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 */
958
+ /** A Google Analytics 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 */
959
959
  property: string;
960
960
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
961
961
  quotaUser?: string;
@@ -966,7 +966,7 @@ declare namespace gapi.client {
966
966
  },
967
967
  body: CheckCompatibilityRequest
968
968
  ): Request<CheckCompatibilityResponse>;
969
- /** 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`. */
969
+ /** Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`. */
970
970
  getMetadata(request?: {
971
971
  /** V1 error format. */
972
972
  '$.xgafv'?: string;
@@ -980,7 +980,7 @@ declare namespace gapi.client {
980
980
  fields?: string;
981
981
  /** 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. */
982
982
  key?: string;
983
- /** 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. */
983
+ /** 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 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. */
984
984
  name: string;
985
985
  /** OAuth 2.0 token for the current user. */
986
986
  oauth_token?: string;
@@ -1011,7 +1011,7 @@ declare namespace gapi.client {
1011
1011
  oauth_token?: string;
1012
1012
  /** Returns response with indentations and line breaks. */
1013
1013
  prettyPrint?: boolean;
1014
- /** 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 */
1014
+ /** A Google Analytics 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 */
1015
1015
  property: string;
1016
1016
  /** 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. */
1017
1017
  quotaUser?: string;
@@ -1040,7 +1040,7 @@ declare namespace gapi.client {
1040
1040
  oauth_token?: string;
1041
1041
  /** Returns response with indentations and line breaks. */
1042
1042
  prettyPrint?: boolean;
1043
- /** A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property 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 */
1043
+ /** A Google Analytics 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 */
1044
1044
  property: string;
1045
1045
  /** 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. */
1046
1046
  quotaUser?: string;
@@ -1069,7 +1069,7 @@ declare namespace gapi.client {
1069
1069
  oauth_token?: string;
1070
1070
  /** Returns response with indentations and line breaks. */
1071
1071
  prettyPrint?: boolean;
1072
- /** 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 */
1072
+ /** A Google Analytics 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 */
1073
1073
  property: string;
1074
1074
  /** 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. */
1075
1075
  quotaUser?: string;
@@ -1098,7 +1098,7 @@ declare namespace gapi.client {
1098
1098
  oauth_token?: string;
1099
1099
  /** Returns response with indentations and line breaks. */
1100
1100
  prettyPrint?: boolean;
1101
- /** 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 */
1101
+ /** A Google Analytics 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 */
1102
1102
  property: string;
1103
1103
  /** 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. */
1104
1104
  quotaUser?: string;
@@ -1127,7 +1127,7 @@ declare namespace gapi.client {
1127
1127
  oauth_token?: string;
1128
1128
  /** Returns response with indentations and line breaks. */
1129
1129
  prettyPrint?: boolean;
1130
- /** 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 */
1130
+ /** A Google Analytics 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 */
1131
1131
  property: string;
1132
1132
  /** 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. */
1133
1133
  quotaUser?: string;
@@ -1156,7 +1156,7 @@ declare namespace gapi.client {
1156
1156
  oauth_token?: string;
1157
1157
  /** Returns response with indentations and line breaks. */
1158
1158
  prettyPrint?: boolean;
1159
- /** 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 */
1159
+ /** A Google Analytics 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 */
1160
1160
  property: string;
1161
1161
  /** 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. */
1162
1162
  quotaUser?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsdata-v1beta",
3
- "version": "0.0.20240821",
3
+ "version": "0.0.20240825",
4
4
  "description": "TypeScript typings for Google Analytics Data API v1beta",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -73,14 +73,14 @@ After that you can use Google Analytics Data API resources: <!-- TODO: make this
73
73
 
74
74
  ```typescript
75
75
  /*
76
- Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.
76
+ Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.
77
77
  */
78
78
  await gapi.client.analyticsdata.properties.batchRunPivotReports({
79
79
  property: 'property',
80
80
  });
81
81
 
82
82
  /*
83
- Returns multiple reports in a batch. All reports must be for the same GA4 Property.
83
+ Returns multiple reports in a batch. All reports must be for the same Google Analytics property.
84
84
  */
85
85
  await gapi.client.analyticsdata.properties.batchRunReports({
86
86
  property: 'property',
@@ -94,7 +94,7 @@ await gapi.client.analyticsdata.properties.checkCompatibility({
94
94
  });
95
95
 
96
96
  /*
97
- 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`.
97
+ Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.
98
98
  */
99
99
  await gapi.client.analyticsdata.properties.getMetadata({name: 'name'});
100
100