@maxim_mazurok/gapi.client.analyticsadmin-v1beta 0.0.20230307 → 0.0.20230308

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 (4) hide show
  1. package/index.d.ts +354 -1
  2. package/package.json +1 -1
  3. package/readme.md +10 -0
  4. package/tests.ts +247 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://analyticsadmin.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20230307
12
+ // Revision: 20230308
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -22,6 +22,148 @@ declare namespace gapi.client {
22
22
  function load(name: "analyticsadmin", version: "v1beta", callback: () => any): void;
23
23
 
24
24
  namespace analyticsadmin {
25
+ interface GoogleAnalyticsAdminV1betaAccessBetweenFilter {
26
+ /** Begins with this number. */
27
+ fromValue?: GoogleAnalyticsAdminV1betaNumericValue;
28
+ /** Ends with this number. */
29
+ toValue?: GoogleAnalyticsAdminV1betaNumericValue;
30
+ }
31
+ interface GoogleAnalyticsAdminV1betaAccessDateRange {
32
+ /**
33
+ * The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the
34
+ * date is inferred based on the current time in the request's time zone.
35
+ */
36
+ endDate?: string;
37
+ /**
38
+ * The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the
39
+ * date is inferred based on the current time in the request's time zone.
40
+ */
41
+ startDate?: string;
42
+ }
43
+ interface GoogleAnalyticsAdminV1betaAccessDimension {
44
+ /**
45
+ * The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in
46
+ * this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
47
+ */
48
+ dimensionName?: string;
49
+ }
50
+ interface GoogleAnalyticsAdminV1betaAccessDimensionHeader {
51
+ /** The dimension's name; for example 'userEmail'. */
52
+ dimensionName?: string;
53
+ }
54
+ interface GoogleAnalyticsAdminV1betaAccessDimensionValue {
55
+ /** The dimension value. For example, this value may be 'France' for the 'country' dimension. */
56
+ value?: string;
57
+ }
58
+ interface GoogleAnalyticsAdminV1betaAccessFilter {
59
+ /** A filter for two values. */
60
+ betweenFilter?: GoogleAnalyticsAdminV1betaAccessBetweenFilter;
61
+ /** The dimension name or metric name. */
62
+ fieldName?: string;
63
+ /** A filter for in list values. */
64
+ inListFilter?: GoogleAnalyticsAdminV1betaAccessInListFilter;
65
+ /** A filter for numeric or date values. */
66
+ numericFilter?: GoogleAnalyticsAdminV1betaAccessNumericFilter;
67
+ /** Strings related filter. */
68
+ stringFilter?: GoogleAnalyticsAdminV1betaAccessStringFilter;
69
+ }
70
+ interface GoogleAnalyticsAdminV1betaAccessFilterExpression {
71
+ /** A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. */
72
+ accessFilter?: GoogleAnalyticsAdminV1betaAccessFilter;
73
+ /** Each of the FilterExpressions in the and_group has an AND relationship. */
74
+ andGroup?: GoogleAnalyticsAdminV1betaAccessFilterExpressionList;
75
+ /** The FilterExpression is NOT of not_expression. */
76
+ notExpression?: GoogleAnalyticsAdminV1betaAccessFilterExpression;
77
+ /** Each of the FilterExpressions in the or_group has an OR relationship. */
78
+ orGroup?: GoogleAnalyticsAdminV1betaAccessFilterExpressionList;
79
+ }
80
+ interface GoogleAnalyticsAdminV1betaAccessFilterExpressionList {
81
+ /** A list of filter expressions. */
82
+ expressions?: GoogleAnalyticsAdminV1betaAccessFilterExpression[];
83
+ }
84
+ interface GoogleAnalyticsAdminV1betaAccessInListFilter {
85
+ /** If true, the string value is case sensitive. */
86
+ caseSensitive?: boolean;
87
+ /** The list of string values. Must be non-empty. */
88
+ values?: string[];
89
+ }
90
+ interface GoogleAnalyticsAdminV1betaAccessMetric {
91
+ /**
92
+ * The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this
93
+ * API. Metrics are referenced by name in `metricFilter` & `orderBys`.
94
+ */
95
+ metricName?: string;
96
+ }
97
+ interface GoogleAnalyticsAdminV1betaAccessMetricHeader {
98
+ /** The metric's name; for example 'accessCount'. */
99
+ metricName?: string;
100
+ }
101
+ interface GoogleAnalyticsAdminV1betaAccessMetricValue {
102
+ /** The measurement value. For example, this value may be '13'. */
103
+ value?: string;
104
+ }
105
+ interface GoogleAnalyticsAdminV1betaAccessNumericFilter {
106
+ /** The operation type for this filter. */
107
+ operation?: string;
108
+ /** A numeric value or a date value. */
109
+ value?: GoogleAnalyticsAdminV1betaNumericValue;
110
+ }
111
+ interface GoogleAnalyticsAdminV1betaAccessOrderBy {
112
+ /** If true, sorts by descending order. If false or unspecified, sorts in ascending order. */
113
+ desc?: boolean;
114
+ /** Sorts results by a dimension's values. */
115
+ dimension?: GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy;
116
+ /** Sorts results by a metric's values. */
117
+ metric?: GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy;
118
+ }
119
+ interface GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy {
120
+ /** A dimension name in the request to order by. */
121
+ dimensionName?: string;
122
+ /** Controls the rule for dimension value ordering. */
123
+ orderType?: string;
124
+ }
125
+ interface GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy {
126
+ /** A metric name in the request to order by. */
127
+ metricName?: string;
128
+ }
129
+ interface GoogleAnalyticsAdminV1betaAccessQuota {
130
+ /** Properties can use up to 50 concurrent requests. */
131
+ concurrentRequests?: GoogleAnalyticsAdminV1betaAccessQuotaStatus;
132
+ /** Properties and cloud project pairs can have up to 50 server errors per hour. */
133
+ serverErrorsPerProjectPerHour?: GoogleAnalyticsAdminV1betaAccessQuotaStatus;
134
+ /** Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. */
135
+ tokensPerDay?: GoogleAnalyticsAdminV1betaAccessQuotaStatus;
136
+ /**
137
+ * Properties can use 50,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
138
+ * quotas.
139
+ */
140
+ tokensPerHour?: GoogleAnalyticsAdminV1betaAccessQuotaStatus;
141
+ /**
142
+ * Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a
143
+ * single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.
144
+ */
145
+ tokensPerProjectPerHour?: GoogleAnalyticsAdminV1betaAccessQuotaStatus;
146
+ }
147
+ interface GoogleAnalyticsAdminV1betaAccessQuotaStatus {
148
+ /** Quota consumed by this request. */
149
+ consumed?: number;
150
+ /** Quota remaining after this request. */
151
+ remaining?: number;
152
+ }
153
+ interface GoogleAnalyticsAdminV1betaAccessRow {
154
+ /** List of dimension values. These values are in the same order as specified in the request. */
155
+ dimensionValues?: GoogleAnalyticsAdminV1betaAccessDimensionValue[];
156
+ /** List of metric values. These values are in the same order as specified in the request. */
157
+ metricValues?: GoogleAnalyticsAdminV1betaAccessMetricValue[];
158
+ }
159
+ interface GoogleAnalyticsAdminV1betaAccessStringFilter {
160
+ /** If true, the string value is case sensitive. */
161
+ caseSensitive?: boolean;
162
+ /** The match type for this filter. */
163
+ matchType?: string;
164
+ /** The string value used for the matching. */
165
+ value?: string;
166
+ }
25
167
  interface GoogleAnalyticsAdminV1betaAccount {
26
168
  /** Output only. Time when this account was originally created. */
27
169
  createTime?: string;
@@ -334,6 +476,12 @@ declare namespace gapi.client {
334
476
  /** Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. */
335
477
  secretValue?: string;
336
478
  }
479
+ interface GoogleAnalyticsAdminV1betaNumericValue {
480
+ /** Double value */
481
+ doubleValue?: number;
482
+ /** Integer value */
483
+ int64Value?: string;
484
+ }
337
485
  interface GoogleAnalyticsAdminV1betaProperty {
338
486
  /** Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123" */
339
487
  account?: string;
@@ -397,6 +545,71 @@ declare namespace gapi.client {
397
545
  /** The param to be passed in the ToS link. */
398
546
  accountTicketId?: string;
399
547
  }
548
+ interface GoogleAnalyticsAdminV1betaRunAccessReportRequest {
549
+ /**
550
+ * Date ranges of access records 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 access
551
+ * records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
552
+ */
553
+ dateRanges?: GoogleAnalyticsAdminV1betaAccessDateRange[];
554
+ /**
555
+ * Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see
556
+ * [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this
557
+ * filter.
558
+ */
559
+ dimensionFilter?: GoogleAnalyticsAdminV1betaAccessFilterExpression;
560
+ /** The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. */
561
+ dimensions?: GoogleAnalyticsAdminV1betaAccessDimension[];
562
+ /**
563
+ * The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be
564
+ * positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for
565
+ * 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
566
+ * parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
567
+ */
568
+ limit?: string;
569
+ /**
570
+ * Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL
571
+ * having-clause. Dimensions cannot be used in this filter.
572
+ */
573
+ metricFilter?: GoogleAnalyticsAdminV1betaAccessFilterExpression;
574
+ /** The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. */
575
+ metrics?: GoogleAnalyticsAdminV1betaAccessMetric[];
576
+ /**
577
+ * The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of
578
+ * results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
579
+ */
580
+ offset?: string;
581
+ /** Specifies how rows are ordered in the response. */
582
+ orderBys?: GoogleAnalyticsAdminV1betaAccessOrderBy[];
583
+ /**
584
+ * Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be
585
+ * false.
586
+ */
587
+ returnEntityQuota?: boolean;
588
+ /**
589
+ * This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted
590
+ * as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
591
+ */
592
+ timeZone?: string;
593
+ }
594
+ interface GoogleAnalyticsAdminV1betaRunAccessReportResponse {
595
+ /**
596
+ * The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in
597
+ * rows.
598
+ */
599
+ dimensionHeaders?: GoogleAnalyticsAdminV1betaAccessDimensionHeader[];
600
+ /** The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. */
601
+ metricHeaders?: GoogleAnalyticsAdminV1betaAccessMetricHeader[];
602
+ /** The quota state for this Analytics property including this request. This field doesn't work with account-level requests. */
603
+ quota?: GoogleAnalyticsAdminV1betaAccessQuota;
604
+ /**
605
+ * 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
606
+ * 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
607
+ * this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
608
+ */
609
+ rowCount?: number;
610
+ /** Rows of dimension value combinations and metric values in the report. */
611
+ rows?: GoogleAnalyticsAdminV1betaAccessRow[];
612
+ }
400
613
  interface GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest {
401
614
  /** Optional. If set, only return changes that match one or more of these types of actions. */
402
615
  action?: string[];
@@ -674,6 +887,76 @@ declare namespace gapi.client {
674
887
  uploadType?: string;
675
888
  },
676
889
  body: GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest): Request<GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse>;
890
+ /**
891
+ * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2
892
+ * years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records
893
+ * include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records
894
+ * don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
895
+ * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
896
+ */
897
+ runAccessReport(request: {
898
+ /** V1 error format. */
899
+ "$.xgafv"?: string;
900
+ /** OAuth access token. */
901
+ access_token?: string;
902
+ /** Data format for response. */
903
+ alt?: string;
904
+ /** JSONP */
905
+ callback?: string;
906
+ /**
907
+ * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
908
+ * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
909
+ * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
910
+ */
911
+ entity: string;
912
+ /** Selector specifying which fields to include in a partial response. */
913
+ fields?: string;
914
+ /** 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. */
915
+ key?: string;
916
+ /** OAuth 2.0 token for the current user. */
917
+ oauth_token?: string;
918
+ /** Returns response with indentations and line breaks. */
919
+ prettyPrint?: boolean;
920
+ /** 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. */
921
+ quotaUser?: string;
922
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
923
+ upload_protocol?: string;
924
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
925
+ uploadType?: string;
926
+ /** Request body */
927
+ resource: GoogleAnalyticsAdminV1betaRunAccessReportRequest;
928
+ }): Request<GoogleAnalyticsAdminV1betaRunAccessReportResponse>;
929
+ runAccessReport(request: {
930
+ /** V1 error format. */
931
+ "$.xgafv"?: string;
932
+ /** OAuth access token. */
933
+ access_token?: string;
934
+ /** Data format for response. */
935
+ alt?: string;
936
+ /** JSONP */
937
+ callback?: string;
938
+ /**
939
+ * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
940
+ * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
941
+ * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
942
+ */
943
+ entity: string;
944
+ /** Selector specifying which fields to include in a partial response. */
945
+ fields?: string;
946
+ /** 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. */
947
+ key?: string;
948
+ /** OAuth 2.0 token for the current user. */
949
+ oauth_token?: string;
950
+ /** Returns response with indentations and line breaks. */
951
+ prettyPrint?: boolean;
952
+ /** 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. */
953
+ quotaUser?: string;
954
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
955
+ upload_protocol?: string;
956
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
957
+ uploadType?: string;
958
+ },
959
+ body: GoogleAnalyticsAdminV1betaRunAccessReportRequest): Request<GoogleAnalyticsAdminV1betaRunAccessReportResponse>;
677
960
  /** Searches through all changes to an account or its children given the specified set of filters. */
678
961
  searchChangeHistoryEvents(request: {
679
962
  /** V1 error format. */
@@ -2421,6 +2704,76 @@ declare namespace gapi.client {
2421
2704
  uploadType?: string;
2422
2705
  },
2423
2706
  body: GoogleAnalyticsAdminV1betaProperty): Request<GoogleAnalyticsAdminV1betaProperty>;
2707
+ /**
2708
+ * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2
2709
+ * years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records
2710
+ * include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records
2711
+ * don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
2712
+ * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
2713
+ */
2714
+ runAccessReport(request: {
2715
+ /** V1 error format. */
2716
+ "$.xgafv"?: string;
2717
+ /** OAuth access token. */
2718
+ access_token?: string;
2719
+ /** Data format for response. */
2720
+ alt?: string;
2721
+ /** JSONP */
2722
+ callback?: string;
2723
+ /**
2724
+ * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
2725
+ * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
2726
+ * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
2727
+ */
2728
+ entity: string;
2729
+ /** Selector specifying which fields to include in a partial response. */
2730
+ fields?: string;
2731
+ /** 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. */
2732
+ key?: string;
2733
+ /** OAuth 2.0 token for the current user. */
2734
+ oauth_token?: string;
2735
+ /** Returns response with indentations and line breaks. */
2736
+ prettyPrint?: boolean;
2737
+ /** 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. */
2738
+ quotaUser?: string;
2739
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2740
+ upload_protocol?: string;
2741
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2742
+ uploadType?: string;
2743
+ /** Request body */
2744
+ resource: GoogleAnalyticsAdminV1betaRunAccessReportRequest;
2745
+ }): Request<GoogleAnalyticsAdminV1betaRunAccessReportResponse>;
2746
+ runAccessReport(request: {
2747
+ /** V1 error format. */
2748
+ "$.xgafv"?: string;
2749
+ /** OAuth access token. */
2750
+ access_token?: string;
2751
+ /** Data format for response. */
2752
+ alt?: string;
2753
+ /** JSONP */
2754
+ callback?: string;
2755
+ /**
2756
+ * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
2757
+ * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
2758
+ * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
2759
+ */
2760
+ entity: string;
2761
+ /** Selector specifying which fields to include in a partial response. */
2762
+ fields?: string;
2763
+ /** 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. */
2764
+ key?: string;
2765
+ /** OAuth 2.0 token for the current user. */
2766
+ oauth_token?: string;
2767
+ /** Returns response with indentations and line breaks. */
2768
+ prettyPrint?: boolean;
2769
+ /** 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. */
2770
+ quotaUser?: string;
2771
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2772
+ upload_protocol?: string;
2773
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2774
+ uploadType?: string;
2775
+ },
2776
+ body: GoogleAnalyticsAdminV1betaRunAccessReportRequest): Request<GoogleAnalyticsAdminV1betaRunAccessReportResponse>;
2424
2777
  /** Updates the singleton data retention settings for this property. */
2425
2778
  updateDataRetentionSettings(request: {
2426
2779
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1beta",
3
- "version": "0.0.20230307",
3
+ "version": "0.0.20230308",
4
4
  "description": "TypeScript typings for Google Analytics Admin API v1beta",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -99,6 +99,11 @@ Requests a ticket for creating an account.
99
99
  */
100
100
  await gapi.client.analyticsadmin.accounts.provisionAccountTicket({ });
101
101
 
102
+ /*
103
+ Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
104
+ */
105
+ await gapi.client.analyticsadmin.accounts.runAccessReport({ entity: "entity", });
106
+
102
107
  /*
103
108
  Searches through all changes to an account or its children given the specified set of filters.
104
109
  */
@@ -144,6 +149,11 @@ Updates a property.
144
149
  */
145
150
  await gapi.client.analyticsadmin.properties.patch({ name: "name", });
146
151
 
152
+ /*
153
+ Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
154
+ */
155
+ await gapi.client.analyticsadmin.properties.runAccessReport({ entity: "entity", });
156
+
147
157
  /*
148
158
  Updates the singleton data retention settings for this property.
149
159
  */
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230307
6
+ // Revision: 20230308
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -81,6 +81,129 @@ gapi.load('client', async () => {
81
81
  },
82
82
  redirectUri: "Test string",
83
83
  });
84
+ /**
85
+ * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.
86
+ * Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4
87
+ * UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include
88
+ * property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
89
+ * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
90
+ */
91
+ await gapi.client.analyticsadmin.accounts.runAccessReport({
92
+ entity: "Test string",
93
+ }, {
94
+ dateRanges: [
95
+ {
96
+ endDate: "Test string",
97
+ startDate: "Test string",
98
+ }
99
+ ],
100
+ dimensionFilter: {
101
+ accessFilter: {
102
+ betweenFilter: {
103
+ fromValue: {
104
+ doubleValue: 42,
105
+ int64Value: "Test string",
106
+ },
107
+ toValue: {
108
+ doubleValue: 42,
109
+ int64Value: "Test string",
110
+ },
111
+ },
112
+ fieldName: "Test string",
113
+ inListFilter: {
114
+ caseSensitive: true,
115
+ values: [
116
+ "Test string"
117
+ ],
118
+ },
119
+ numericFilter: {
120
+ operation: "Test string",
121
+ value: {
122
+ doubleValue: 42,
123
+ int64Value: "Test string",
124
+ },
125
+ },
126
+ stringFilter: {
127
+ caseSensitive: true,
128
+ matchType: "Test string",
129
+ value: "Test string",
130
+ },
131
+ },
132
+ andGroup: {
133
+ expressions: undefined,
134
+ },
135
+ notExpression: undefined,
136
+ orGroup: {
137
+ expressions: undefined,
138
+ },
139
+ },
140
+ dimensions: [
141
+ {
142
+ dimensionName: "Test string",
143
+ }
144
+ ],
145
+ limit: "Test string",
146
+ metricFilter: {
147
+ accessFilter: {
148
+ betweenFilter: {
149
+ fromValue: {
150
+ doubleValue: 42,
151
+ int64Value: "Test string",
152
+ },
153
+ toValue: {
154
+ doubleValue: 42,
155
+ int64Value: "Test string",
156
+ },
157
+ },
158
+ fieldName: "Test string",
159
+ inListFilter: {
160
+ caseSensitive: true,
161
+ values: [
162
+ "Test string"
163
+ ],
164
+ },
165
+ numericFilter: {
166
+ operation: "Test string",
167
+ value: {
168
+ doubleValue: 42,
169
+ int64Value: "Test string",
170
+ },
171
+ },
172
+ stringFilter: {
173
+ caseSensitive: true,
174
+ matchType: "Test string",
175
+ value: "Test string",
176
+ },
177
+ },
178
+ andGroup: {
179
+ expressions: undefined,
180
+ },
181
+ notExpression: undefined,
182
+ orGroup: {
183
+ expressions: undefined,
184
+ },
185
+ },
186
+ metrics: [
187
+ {
188
+ metricName: "Test string",
189
+ }
190
+ ],
191
+ offset: "Test string",
192
+ orderBys: [
193
+ {
194
+ desc: true,
195
+ dimension: {
196
+ dimensionName: "Test string",
197
+ orderType: "Test string",
198
+ },
199
+ metric: {
200
+ metricName: "Test string",
201
+ },
202
+ }
203
+ ],
204
+ returnEntityQuota: true,
205
+ timeZone: "Test string",
206
+ });
84
207
  /** Searches through all changes to an account or its children given the specified set of filters. */
85
208
  await gapi.client.analyticsadmin.accounts.searchChangeHistoryEvents({
86
209
  account: "Test string",
@@ -176,6 +299,129 @@ gapi.load('client', async () => {
176
299
  timeZone: "Test string",
177
300
  updateTime: "Test string",
178
301
  });
302
+ /**
303
+ * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.
304
+ * Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4
305
+ * UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include
306
+ * property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
307
+ * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
308
+ */
309
+ await gapi.client.analyticsadmin.properties.runAccessReport({
310
+ entity: "Test string",
311
+ }, {
312
+ dateRanges: [
313
+ {
314
+ endDate: "Test string",
315
+ startDate: "Test string",
316
+ }
317
+ ],
318
+ dimensionFilter: {
319
+ accessFilter: {
320
+ betweenFilter: {
321
+ fromValue: {
322
+ doubleValue: 42,
323
+ int64Value: "Test string",
324
+ },
325
+ toValue: {
326
+ doubleValue: 42,
327
+ int64Value: "Test string",
328
+ },
329
+ },
330
+ fieldName: "Test string",
331
+ inListFilter: {
332
+ caseSensitive: true,
333
+ values: [
334
+ "Test string"
335
+ ],
336
+ },
337
+ numericFilter: {
338
+ operation: "Test string",
339
+ value: {
340
+ doubleValue: 42,
341
+ int64Value: "Test string",
342
+ },
343
+ },
344
+ stringFilter: {
345
+ caseSensitive: true,
346
+ matchType: "Test string",
347
+ value: "Test string",
348
+ },
349
+ },
350
+ andGroup: {
351
+ expressions: undefined,
352
+ },
353
+ notExpression: undefined,
354
+ orGroup: {
355
+ expressions: undefined,
356
+ },
357
+ },
358
+ dimensions: [
359
+ {
360
+ dimensionName: "Test string",
361
+ }
362
+ ],
363
+ limit: "Test string",
364
+ metricFilter: {
365
+ accessFilter: {
366
+ betweenFilter: {
367
+ fromValue: {
368
+ doubleValue: 42,
369
+ int64Value: "Test string",
370
+ },
371
+ toValue: {
372
+ doubleValue: 42,
373
+ int64Value: "Test string",
374
+ },
375
+ },
376
+ fieldName: "Test string",
377
+ inListFilter: {
378
+ caseSensitive: true,
379
+ values: [
380
+ "Test string"
381
+ ],
382
+ },
383
+ numericFilter: {
384
+ operation: "Test string",
385
+ value: {
386
+ doubleValue: 42,
387
+ int64Value: "Test string",
388
+ },
389
+ },
390
+ stringFilter: {
391
+ caseSensitive: true,
392
+ matchType: "Test string",
393
+ value: "Test string",
394
+ },
395
+ },
396
+ andGroup: {
397
+ expressions: undefined,
398
+ },
399
+ notExpression: undefined,
400
+ orGroup: {
401
+ expressions: undefined,
402
+ },
403
+ },
404
+ metrics: [
405
+ {
406
+ metricName: "Test string",
407
+ }
408
+ ],
409
+ offset: "Test string",
410
+ orderBys: [
411
+ {
412
+ desc: true,
413
+ dimension: {
414
+ dimensionName: "Test string",
415
+ orderType: "Test string",
416
+ },
417
+ metric: {
418
+ metricName: "Test string",
419
+ },
420
+ }
421
+ ],
422
+ returnEntityQuota: true,
423
+ timeZone: "Test string",
424
+ });
179
425
  /** Updates the singleton data retention settings for this property. */
180
426
  await gapi.client.analyticsadmin.properties.updateDataRetentionSettings({
181
427
  name: "Test string",