@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20240730 → 0.0.20240731
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 +67 -67
- package/package.json +1 -1
- package/readme.md +5 -5
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:
|
|
12
|
+
// Revision: 20240731
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -597,18 +597,6 @@ declare namespace gapi.client {
|
|
|
597
597
|
/** The created roll-up property source links. */
|
|
598
598
|
rollupPropertySourceLinks?: GoogleAnalyticsAdminV1alphaRollupPropertySourceLink[];
|
|
599
599
|
}
|
|
600
|
-
interface GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest {
|
|
601
|
-
/** Required. The subproperty to create. */
|
|
602
|
-
subproperty?: GoogleAnalyticsAdminV1alphaProperty;
|
|
603
|
-
/** Optional. The subproperty event filter to create on an ordinary property. */
|
|
604
|
-
subpropertyEventFilter?: GoogleAnalyticsAdminV1alphaSubpropertyEventFilter;
|
|
605
|
-
}
|
|
606
|
-
interface GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse {
|
|
607
|
-
/** The created subproperty. */
|
|
608
|
-
subproperty?: GoogleAnalyticsAdminV1alphaProperty;
|
|
609
|
-
/** The created subproperty event filter. */
|
|
610
|
-
subpropertyEventFilter?: GoogleAnalyticsAdminV1alphaSubpropertyEventFilter;
|
|
611
|
-
}
|
|
612
600
|
interface GoogleAnalyticsAdminV1alphaCustomDimension {
|
|
613
601
|
/** Optional. Description for this custom dimension. Max length of 150 characters. */
|
|
614
602
|
description?: string;
|
|
@@ -1195,6 +1183,18 @@ declare namespace gapi.client {
|
|
|
1195
1183
|
/** The param to be passed in the ToS link. */
|
|
1196
1184
|
accountTicketId?: string;
|
|
1197
1185
|
}
|
|
1186
|
+
interface GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest {
|
|
1187
|
+
/** Required. The subproperty to create. */
|
|
1188
|
+
subproperty?: GoogleAnalyticsAdminV1alphaProperty;
|
|
1189
|
+
/** Optional. The subproperty event filter to create on an ordinary property. */
|
|
1190
|
+
subpropertyEventFilter?: GoogleAnalyticsAdminV1alphaSubpropertyEventFilter;
|
|
1191
|
+
}
|
|
1192
|
+
interface GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse {
|
|
1193
|
+
/** The created subproperty. */
|
|
1194
|
+
subproperty?: GoogleAnalyticsAdminV1alphaProperty;
|
|
1195
|
+
/** The created subproperty event filter. */
|
|
1196
|
+
subpropertyEventFilter?: GoogleAnalyticsAdminV1alphaSubpropertyEventFilter;
|
|
1197
|
+
}
|
|
1198
1198
|
interface GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest {
|
|
1199
1199
|
/** Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list. */
|
|
1200
1200
|
eventEditRules?: string[];
|
|
@@ -7492,60 +7492,6 @@ declare namespace gapi.client {
|
|
|
7492
7492
|
},
|
|
7493
7493
|
body: GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest
|
|
7494
7494
|
): Request<GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse>;
|
|
7495
|
-
/** Create a subproperty and a subproperty event filter that applies to the created subproperty. */
|
|
7496
|
-
createSubproperty(request: {
|
|
7497
|
-
/** V1 error format. */
|
|
7498
|
-
'$.xgafv'?: string;
|
|
7499
|
-
/** OAuth access token. */
|
|
7500
|
-
access_token?: string;
|
|
7501
|
-
/** Data format for response. */
|
|
7502
|
-
alt?: string;
|
|
7503
|
-
/** JSONP */
|
|
7504
|
-
callback?: string;
|
|
7505
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
7506
|
-
fields?: string;
|
|
7507
|
-
/** 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. */
|
|
7508
|
-
key?: string;
|
|
7509
|
-
/** OAuth 2.0 token for the current user. */
|
|
7510
|
-
oauth_token?: string;
|
|
7511
|
-
/** Returns response with indentations and line breaks. */
|
|
7512
|
-
prettyPrint?: boolean;
|
|
7513
|
-
/** 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. */
|
|
7514
|
-
quotaUser?: string;
|
|
7515
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7516
|
-
upload_protocol?: string;
|
|
7517
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7518
|
-
uploadType?: string;
|
|
7519
|
-
/** Request body */
|
|
7520
|
-
resource: GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest;
|
|
7521
|
-
}): Request<GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse>;
|
|
7522
|
-
createSubproperty(
|
|
7523
|
-
request: {
|
|
7524
|
-
/** V1 error format. */
|
|
7525
|
-
'$.xgafv'?: string;
|
|
7526
|
-
/** OAuth access token. */
|
|
7527
|
-
access_token?: string;
|
|
7528
|
-
/** Data format for response. */
|
|
7529
|
-
alt?: string;
|
|
7530
|
-
/** JSONP */
|
|
7531
|
-
callback?: string;
|
|
7532
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
7533
|
-
fields?: string;
|
|
7534
|
-
/** 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. */
|
|
7535
|
-
key?: string;
|
|
7536
|
-
/** OAuth 2.0 token for the current user. */
|
|
7537
|
-
oauth_token?: string;
|
|
7538
|
-
/** Returns response with indentations and line breaks. */
|
|
7539
|
-
prettyPrint?: boolean;
|
|
7540
|
-
/** 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. */
|
|
7541
|
-
quotaUser?: string;
|
|
7542
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7543
|
-
upload_protocol?: string;
|
|
7544
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7545
|
-
uploadType?: string;
|
|
7546
|
-
},
|
|
7547
|
-
body: GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest
|
|
7548
|
-
): Request<GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse>;
|
|
7549
7495
|
/** 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. */
|
|
7550
7496
|
delete(request?: {
|
|
7551
7497
|
/** V1 error format. */
|
|
@@ -7965,6 +7911,60 @@ declare namespace gapi.client {
|
|
|
7965
7911
|
},
|
|
7966
7912
|
body: GoogleAnalyticsAdminV1alphaProperty
|
|
7967
7913
|
): Request<GoogleAnalyticsAdminV1alphaProperty>;
|
|
7914
|
+
/** Create a subproperty and a subproperty event filter that applies to the created subproperty. */
|
|
7915
|
+
provisionSubproperty(request: {
|
|
7916
|
+
/** V1 error format. */
|
|
7917
|
+
'$.xgafv'?: string;
|
|
7918
|
+
/** OAuth access token. */
|
|
7919
|
+
access_token?: string;
|
|
7920
|
+
/** Data format for response. */
|
|
7921
|
+
alt?: string;
|
|
7922
|
+
/** JSONP */
|
|
7923
|
+
callback?: string;
|
|
7924
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7925
|
+
fields?: string;
|
|
7926
|
+
/** 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. */
|
|
7927
|
+
key?: string;
|
|
7928
|
+
/** OAuth 2.0 token for the current user. */
|
|
7929
|
+
oauth_token?: string;
|
|
7930
|
+
/** Returns response with indentations and line breaks. */
|
|
7931
|
+
prettyPrint?: boolean;
|
|
7932
|
+
/** 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. */
|
|
7933
|
+
quotaUser?: string;
|
|
7934
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7935
|
+
upload_protocol?: string;
|
|
7936
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7937
|
+
uploadType?: string;
|
|
7938
|
+
/** Request body */
|
|
7939
|
+
resource: GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest;
|
|
7940
|
+
}): Request<GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse>;
|
|
7941
|
+
provisionSubproperty(
|
|
7942
|
+
request: {
|
|
7943
|
+
/** V1 error format. */
|
|
7944
|
+
'$.xgafv'?: string;
|
|
7945
|
+
/** OAuth access token. */
|
|
7946
|
+
access_token?: string;
|
|
7947
|
+
/** Data format for response. */
|
|
7948
|
+
alt?: string;
|
|
7949
|
+
/** JSONP */
|
|
7950
|
+
callback?: string;
|
|
7951
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7952
|
+
fields?: string;
|
|
7953
|
+
/** 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. */
|
|
7954
|
+
key?: string;
|
|
7955
|
+
/** OAuth 2.0 token for the current user. */
|
|
7956
|
+
oauth_token?: string;
|
|
7957
|
+
/** Returns response with indentations and line breaks. */
|
|
7958
|
+
prettyPrint?: boolean;
|
|
7959
|
+
/** 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. */
|
|
7960
|
+
quotaUser?: string;
|
|
7961
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7962
|
+
upload_protocol?: string;
|
|
7963
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7964
|
+
uploadType?: string;
|
|
7965
|
+
},
|
|
7966
|
+
body: GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest
|
|
7967
|
+
): Request<GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse>;
|
|
7968
7968
|
/** 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. 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). */
|
|
7969
7969
|
runAccessReport(request: {
|
|
7970
7970
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -149,11 +149,6 @@ Create a roll-up property and all roll-up property source links.
|
|
|
149
149
|
*/
|
|
150
150
|
await gapi.client.analyticsadmin.properties.createRollupProperty({});
|
|
151
151
|
|
|
152
|
-
/*
|
|
153
|
-
Create a subproperty and a subproperty event filter that applies to the created subproperty.
|
|
154
|
-
*/
|
|
155
|
-
await gapi.client.analyticsadmin.properties.createSubproperty({});
|
|
156
|
-
|
|
157
152
|
/*
|
|
158
153
|
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.
|
|
159
154
|
*/
|
|
@@ -217,6 +212,11 @@ Updates a property.
|
|
|
217
212
|
*/
|
|
218
213
|
await gapi.client.analyticsadmin.properties.patch({name: 'name'});
|
|
219
214
|
|
|
215
|
+
/*
|
|
216
|
+
Create a subproperty and a subproperty event filter that applies to the created subproperty.
|
|
217
|
+
*/
|
|
218
|
+
await gapi.client.analyticsadmin.properties.provisionSubproperty({});
|
|
219
|
+
|
|
220
220
|
/*
|
|
221
221
|
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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. 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).
|
|
222
222
|
*/
|