@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230926 → 0.0.20231001
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 +1015 -52
- package/package.json +1 -1
- package/readme.md +10 -0
- package/tests.ts +173 -1
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -135,6 +135,16 @@ Creates a connected site tag for a Universal Analytics property. You can create
|
|
|
135
135
|
*/
|
|
136
136
|
await gapi.client.analyticsadmin.properties.createConnectedSiteTag({ });
|
|
137
137
|
|
|
138
|
+
/*
|
|
139
|
+
Create a roll-up property and all roll-up property source links.
|
|
140
|
+
*/
|
|
141
|
+
await gapi.client.analyticsadmin.properties.createRollupProperty({ });
|
|
142
|
+
|
|
143
|
+
/*
|
|
144
|
+
Create a subproperty and a subproperty event filter that applies to the created subproperty.
|
|
145
|
+
*/
|
|
146
|
+
await gapi.client.analyticsadmin.properties.createSubproperty({ });
|
|
147
|
+
|
|
138
148
|
/*
|
|
139
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, UserLinks) 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.
|
|
140
150
|
*/
|
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: 20231001
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -451,6 +451,72 @@ gapi.load('client', async () => {
|
|
|
451
451
|
},
|
|
452
452
|
property: "Test string",
|
|
453
453
|
});
|
|
454
|
+
/** Create a roll-up property and all roll-up property source links. */
|
|
455
|
+
await gapi.client.analyticsadmin.properties.createRollupProperty({
|
|
456
|
+
}, {
|
|
457
|
+
rollupProperty: {
|
|
458
|
+
account: "Test string",
|
|
459
|
+
createTime: "Test string",
|
|
460
|
+
currencyCode: "Test string",
|
|
461
|
+
deleteTime: "Test string",
|
|
462
|
+
displayName: "Test string",
|
|
463
|
+
expireTime: "Test string",
|
|
464
|
+
industryCategory: "Test string",
|
|
465
|
+
name: "Test string",
|
|
466
|
+
parent: "Test string",
|
|
467
|
+
propertyType: "Test string",
|
|
468
|
+
serviceLevel: "Test string",
|
|
469
|
+
timeZone: "Test string",
|
|
470
|
+
updateTime: "Test string",
|
|
471
|
+
},
|
|
472
|
+
sourceProperties: [
|
|
473
|
+
"Test string"
|
|
474
|
+
],
|
|
475
|
+
});
|
|
476
|
+
/** Create a subproperty and a subproperty event filter that applies to the created subproperty. */
|
|
477
|
+
await gapi.client.analyticsadmin.properties.createSubproperty({
|
|
478
|
+
}, {
|
|
479
|
+
parent: "Test string",
|
|
480
|
+
subproperty: {
|
|
481
|
+
account: "Test string",
|
|
482
|
+
createTime: "Test string",
|
|
483
|
+
currencyCode: "Test string",
|
|
484
|
+
deleteTime: "Test string",
|
|
485
|
+
displayName: "Test string",
|
|
486
|
+
expireTime: "Test string",
|
|
487
|
+
industryCategory: "Test string",
|
|
488
|
+
name: "Test string",
|
|
489
|
+
parent: "Test string",
|
|
490
|
+
propertyType: "Test string",
|
|
491
|
+
serviceLevel: "Test string",
|
|
492
|
+
timeZone: "Test string",
|
|
493
|
+
updateTime: "Test string",
|
|
494
|
+
},
|
|
495
|
+
subpropertyEventFilter: {
|
|
496
|
+
applyToProperty: "Test string",
|
|
497
|
+
filterClauses: [
|
|
498
|
+
{
|
|
499
|
+
filterClauseType: "Test string",
|
|
500
|
+
filterExpression: {
|
|
501
|
+
filterCondition: {
|
|
502
|
+
fieldName: "Test string",
|
|
503
|
+
nullFilter: true,
|
|
504
|
+
stringFilter: {
|
|
505
|
+
caseSensitive: true,
|
|
506
|
+
matchType: "Test string",
|
|
507
|
+
value: "Test string",
|
|
508
|
+
},
|
|
509
|
+
},
|
|
510
|
+
notExpression: undefined,
|
|
511
|
+
orGroup: {
|
|
512
|
+
filterExpressions: undefined,
|
|
513
|
+
},
|
|
514
|
+
},
|
|
515
|
+
}
|
|
516
|
+
],
|
|
517
|
+
name: "Test string",
|
|
518
|
+
},
|
|
519
|
+
});
|
|
454
520
|
/**
|
|
455
521
|
* 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
|
|
456
522
|
* Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged.
|
|
@@ -1301,6 +1367,10 @@ gapi.load('client', async () => {
|
|
|
1301
1367
|
await gapi.client.analyticsadmin.properties.dataStreams.get({
|
|
1302
1368
|
name: "Test string",
|
|
1303
1369
|
});
|
|
1370
|
+
/** Lookup for a single DataRedactionSettings. */
|
|
1371
|
+
await gapi.client.analyticsadmin.properties.dataStreams.getDataRedactionSettings({
|
|
1372
|
+
name: "Test string",
|
|
1373
|
+
});
|
|
1304
1374
|
/** Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
|
|
1305
1375
|
await gapi.client.analyticsadmin.properties.dataStreams.getEnhancedMeasurementSettings({
|
|
1306
1376
|
name: "Test string",
|
|
@@ -1339,6 +1409,18 @@ gapi.load('client', async () => {
|
|
|
1339
1409
|
measurementId: "Test string",
|
|
1340
1410
|
},
|
|
1341
1411
|
});
|
|
1412
|
+
/** Updates a DataRedactionSettings on a property. */
|
|
1413
|
+
await gapi.client.analyticsadmin.properties.dataStreams.updateDataRedactionSettings({
|
|
1414
|
+
name: "Test string",
|
|
1415
|
+
updateMask: "Test string",
|
|
1416
|
+
}, {
|
|
1417
|
+
emailRedactionEnabled: true,
|
|
1418
|
+
name: "Test string",
|
|
1419
|
+
queryParameterKeys: [
|
|
1420
|
+
"Test string"
|
|
1421
|
+
],
|
|
1422
|
+
queryParameterRedactionEnabled: true,
|
|
1423
|
+
});
|
|
1342
1424
|
/** Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
|
|
1343
1425
|
await gapi.client.analyticsadmin.properties.dataStreams.updateEnhancedMeasurementSettings({
|
|
1344
1426
|
name: "Test string",
|
|
@@ -1817,6 +1899,27 @@ gapi.load('client', async () => {
|
|
|
1817
1899
|
name: "Test string",
|
|
1818
1900
|
updateTime: "Test string",
|
|
1819
1901
|
});
|
|
1902
|
+
/** Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. */
|
|
1903
|
+
await gapi.client.analyticsadmin.properties.rollupPropertySourceLinks.create({
|
|
1904
|
+
parent: "Test string",
|
|
1905
|
+
}, {
|
|
1906
|
+
name: "Test string",
|
|
1907
|
+
sourceProperty: "Test string",
|
|
1908
|
+
});
|
|
1909
|
+
/** Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. */
|
|
1910
|
+
await gapi.client.analyticsadmin.properties.rollupPropertySourceLinks.delete({
|
|
1911
|
+
name: "Test string",
|
|
1912
|
+
});
|
|
1913
|
+
/** Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. */
|
|
1914
|
+
await gapi.client.analyticsadmin.properties.rollupPropertySourceLinks.get({
|
|
1915
|
+
name: "Test string",
|
|
1916
|
+
});
|
|
1917
|
+
/** Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. */
|
|
1918
|
+
await gapi.client.analyticsadmin.properties.rollupPropertySourceLinks.list({
|
|
1919
|
+
pageSize: 42,
|
|
1920
|
+
pageToken: "Test string",
|
|
1921
|
+
parent: "Test string",
|
|
1922
|
+
});
|
|
1820
1923
|
/** Creates a SearchAds360Link. */
|
|
1821
1924
|
await gapi.client.analyticsadmin.properties.searchAds360Links.create({
|
|
1822
1925
|
parent: "Test string",
|
|
@@ -1856,6 +1959,75 @@ gapi.load('client', async () => {
|
|
|
1856
1959
|
name: "Test string",
|
|
1857
1960
|
siteStatsSharingEnabled: true,
|
|
1858
1961
|
});
|
|
1962
|
+
/** Creates a subproperty Event Filter. */
|
|
1963
|
+
await gapi.client.analyticsadmin.properties.subpropertyEventFilters.create({
|
|
1964
|
+
parent: "Test string",
|
|
1965
|
+
}, {
|
|
1966
|
+
applyToProperty: "Test string",
|
|
1967
|
+
filterClauses: [
|
|
1968
|
+
{
|
|
1969
|
+
filterClauseType: "Test string",
|
|
1970
|
+
filterExpression: {
|
|
1971
|
+
filterCondition: {
|
|
1972
|
+
fieldName: "Test string",
|
|
1973
|
+
nullFilter: true,
|
|
1974
|
+
stringFilter: {
|
|
1975
|
+
caseSensitive: true,
|
|
1976
|
+
matchType: "Test string",
|
|
1977
|
+
value: "Test string",
|
|
1978
|
+
},
|
|
1979
|
+
},
|
|
1980
|
+
notExpression: undefined,
|
|
1981
|
+
orGroup: {
|
|
1982
|
+
filterExpressions: undefined,
|
|
1983
|
+
},
|
|
1984
|
+
},
|
|
1985
|
+
}
|
|
1986
|
+
],
|
|
1987
|
+
name: "Test string",
|
|
1988
|
+
});
|
|
1989
|
+
/** Deletes a subproperty event filter. */
|
|
1990
|
+
await gapi.client.analyticsadmin.properties.subpropertyEventFilters.delete({
|
|
1991
|
+
name: "Test string",
|
|
1992
|
+
});
|
|
1993
|
+
/** Lookup for a single subproperty Event Filter. */
|
|
1994
|
+
await gapi.client.analyticsadmin.properties.subpropertyEventFilters.get({
|
|
1995
|
+
name: "Test string",
|
|
1996
|
+
});
|
|
1997
|
+
/** List all subproperty Event Filters on a property. */
|
|
1998
|
+
await gapi.client.analyticsadmin.properties.subpropertyEventFilters.list({
|
|
1999
|
+
pageSize: 42,
|
|
2000
|
+
pageToken: "Test string",
|
|
2001
|
+
parent: "Test string",
|
|
2002
|
+
});
|
|
2003
|
+
/** Updates a subproperty Event Filter. */
|
|
2004
|
+
await gapi.client.analyticsadmin.properties.subpropertyEventFilters.patch({
|
|
2005
|
+
name: "Test string",
|
|
2006
|
+
updateMask: "Test string",
|
|
2007
|
+
}, {
|
|
2008
|
+
applyToProperty: "Test string",
|
|
2009
|
+
filterClauses: [
|
|
2010
|
+
{
|
|
2011
|
+
filterClauseType: "Test string",
|
|
2012
|
+
filterExpression: {
|
|
2013
|
+
filterCondition: {
|
|
2014
|
+
fieldName: "Test string",
|
|
2015
|
+
nullFilter: true,
|
|
2016
|
+
stringFilter: {
|
|
2017
|
+
caseSensitive: true,
|
|
2018
|
+
matchType: "Test string",
|
|
2019
|
+
value: "Test string",
|
|
2020
|
+
},
|
|
2021
|
+
},
|
|
2022
|
+
notExpression: undefined,
|
|
2023
|
+
orGroup: {
|
|
2024
|
+
filterExpressions: undefined,
|
|
2025
|
+
},
|
|
2026
|
+
},
|
|
2027
|
+
}
|
|
2028
|
+
],
|
|
2029
|
+
name: "Test string",
|
|
2030
|
+
});
|
|
1859
2031
|
/**
|
|
1860
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
|
|
1861
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
|