@maxim_mazurok/gapi.client.analyticsadmin-v1beta 0.0.20250124 → 0.0.20250129
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 +29 -29
- package/package.json +1 -1
- package/readme.md +2 -2
package/index.d.ts
CHANGED
|
@@ -9,14 +9,14 @@
|
|
|
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: 20250129
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
16
16
|
declare namespace gapi.client {
|
|
17
17
|
/** Load Google Analytics Admin API v1beta */
|
|
18
18
|
function load(
|
|
19
|
-
urlOrObject: 'https://analyticsadmin.googleapis.com/$discovery/rest?version=v1beta'
|
|
19
|
+
urlOrObject: 'https://analyticsadmin.googleapis.com/$discovery/rest?version=v1beta',
|
|
20
20
|
): Promise<void>;
|
|
21
21
|
/** @deprecated Please load APIs with discovery documents. */
|
|
22
22
|
function load(name: 'analyticsadmin', version: 'v1beta'): Promise<void>;
|
|
@@ -24,7 +24,7 @@ declare namespace gapi.client {
|
|
|
24
24
|
function load(
|
|
25
25
|
name: 'analyticsadmin',
|
|
26
26
|
version: 'v1beta',
|
|
27
|
-
callback: () => any
|
|
27
|
+
callback: () => any,
|
|
28
28
|
): void;
|
|
29
29
|
|
|
30
30
|
namespace analyticsadmin {
|
|
@@ -751,7 +751,7 @@ declare namespace gapi.client {
|
|
|
751
751
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
752
752
|
uploadType?: string;
|
|
753
753
|
},
|
|
754
|
-
body: GoogleAnalyticsAdminV1betaAccount
|
|
754
|
+
body: GoogleAnalyticsAdminV1betaAccount,
|
|
755
755
|
): Request<GoogleAnalyticsAdminV1betaAccount>;
|
|
756
756
|
/** Requests a ticket for creating an account. */
|
|
757
757
|
provisionAccountTicket(request: {
|
|
@@ -805,7 +805,7 @@ declare namespace gapi.client {
|
|
|
805
805
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
806
806
|
uploadType?: string;
|
|
807
807
|
},
|
|
808
|
-
body: GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest
|
|
808
|
+
body: GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest,
|
|
809
809
|
): Request<GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse>;
|
|
810
810
|
/** 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 GA UI Reporting, GA UI Explorations, GA 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). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. */
|
|
811
811
|
runAccessReport(request: {
|
|
@@ -863,7 +863,7 @@ declare namespace gapi.client {
|
|
|
863
863
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
864
864
|
uploadType?: string;
|
|
865
865
|
},
|
|
866
|
-
body: GoogleAnalyticsAdminV1betaRunAccessReportRequest
|
|
866
|
+
body: GoogleAnalyticsAdminV1betaRunAccessReportRequest,
|
|
867
867
|
): Request<GoogleAnalyticsAdminV1betaRunAccessReportResponse>;
|
|
868
868
|
/** Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes. */
|
|
869
869
|
searchChangeHistoryEvents(request: {
|
|
@@ -921,7 +921,7 @@ declare namespace gapi.client {
|
|
|
921
921
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
922
922
|
uploadType?: string;
|
|
923
923
|
},
|
|
924
|
-
body: GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest
|
|
924
|
+
body: GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest,
|
|
925
925
|
): Request<GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse>;
|
|
926
926
|
}
|
|
927
927
|
interface AccountSummariesResource {
|
|
@@ -1012,7 +1012,7 @@ declare namespace gapi.client {
|
|
|
1012
1012
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1013
1013
|
uploadType?: string;
|
|
1014
1014
|
},
|
|
1015
|
-
body: GoogleAnalyticsAdminV1betaConversionEvent
|
|
1015
|
+
body: GoogleAnalyticsAdminV1betaConversionEvent,
|
|
1016
1016
|
): Request<GoogleAnalyticsAdminV1betaConversionEvent>;
|
|
1017
1017
|
/** Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property. */
|
|
1018
1018
|
delete(request?: {
|
|
@@ -1159,7 +1159,7 @@ declare namespace gapi.client {
|
|
|
1159
1159
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1160
1160
|
uploadType?: string;
|
|
1161
1161
|
},
|
|
1162
|
-
body: GoogleAnalyticsAdminV1betaConversionEvent
|
|
1162
|
+
body: GoogleAnalyticsAdminV1betaConversionEvent,
|
|
1163
1163
|
): Request<GoogleAnalyticsAdminV1betaConversionEvent>;
|
|
1164
1164
|
}
|
|
1165
1165
|
interface CustomDimensionsResource {
|
|
@@ -1219,7 +1219,7 @@ declare namespace gapi.client {
|
|
|
1219
1219
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1220
1220
|
uploadType?: string;
|
|
1221
1221
|
},
|
|
1222
|
-
body: GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest
|
|
1222
|
+
body: GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest,
|
|
1223
1223
|
): Request<{}>;
|
|
1224
1224
|
/** Creates a CustomDimension. */
|
|
1225
1225
|
create(request: {
|
|
@@ -1277,7 +1277,7 @@ declare namespace gapi.client {
|
|
|
1277
1277
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1278
1278
|
uploadType?: string;
|
|
1279
1279
|
},
|
|
1280
|
-
body: GoogleAnalyticsAdminV1betaCustomDimension
|
|
1280
|
+
body: GoogleAnalyticsAdminV1betaCustomDimension,
|
|
1281
1281
|
): Request<GoogleAnalyticsAdminV1betaCustomDimension>;
|
|
1282
1282
|
/** Lookup for a single CustomDimension. */
|
|
1283
1283
|
get(request?: {
|
|
@@ -1397,7 +1397,7 @@ declare namespace gapi.client {
|
|
|
1397
1397
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1398
1398
|
uploadType?: string;
|
|
1399
1399
|
},
|
|
1400
|
-
body: GoogleAnalyticsAdminV1betaCustomDimension
|
|
1400
|
+
body: GoogleAnalyticsAdminV1betaCustomDimension,
|
|
1401
1401
|
): Request<GoogleAnalyticsAdminV1betaCustomDimension>;
|
|
1402
1402
|
}
|
|
1403
1403
|
interface CustomMetricsResource {
|
|
@@ -1457,7 +1457,7 @@ declare namespace gapi.client {
|
|
|
1457
1457
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1458
1458
|
uploadType?: string;
|
|
1459
1459
|
},
|
|
1460
|
-
body: GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest
|
|
1460
|
+
body: GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest,
|
|
1461
1461
|
): Request<{}>;
|
|
1462
1462
|
/** Creates a CustomMetric. */
|
|
1463
1463
|
create(request: {
|
|
@@ -1515,7 +1515,7 @@ declare namespace gapi.client {
|
|
|
1515
1515
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1516
1516
|
uploadType?: string;
|
|
1517
1517
|
},
|
|
1518
|
-
body: GoogleAnalyticsAdminV1betaCustomMetric
|
|
1518
|
+
body: GoogleAnalyticsAdminV1betaCustomMetric,
|
|
1519
1519
|
): Request<GoogleAnalyticsAdminV1betaCustomMetric>;
|
|
1520
1520
|
/** Lookup for a single CustomMetric. */
|
|
1521
1521
|
get(request?: {
|
|
@@ -1635,7 +1635,7 @@ declare namespace gapi.client {
|
|
|
1635
1635
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1636
1636
|
uploadType?: string;
|
|
1637
1637
|
},
|
|
1638
|
-
body: GoogleAnalyticsAdminV1betaCustomMetric
|
|
1638
|
+
body: GoogleAnalyticsAdminV1betaCustomMetric,
|
|
1639
1639
|
): Request<GoogleAnalyticsAdminV1betaCustomMetric>;
|
|
1640
1640
|
}
|
|
1641
1641
|
interface MeasurementProtocolSecretsResource {
|
|
@@ -1695,7 +1695,7 @@ declare namespace gapi.client {
|
|
|
1695
1695
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1696
1696
|
uploadType?: string;
|
|
1697
1697
|
},
|
|
1698
|
-
body: GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
|
|
1698
|
+
body: GoogleAnalyticsAdminV1betaMeasurementProtocolSecret,
|
|
1699
1699
|
): Request<GoogleAnalyticsAdminV1betaMeasurementProtocolSecret>;
|
|
1700
1700
|
/** Deletes target MeasurementProtocolSecret. */
|
|
1701
1701
|
delete(request?: {
|
|
@@ -1842,7 +1842,7 @@ declare namespace gapi.client {
|
|
|
1842
1842
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1843
1843
|
uploadType?: string;
|
|
1844
1844
|
},
|
|
1845
|
-
body: GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
|
|
1845
|
+
body: GoogleAnalyticsAdminV1betaMeasurementProtocolSecret,
|
|
1846
1846
|
): Request<GoogleAnalyticsAdminV1betaMeasurementProtocolSecret>;
|
|
1847
1847
|
}
|
|
1848
1848
|
interface DataStreamsResource {
|
|
@@ -1902,7 +1902,7 @@ declare namespace gapi.client {
|
|
|
1902
1902
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1903
1903
|
uploadType?: string;
|
|
1904
1904
|
},
|
|
1905
|
-
body: GoogleAnalyticsAdminV1betaDataStream
|
|
1905
|
+
body: GoogleAnalyticsAdminV1betaDataStream,
|
|
1906
1906
|
): Request<GoogleAnalyticsAdminV1betaDataStream>;
|
|
1907
1907
|
/** Deletes a DataStream on a property. */
|
|
1908
1908
|
delete(request?: {
|
|
@@ -2049,7 +2049,7 @@ declare namespace gapi.client {
|
|
|
2049
2049
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2050
2050
|
uploadType?: string;
|
|
2051
2051
|
},
|
|
2052
|
-
body: GoogleAnalyticsAdminV1betaDataStream
|
|
2052
|
+
body: GoogleAnalyticsAdminV1betaDataStream,
|
|
2053
2053
|
): Request<GoogleAnalyticsAdminV1betaDataStream>;
|
|
2054
2054
|
measurementProtocolSecrets: MeasurementProtocolSecretsResource;
|
|
2055
2055
|
}
|
|
@@ -2110,7 +2110,7 @@ declare namespace gapi.client {
|
|
|
2110
2110
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2111
2111
|
uploadType?: string;
|
|
2112
2112
|
},
|
|
2113
|
-
body: GoogleAnalyticsAdminV1betaFirebaseLink
|
|
2113
|
+
body: GoogleAnalyticsAdminV1betaFirebaseLink,
|
|
2114
2114
|
): Request<GoogleAnalyticsAdminV1betaFirebaseLink>;
|
|
2115
2115
|
/** Deletes a FirebaseLink on a property */
|
|
2116
2116
|
delete(request?: {
|
|
@@ -2228,7 +2228,7 @@ declare namespace gapi.client {
|
|
|
2228
2228
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2229
2229
|
uploadType?: string;
|
|
2230
2230
|
},
|
|
2231
|
-
body: GoogleAnalyticsAdminV1betaGoogleAdsLink
|
|
2231
|
+
body: GoogleAnalyticsAdminV1betaGoogleAdsLink,
|
|
2232
2232
|
): Request<GoogleAnalyticsAdminV1betaGoogleAdsLink>;
|
|
2233
2233
|
/** Deletes a GoogleAdsLink on a property */
|
|
2234
2234
|
delete(request?: {
|
|
@@ -2348,7 +2348,7 @@ declare namespace gapi.client {
|
|
|
2348
2348
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2349
2349
|
uploadType?: string;
|
|
2350
2350
|
},
|
|
2351
|
-
body: GoogleAnalyticsAdminV1betaGoogleAdsLink
|
|
2351
|
+
body: GoogleAnalyticsAdminV1betaGoogleAdsLink,
|
|
2352
2352
|
): Request<GoogleAnalyticsAdminV1betaGoogleAdsLink>;
|
|
2353
2353
|
}
|
|
2354
2354
|
interface KeyEventsResource {
|
|
@@ -2408,7 +2408,7 @@ declare namespace gapi.client {
|
|
|
2408
2408
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2409
2409
|
uploadType?: string;
|
|
2410
2410
|
},
|
|
2411
|
-
body: GoogleAnalyticsAdminV1betaKeyEvent
|
|
2411
|
+
body: GoogleAnalyticsAdminV1betaKeyEvent,
|
|
2412
2412
|
): Request<GoogleAnalyticsAdminV1betaKeyEvent>;
|
|
2413
2413
|
/** Deletes a Key Event. */
|
|
2414
2414
|
delete(request?: {
|
|
@@ -2555,7 +2555,7 @@ declare namespace gapi.client {
|
|
|
2555
2555
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2556
2556
|
uploadType?: string;
|
|
2557
2557
|
},
|
|
2558
|
-
body: GoogleAnalyticsAdminV1betaKeyEvent
|
|
2558
|
+
body: GoogleAnalyticsAdminV1betaKeyEvent,
|
|
2559
2559
|
): Request<GoogleAnalyticsAdminV1betaKeyEvent>;
|
|
2560
2560
|
}
|
|
2561
2561
|
interface PropertiesResource {
|
|
@@ -2615,7 +2615,7 @@ declare namespace gapi.client {
|
|
|
2615
2615
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2616
2616
|
uploadType?: string;
|
|
2617
2617
|
},
|
|
2618
|
-
body: GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest
|
|
2618
|
+
body: GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest,
|
|
2619
2619
|
): Request<{}>;
|
|
2620
2620
|
/** Creates a Google Analytics property with the specified location and attributes. */
|
|
2621
2621
|
create(request: {
|
|
@@ -2669,7 +2669,7 @@ declare namespace gapi.client {
|
|
|
2669
2669
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2670
2670
|
uploadType?: string;
|
|
2671
2671
|
},
|
|
2672
|
-
body: GoogleAnalyticsAdminV1betaProperty
|
|
2672
|
+
body: GoogleAnalyticsAdminV1betaProperty,
|
|
2673
2673
|
): Request<GoogleAnalyticsAdminV1betaProperty>;
|
|
2674
2674
|
/** 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. */
|
|
2675
2675
|
delete(request?: {
|
|
@@ -2845,7 +2845,7 @@ declare namespace gapi.client {
|
|
|
2845
2845
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2846
2846
|
uploadType?: string;
|
|
2847
2847
|
},
|
|
2848
|
-
body: GoogleAnalyticsAdminV1betaProperty
|
|
2848
|
+
body: GoogleAnalyticsAdminV1betaProperty,
|
|
2849
2849
|
): Request<GoogleAnalyticsAdminV1betaProperty>;
|
|
2850
2850
|
/** 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 GA UI Reporting, GA UI Explorations, GA 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). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. */
|
|
2851
2851
|
runAccessReport(request: {
|
|
@@ -2903,7 +2903,7 @@ declare namespace gapi.client {
|
|
|
2903
2903
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2904
2904
|
uploadType?: string;
|
|
2905
2905
|
},
|
|
2906
|
-
body: GoogleAnalyticsAdminV1betaRunAccessReportRequest
|
|
2906
|
+
body: GoogleAnalyticsAdminV1betaRunAccessReportRequest,
|
|
2907
2907
|
): Request<GoogleAnalyticsAdminV1betaRunAccessReportResponse>;
|
|
2908
2908
|
/** Updates the singleton data retention settings for this property. */
|
|
2909
2909
|
updateDataRetentionSettings(request: {
|
|
@@ -2965,7 +2965,7 @@ declare namespace gapi.client {
|
|
|
2965
2965
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2966
2966
|
uploadType?: string;
|
|
2967
2967
|
},
|
|
2968
|
-
body: GoogleAnalyticsAdminV1betaDataRetentionSettings
|
|
2968
|
+
body: GoogleAnalyticsAdminV1betaDataRetentionSettings,
|
|
2969
2969
|
): Request<GoogleAnalyticsAdminV1betaDataRetentionSettings>;
|
|
2970
2970
|
conversionEvents: ConversionEventsResource;
|
|
2971
2971
|
customDimensions: CustomDimensionsResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED