@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 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 +1393 -2890
- package/package.json +1 -1
- package/readme.md +2 -2
- package/tests.ts +8 -202
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -76,7 +76,7 @@ After that you can use Google Analytics Admin API resources: <!-- TODO: make thi
|
|
|
76
76
|
```typescript
|
|
77
77
|
|
|
78
78
|
/*
|
|
79
|
-
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,
|
|
79
|
+
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.
|
|
80
80
|
*/
|
|
81
81
|
await gapi.client.analyticsadmin.accounts.delete({ name: "name", });
|
|
82
82
|
|
|
@@ -146,7 +146,7 @@ Create a subproperty and a subproperty event filter that applies to the created
|
|
|
146
146
|
await gapi.client.analyticsadmin.properties.createSubproperty({ });
|
|
147
147
|
|
|
148
148
|
/*
|
|
149
|
-
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,
|
|
149
|
+
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.
|
|
150
150
|
*/
|
|
151
151
|
await gapi.client.analyticsadmin.properties.delete({ name: "name", });
|
|
152
152
|
|
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 */
|
|
@@ -37,8 +37,8 @@ gapi.load('client', async () => {
|
|
|
37
37
|
async function run() {
|
|
38
38
|
/**
|
|
39
39
|
* 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
|
|
40
|
-
* UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams,
|
|
41
|
-
* https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
40
|
+
* 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
|
|
41
|
+
* purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
|
|
42
42
|
*/
|
|
43
43
|
await gapi.client.analyticsadmin.accounts.delete({
|
|
44
44
|
name: "Test string",
|
|
@@ -146,6 +146,8 @@ gapi.load('client', async () => {
|
|
|
146
146
|
dimensionName: "Test string",
|
|
147
147
|
}
|
|
148
148
|
],
|
|
149
|
+
expandGroups: true,
|
|
150
|
+
includeAllUsers: true,
|
|
149
151
|
limit: "Test string",
|
|
150
152
|
metricFilter: {
|
|
151
153
|
accessFilter: {
|
|
@@ -312,105 +314,6 @@ gapi.load('client', async () => {
|
|
|
312
314
|
],
|
|
313
315
|
user: "Test string",
|
|
314
316
|
});
|
|
315
|
-
/**
|
|
316
|
-
* Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does
|
|
317
|
-
* not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them
|
|
318
|
-
* permissions, which is currently only usable/discoverable in the GA or GMP UIs.
|
|
319
|
-
*/
|
|
320
|
-
await gapi.client.analyticsadmin.accounts.userLinks.audit({
|
|
321
|
-
parent: "Test string",
|
|
322
|
-
}, {
|
|
323
|
-
pageSize: 42,
|
|
324
|
-
pageToken: "Test string",
|
|
325
|
-
});
|
|
326
|
-
/** Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created. */
|
|
327
|
-
await gapi.client.analyticsadmin.accounts.userLinks.batchCreate({
|
|
328
|
-
parent: "Test string",
|
|
329
|
-
}, {
|
|
330
|
-
notifyNewUsers: true,
|
|
331
|
-
requests: [
|
|
332
|
-
{
|
|
333
|
-
notifyNewUser: true,
|
|
334
|
-
parent: "Test string",
|
|
335
|
-
userLink: {
|
|
336
|
-
directRoles: [
|
|
337
|
-
"Test string"
|
|
338
|
-
],
|
|
339
|
-
emailAddress: "Test string",
|
|
340
|
-
name: "Test string",
|
|
341
|
-
},
|
|
342
|
-
}
|
|
343
|
-
],
|
|
344
|
-
});
|
|
345
|
-
/** Deletes information about multiple users' links to an account or property. */
|
|
346
|
-
await gapi.client.analyticsadmin.accounts.userLinks.batchDelete({
|
|
347
|
-
parent: "Test string",
|
|
348
|
-
}, {
|
|
349
|
-
requests: [
|
|
350
|
-
{
|
|
351
|
-
name: "Test string",
|
|
352
|
-
}
|
|
353
|
-
],
|
|
354
|
-
});
|
|
355
|
-
/** Gets information about multiple users' links to an account or property. */
|
|
356
|
-
await gapi.client.analyticsadmin.accounts.userLinks.batchGet({
|
|
357
|
-
names: "Test string",
|
|
358
|
-
parent: "Test string",
|
|
359
|
-
});
|
|
360
|
-
/** Updates information about multiple users' links to an account or property. */
|
|
361
|
-
await gapi.client.analyticsadmin.accounts.userLinks.batchUpdate({
|
|
362
|
-
parent: "Test string",
|
|
363
|
-
}, {
|
|
364
|
-
requests: [
|
|
365
|
-
{
|
|
366
|
-
userLink: {
|
|
367
|
-
directRoles: [
|
|
368
|
-
"Test string"
|
|
369
|
-
],
|
|
370
|
-
emailAddress: "Test string",
|
|
371
|
-
name: "Test string",
|
|
372
|
-
},
|
|
373
|
-
}
|
|
374
|
-
],
|
|
375
|
-
});
|
|
376
|
-
/**
|
|
377
|
-
* Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be
|
|
378
|
-
* unioned with the permissions specified in the new UserLink.
|
|
379
|
-
*/
|
|
380
|
-
await gapi.client.analyticsadmin.accounts.userLinks.create({
|
|
381
|
-
notifyNewUser: true,
|
|
382
|
-
parent: "Test string",
|
|
383
|
-
}, {
|
|
384
|
-
directRoles: [
|
|
385
|
-
"Test string"
|
|
386
|
-
],
|
|
387
|
-
emailAddress: "Test string",
|
|
388
|
-
name: "Test string",
|
|
389
|
-
});
|
|
390
|
-
/** Deletes a user link on an account or property. */
|
|
391
|
-
await gapi.client.analyticsadmin.accounts.userLinks.delete({
|
|
392
|
-
name: "Test string",
|
|
393
|
-
});
|
|
394
|
-
/** Gets information about a user's link to an account or property. */
|
|
395
|
-
await gapi.client.analyticsadmin.accounts.userLinks.get({
|
|
396
|
-
name: "Test string",
|
|
397
|
-
});
|
|
398
|
-
/** Lists all user links on an account or property. */
|
|
399
|
-
await gapi.client.analyticsadmin.accounts.userLinks.list({
|
|
400
|
-
pageSize: 42,
|
|
401
|
-
pageToken: "Test string",
|
|
402
|
-
parent: "Test string",
|
|
403
|
-
});
|
|
404
|
-
/** Updates a user link on an account or property. */
|
|
405
|
-
await gapi.client.analyticsadmin.accounts.userLinks.patch({
|
|
406
|
-
name: "Test string",
|
|
407
|
-
}, {
|
|
408
|
-
directRoles: [
|
|
409
|
-
"Test string"
|
|
410
|
-
],
|
|
411
|
-
emailAddress: "Test string",
|
|
412
|
-
name: "Test string",
|
|
413
|
-
});
|
|
414
317
|
/** Returns summaries of all accounts accessible by the caller. */
|
|
415
318
|
await gapi.client.analyticsadmin.accountSummaries.list({
|
|
416
319
|
pageSize: 42,
|
|
@@ -519,7 +422,7 @@ gapi.load('client', async () => {
|
|
|
519
422
|
});
|
|
520
423
|
/**
|
|
521
424
|
* 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
|
|
522
|
-
* Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams,
|
|
425
|
+
* 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.
|
|
523
426
|
* https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.
|
|
524
427
|
*/
|
|
525
428
|
await gapi.client.analyticsadmin.properties.delete({
|
|
@@ -651,6 +554,8 @@ gapi.load('client', async () => {
|
|
|
651
554
|
dimensionName: "Test string",
|
|
652
555
|
}
|
|
653
556
|
],
|
|
557
|
+
expandGroups: true,
|
|
558
|
+
includeAllUsers: true,
|
|
654
559
|
limit: "Test string",
|
|
655
560
|
metricFilter: {
|
|
656
561
|
accessFilter: {
|
|
@@ -2028,104 +1933,5 @@ gapi.load('client', async () => {
|
|
|
2028
1933
|
],
|
|
2029
1934
|
name: "Test string",
|
|
2030
1935
|
});
|
|
2031
|
-
/**
|
|
2032
|
-
* Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does
|
|
2033
|
-
* not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them
|
|
2034
|
-
* permissions, which is currently only usable/discoverable in the GA or GMP UIs.
|
|
2035
|
-
*/
|
|
2036
|
-
await gapi.client.analyticsadmin.properties.userLinks.audit({
|
|
2037
|
-
parent: "Test string",
|
|
2038
|
-
}, {
|
|
2039
|
-
pageSize: 42,
|
|
2040
|
-
pageToken: "Test string",
|
|
2041
|
-
});
|
|
2042
|
-
/** Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created. */
|
|
2043
|
-
await gapi.client.analyticsadmin.properties.userLinks.batchCreate({
|
|
2044
|
-
parent: "Test string",
|
|
2045
|
-
}, {
|
|
2046
|
-
notifyNewUsers: true,
|
|
2047
|
-
requests: [
|
|
2048
|
-
{
|
|
2049
|
-
notifyNewUser: true,
|
|
2050
|
-
parent: "Test string",
|
|
2051
|
-
userLink: {
|
|
2052
|
-
directRoles: [
|
|
2053
|
-
"Test string"
|
|
2054
|
-
],
|
|
2055
|
-
emailAddress: "Test string",
|
|
2056
|
-
name: "Test string",
|
|
2057
|
-
},
|
|
2058
|
-
}
|
|
2059
|
-
],
|
|
2060
|
-
});
|
|
2061
|
-
/** Deletes information about multiple users' links to an account or property. */
|
|
2062
|
-
await gapi.client.analyticsadmin.properties.userLinks.batchDelete({
|
|
2063
|
-
parent: "Test string",
|
|
2064
|
-
}, {
|
|
2065
|
-
requests: [
|
|
2066
|
-
{
|
|
2067
|
-
name: "Test string",
|
|
2068
|
-
}
|
|
2069
|
-
],
|
|
2070
|
-
});
|
|
2071
|
-
/** Gets information about multiple users' links to an account or property. */
|
|
2072
|
-
await gapi.client.analyticsadmin.properties.userLinks.batchGet({
|
|
2073
|
-
names: "Test string",
|
|
2074
|
-
parent: "Test string",
|
|
2075
|
-
});
|
|
2076
|
-
/** Updates information about multiple users' links to an account or property. */
|
|
2077
|
-
await gapi.client.analyticsadmin.properties.userLinks.batchUpdate({
|
|
2078
|
-
parent: "Test string",
|
|
2079
|
-
}, {
|
|
2080
|
-
requests: [
|
|
2081
|
-
{
|
|
2082
|
-
userLink: {
|
|
2083
|
-
directRoles: [
|
|
2084
|
-
"Test string"
|
|
2085
|
-
],
|
|
2086
|
-
emailAddress: "Test string",
|
|
2087
|
-
name: "Test string",
|
|
2088
|
-
},
|
|
2089
|
-
}
|
|
2090
|
-
],
|
|
2091
|
-
});
|
|
2092
|
-
/**
|
|
2093
|
-
* Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be
|
|
2094
|
-
* unioned with the permissions specified in the new UserLink.
|
|
2095
|
-
*/
|
|
2096
|
-
await gapi.client.analyticsadmin.properties.userLinks.create({
|
|
2097
|
-
notifyNewUser: true,
|
|
2098
|
-
parent: "Test string",
|
|
2099
|
-
}, {
|
|
2100
|
-
directRoles: [
|
|
2101
|
-
"Test string"
|
|
2102
|
-
],
|
|
2103
|
-
emailAddress: "Test string",
|
|
2104
|
-
name: "Test string",
|
|
2105
|
-
});
|
|
2106
|
-
/** Deletes a user link on an account or property. */
|
|
2107
|
-
await gapi.client.analyticsadmin.properties.userLinks.delete({
|
|
2108
|
-
name: "Test string",
|
|
2109
|
-
});
|
|
2110
|
-
/** Gets information about a user's link to an account or property. */
|
|
2111
|
-
await gapi.client.analyticsadmin.properties.userLinks.get({
|
|
2112
|
-
name: "Test string",
|
|
2113
|
-
});
|
|
2114
|
-
/** Lists all user links on an account or property. */
|
|
2115
|
-
await gapi.client.analyticsadmin.properties.userLinks.list({
|
|
2116
|
-
pageSize: 42,
|
|
2117
|
-
pageToken: "Test string",
|
|
2118
|
-
parent: "Test string",
|
|
2119
|
-
});
|
|
2120
|
-
/** Updates a user link on an account or property. */
|
|
2121
|
-
await gapi.client.analyticsadmin.properties.userLinks.patch({
|
|
2122
|
-
name: "Test string",
|
|
2123
|
-
}, {
|
|
2124
|
-
directRoles: [
|
|
2125
|
-
"Test string"
|
|
2126
|
-
],
|
|
2127
|
-
emailAddress: "Test string",
|
|
2128
|
-
name: "Test string",
|
|
2129
|
-
});
|
|
2130
1936
|
}
|
|
2131
1937
|
});
|