@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230221 → 0.0.20230222

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,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=v1alpha
12
- // Revision: 20230221
12
+ // Revision: 20230222
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -2392,6 +2392,68 @@ declare namespace gapi.client {
2392
2392
  uploadType?: string;
2393
2393
  },
2394
2394
  body: GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest): Request<GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse>;
2395
+ /**
2396
+ * 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
2397
+ * 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
2398
+ * 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
2399
+ * don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
2400
+ * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
2401
+ */
2402
+ runAccessReport(request: {
2403
+ /** V1 error format. */
2404
+ "$.xgafv"?: string;
2405
+ /** OAuth access token. */
2406
+ access_token?: string;
2407
+ /** Data format for response. */
2408
+ alt?: string;
2409
+ /** JSONP */
2410
+ callback?: string;
2411
+ /** The Data Access Report is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123". */
2412
+ entity: string;
2413
+ /** Selector specifying which fields to include in a partial response. */
2414
+ fields?: string;
2415
+ /** 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. */
2416
+ key?: string;
2417
+ /** OAuth 2.0 token for the current user. */
2418
+ oauth_token?: string;
2419
+ /** Returns response with indentations and line breaks. */
2420
+ prettyPrint?: boolean;
2421
+ /** 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. */
2422
+ quotaUser?: string;
2423
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2424
+ upload_protocol?: string;
2425
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2426
+ uploadType?: string;
2427
+ /** Request body */
2428
+ resource: GoogleAnalyticsAdminV1alphaRunAccessReportRequest;
2429
+ }): Request<GoogleAnalyticsAdminV1alphaRunAccessReportResponse>;
2430
+ runAccessReport(request: {
2431
+ /** V1 error format. */
2432
+ "$.xgafv"?: string;
2433
+ /** OAuth access token. */
2434
+ access_token?: string;
2435
+ /** Data format for response. */
2436
+ alt?: string;
2437
+ /** JSONP */
2438
+ callback?: string;
2439
+ /** The Data Access Report is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123". */
2440
+ entity: string;
2441
+ /** Selector specifying which fields to include in a partial response. */
2442
+ fields?: string;
2443
+ /** 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. */
2444
+ key?: string;
2445
+ /** OAuth 2.0 token for the current user. */
2446
+ oauth_token?: string;
2447
+ /** Returns response with indentations and line breaks. */
2448
+ prettyPrint?: boolean;
2449
+ /** 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. */
2450
+ quotaUser?: string;
2451
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2452
+ upload_protocol?: string;
2453
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2454
+ uploadType?: string;
2455
+ },
2456
+ body: GoogleAnalyticsAdminV1alphaRunAccessReportRequest): Request<GoogleAnalyticsAdminV1alphaRunAccessReportResponse>;
2395
2457
  /** Searches through all changes to an account or its children given the specified set of filters. */
2396
2458
  searchChangeHistoryEvents(request: {
2397
2459
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
3
- "version": "0.0.20230221",
3
+ "version": "0.0.20230222",
4
4
  "description": "TypeScript typings for Google Analytics Admin API v1alpha",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -105,6 +105,11 @@ Requests a ticket for creating an account.
105
105
  */
106
106
  await gapi.client.analyticsadmin.accounts.provisionAccountTicket({ });
107
107
 
108
+ /*
109
+ 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).
110
+ */
111
+ await gapi.client.analyticsadmin.accounts.runAccessReport({ entity: "entity", });
112
+
108
113
  /*
109
114
  Searches through all changes to an account or its children given the specified set of filters.
110
115
  */
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: 20230221
6
+ // Revision: 20230222
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -85,6 +85,129 @@ gapi.load('client', async () => {
85
85
  },
86
86
  redirectUri: "Test string",
87
87
  });
88
+ /**
89
+ * 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.
90
+ * 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
91
+ * 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
92
+ * property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
93
+ * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
94
+ */
95
+ await gapi.client.analyticsadmin.accounts.runAccessReport({
96
+ entity: "Test string",
97
+ }, {
98
+ dateRanges: [
99
+ {
100
+ endDate: "Test string",
101
+ startDate: "Test string",
102
+ }
103
+ ],
104
+ dimensionFilter: {
105
+ accessFilter: {
106
+ betweenFilter: {
107
+ fromValue: {
108
+ doubleValue: 42,
109
+ int64Value: "Test string",
110
+ },
111
+ toValue: {
112
+ doubleValue: 42,
113
+ int64Value: "Test string",
114
+ },
115
+ },
116
+ fieldName: "Test string",
117
+ inListFilter: {
118
+ caseSensitive: true,
119
+ values: [
120
+ "Test string"
121
+ ],
122
+ },
123
+ numericFilter: {
124
+ operation: "Test string",
125
+ value: {
126
+ doubleValue: 42,
127
+ int64Value: "Test string",
128
+ },
129
+ },
130
+ stringFilter: {
131
+ caseSensitive: true,
132
+ matchType: "Test string",
133
+ value: "Test string",
134
+ },
135
+ },
136
+ andGroup: {
137
+ expressions: undefined,
138
+ },
139
+ notExpression: undefined,
140
+ orGroup: {
141
+ expressions: undefined,
142
+ },
143
+ },
144
+ dimensions: [
145
+ {
146
+ dimensionName: "Test string",
147
+ }
148
+ ],
149
+ limit: "Test string",
150
+ metricFilter: {
151
+ accessFilter: {
152
+ betweenFilter: {
153
+ fromValue: {
154
+ doubleValue: 42,
155
+ int64Value: "Test string",
156
+ },
157
+ toValue: {
158
+ doubleValue: 42,
159
+ int64Value: "Test string",
160
+ },
161
+ },
162
+ fieldName: "Test string",
163
+ inListFilter: {
164
+ caseSensitive: true,
165
+ values: [
166
+ "Test string"
167
+ ],
168
+ },
169
+ numericFilter: {
170
+ operation: "Test string",
171
+ value: {
172
+ doubleValue: 42,
173
+ int64Value: "Test string",
174
+ },
175
+ },
176
+ stringFilter: {
177
+ caseSensitive: true,
178
+ matchType: "Test string",
179
+ value: "Test string",
180
+ },
181
+ },
182
+ andGroup: {
183
+ expressions: undefined,
184
+ },
185
+ notExpression: undefined,
186
+ orGroup: {
187
+ expressions: undefined,
188
+ },
189
+ },
190
+ metrics: [
191
+ {
192
+ metricName: "Test string",
193
+ }
194
+ ],
195
+ offset: "Test string",
196
+ orderBys: [
197
+ {
198
+ desc: true,
199
+ dimension: {
200
+ dimensionName: "Test string",
201
+ orderType: "Test string",
202
+ },
203
+ metric: {
204
+ metricName: "Test string",
205
+ },
206
+ }
207
+ ],
208
+ returnEntityQuota: true,
209
+ timeZone: "Test string",
210
+ });
88
211
  /** Searches through all changes to an account or its children given the specified set of filters. */
89
212
  await gapi.client.analyticsadmin.accounts.searchChangeHistoryEvents({
90
213
  account: "Test string",