@maxim_mazurok/gapi.client.analyticsadmin-v1beta 0.0.20231002 → 0.0.20231004
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 +16 -4
- package/package.json +1 -1
- package/readme.md +2 -2
- package/tests.ts +8 -4
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:
|
|
12
|
+
// Revision: 20231004
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -730,6 +730,18 @@ declare namespace gapi.client {
|
|
|
730
730
|
/** The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. */
|
|
731
731
|
dimensions?:
|
|
732
732
|
GoogleAnalyticsAdminV1betaAccessDimension[];
|
|
733
|
+
/**
|
|
734
|
+
* Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the
|
|
735
|
+
* specified property or account. If false, only the users with direct access will be returned.
|
|
736
|
+
*/
|
|
737
|
+
expandGroups?:
|
|
738
|
+
boolean;
|
|
739
|
+
/**
|
|
740
|
+
* Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in
|
|
741
|
+
* the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.
|
|
742
|
+
*/
|
|
743
|
+
includeAllUsers?:
|
|
744
|
+
boolean;
|
|
733
745
|
/**
|
|
734
746
|
* 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
|
|
735
747
|
* 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
|
|
@@ -839,8 +851,8 @@ declare namespace gapi.client {
|
|
|
839
851
|
interface AccountsResource {
|
|
840
852
|
/**
|
|
841
853
|
* Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash
|
|
842
|
-
* Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams,
|
|
843
|
-
* purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
854
|
+
* Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be
|
|
855
|
+
* permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
844
856
|
*/
|
|
845
857
|
delete(request?: {
|
|
846
858
|
/** V1 error format. */
|
|
@@ -3583,7 +3595,7 @@ declare namespace gapi.client {
|
|
|
3583
3595
|
body: GoogleAnalyticsAdminV1betaProperty): Request<GoogleAnalyticsAdminV1betaProperty>;
|
|
3584
3596
|
/**
|
|
3585
3597
|
* Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the
|
|
3586
|
-
* Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams,
|
|
3598
|
+
* Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently
|
|
3587
3599
|
* purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.
|
|
3588
3600
|
*/
|
|
3589
3601
|
delete(request?: {
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -70,7 +70,7 @@ After that you can use Google Analytics Admin API resources: <!-- TODO: make thi
|
|
|
70
70
|
```typescript
|
|
71
71
|
|
|
72
72
|
/*
|
|
73
|
-
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams,
|
|
73
|
+
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
74
74
|
*/
|
|
75
75
|
await gapi.client.analyticsadmin.accounts.delete({ name: "name", });
|
|
76
76
|
|
|
@@ -125,7 +125,7 @@ Creates an "GA4" property with the specified location and attributes.
|
|
|
125
125
|
await gapi.client.analyticsadmin.properties.create({ });
|
|
126
126
|
|
|
127
127
|
/*
|
|
128
|
-
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams,
|
|
128
|
+
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.
|
|
129
129
|
*/
|
|
130
130
|
await gapi.client.analyticsadmin.properties.delete({ name: "name", });
|
|
131
131
|
|
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:
|
|
6
|
+
// Revision: 20231004
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -33,8 +33,8 @@ gapi.load('client', async () => {
|
|
|
33
33
|
async function run() {
|
|
34
34
|
/**
|
|
35
35
|
* Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can
|
|
36
|
-
* UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams,
|
|
37
|
-
* https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
36
|
+
* UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently
|
|
37
|
+
* purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
38
38
|
*/
|
|
39
39
|
await gapi.client.analyticsadmin.accounts.delete({
|
|
40
40
|
name: "Test string",
|
|
@@ -142,6 +142,8 @@ gapi.load('client', async () => {
|
|
|
142
142
|
dimensionName: "Test string",
|
|
143
143
|
}
|
|
144
144
|
],
|
|
145
|
+
expandGroups: true,
|
|
146
|
+
includeAllUsers: true,
|
|
145
147
|
limit: "Test string",
|
|
146
148
|
metricFilter: {
|
|
147
149
|
accessFilter: {
|
|
@@ -256,7 +258,7 @@ gapi.load('client', async () => {
|
|
|
256
258
|
});
|
|
257
259
|
/**
|
|
258
260
|
* Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash
|
|
259
|
-
* Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams,
|
|
261
|
+
* Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged.
|
|
260
262
|
* https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.
|
|
261
263
|
*/
|
|
262
264
|
await gapi.client.analyticsadmin.properties.delete({
|
|
@@ -360,6 +362,8 @@ gapi.load('client', async () => {
|
|
|
360
362
|
dimensionName: "Test string",
|
|
361
363
|
}
|
|
362
364
|
],
|
|
365
|
+
expandGroups: true,
|
|
366
|
+
includeAllUsers: true,
|
|
363
367
|
limit: "Test string",
|
|
364
368
|
metricFilter: {
|
|
365
369
|
accessFilter: {
|