@maxim_mazurok/gapi.client.analyticsadmin-v1beta 0.2.20260316 → 0.2.20260607
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 +51 -49
- package/package.json +1 -1
- package/readme.md +17 -0
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: 20260607
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -178,7 +178,7 @@ declare namespace gapi.client {
|
|
|
178
178
|
displayName?: string;
|
|
179
179
|
/** Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} */
|
|
180
180
|
gmpOrganization?: string;
|
|
181
|
-
/**
|
|
181
|
+
/** Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" */
|
|
182
182
|
name?: string;
|
|
183
183
|
/** Country of business. Must be a Unicode CLDR region code. */
|
|
184
184
|
regionCode?: string;
|
|
@@ -190,7 +190,7 @@ declare namespace gapi.client {
|
|
|
190
190
|
account?: string;
|
|
191
191
|
/** Display name for the account referred to in this account summary. */
|
|
192
192
|
displayName?: string;
|
|
193
|
-
/** Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" */
|
|
193
|
+
/** Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" */
|
|
194
194
|
name?: string;
|
|
195
195
|
/** List of summaries for child accounts of this account. */
|
|
196
196
|
propertySummaries?: GoogleAnalyticsAdminV1betaPropertySummary[];
|
|
@@ -260,7 +260,7 @@ declare namespace gapi.client {
|
|
|
260
260
|
deletable?: boolean;
|
|
261
261
|
/** Immutable. The event name for this conversion event. Examples: 'click', 'purchase' */
|
|
262
262
|
eventName?: string;
|
|
263
|
-
/**
|
|
263
|
+
/** Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} */
|
|
264
264
|
name?: string;
|
|
265
265
|
}
|
|
266
266
|
interface GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue {
|
|
@@ -276,7 +276,7 @@ declare namespace gapi.client {
|
|
|
276
276
|
disallowAdsPersonalization?: boolean;
|
|
277
277
|
/** Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. */
|
|
278
278
|
displayName?: string;
|
|
279
|
-
/**
|
|
279
|
+
/** Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} */
|
|
280
280
|
name?: string;
|
|
281
281
|
/** Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. */
|
|
282
282
|
parameterName?: string;
|
|
@@ -301,7 +301,7 @@ declare namespace gapi.client {
|
|
|
301
301
|
| 'SECONDS'
|
|
302
302
|
| 'MINUTES'
|
|
303
303
|
| 'HOURS';
|
|
304
|
-
/**
|
|
304
|
+
/** Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} */
|
|
305
305
|
name?: string;
|
|
306
306
|
/** Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. */
|
|
307
307
|
parameterName?: string;
|
|
@@ -322,7 +322,7 @@ declare namespace gapi.client {
|
|
|
322
322
|
| 'TWENTY_SIX_MONTHS'
|
|
323
323
|
| 'THIRTY_EIGHT_MONTHS'
|
|
324
324
|
| 'FIFTY_MONTHS';
|
|
325
|
-
/**
|
|
325
|
+
/** Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings */
|
|
326
326
|
name?: string;
|
|
327
327
|
/** If true, reset the retention period for the user identifier with every event from that user. */
|
|
328
328
|
resetUserDataOnNewActivity?: boolean;
|
|
@@ -336,7 +336,7 @@ declare namespace gapi.client {
|
|
|
336
336
|
| 'FIFTY_MONTHS';
|
|
337
337
|
}
|
|
338
338
|
interface GoogleAnalyticsAdminV1betaDataSharingSettings {
|
|
339
|
-
/**
|
|
339
|
+
/** Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" */
|
|
340
340
|
name?: string;
|
|
341
341
|
/** Deprecated. This field is no longer used and always returns false. */
|
|
342
342
|
sharingWithGoogleAnySalesEnabled?: boolean;
|
|
@@ -358,7 +358,7 @@ declare namespace gapi.client {
|
|
|
358
358
|
displayName?: string;
|
|
359
359
|
/** Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. */
|
|
360
360
|
iosAppStreamData?: GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData;
|
|
361
|
-
/**
|
|
361
|
+
/** Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" */
|
|
362
362
|
name?: string;
|
|
363
363
|
/** Required. Immutable. The type of this DataStream resource. */
|
|
364
364
|
type?:
|
|
@@ -394,7 +394,7 @@ declare namespace gapi.client {
|
|
|
394
394
|
interface GoogleAnalyticsAdminV1betaFirebaseLink {
|
|
395
395
|
/** Output only. Time when this FirebaseLink was originally created. */
|
|
396
396
|
createTime?: string;
|
|
397
|
-
/**
|
|
397
|
+
/** Identifier. Example format: properties/1234/firebaseLinks/5678 */
|
|
398
398
|
name?: string;
|
|
399
399
|
/** Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' */
|
|
400
400
|
project?: string;
|
|
@@ -410,7 +410,7 @@ declare namespace gapi.client {
|
|
|
410
410
|
creatorEmailAddress?: string;
|
|
411
411
|
/** Immutable. Google Ads customer ID. */
|
|
412
412
|
customerId?: string;
|
|
413
|
-
/**
|
|
413
|
+
/** Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. */
|
|
414
414
|
name?: string;
|
|
415
415
|
/** Output only. Time when this link was last updated. */
|
|
416
416
|
updateTime?: string;
|
|
@@ -509,7 +509,7 @@ declare namespace gapi.client {
|
|
|
509
509
|
interface GoogleAnalyticsAdminV1betaMeasurementProtocolSecret {
|
|
510
510
|
/** Required. Human-readable display name for this secret. */
|
|
511
511
|
displayName?: string;
|
|
512
|
-
/**
|
|
512
|
+
/** Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} */
|
|
513
513
|
name?: string;
|
|
514
514
|
/** Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. */
|
|
515
515
|
secretValue?: string;
|
|
@@ -562,7 +562,7 @@ declare namespace gapi.client {
|
|
|
562
562
|
| 'SPORTS'
|
|
563
563
|
| 'JOBS_AND_EDUCATION'
|
|
564
564
|
| 'SHOPPING';
|
|
565
|
-
/**
|
|
565
|
+
/** Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" */
|
|
566
566
|
name?: string;
|
|
567
567
|
/** Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" */
|
|
568
568
|
parent?: string;
|
|
@@ -583,6 +583,8 @@ declare namespace gapi.client {
|
|
|
583
583
|
updateTime?: string;
|
|
584
584
|
}
|
|
585
585
|
interface GoogleAnalyticsAdminV1betaPropertySummary {
|
|
586
|
+
/** If true, then the user has a Google Analytics role that permits them to edit the property. */
|
|
587
|
+
canEdit?: boolean;
|
|
586
588
|
/** Display name for the property referred to in this property summary. */
|
|
587
589
|
displayName?: string;
|
|
588
590
|
/** Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/200" */
|
|
@@ -782,9 +784,9 @@ declare namespace gapi.client {
|
|
|
782
784
|
key?: string;
|
|
783
785
|
/** OAuth 2.0 token for the current user. */
|
|
784
786
|
oauth_token?: string;
|
|
785
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
787
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
786
788
|
pageSize?: number;
|
|
787
|
-
/** A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. */
|
|
789
|
+
/** Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. */
|
|
788
790
|
pageToken?: string;
|
|
789
791
|
/** Returns response with indentations and line breaks. */
|
|
790
792
|
prettyPrint?: boolean;
|
|
@@ -811,7 +813,7 @@ declare namespace gapi.client {
|
|
|
811
813
|
fields?: string;
|
|
812
814
|
/** 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. */
|
|
813
815
|
key?: string;
|
|
814
|
-
/**
|
|
816
|
+
/** Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" */
|
|
815
817
|
name: string;
|
|
816
818
|
/** OAuth 2.0 token for the current user. */
|
|
817
819
|
oauth_token?: string;
|
|
@@ -842,7 +844,7 @@ declare namespace gapi.client {
|
|
|
842
844
|
fields?: string;
|
|
843
845
|
/** 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. */
|
|
844
846
|
key?: string;
|
|
845
|
-
/**
|
|
847
|
+
/** Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" */
|
|
846
848
|
name: string;
|
|
847
849
|
/** OAuth 2.0 token for the current user. */
|
|
848
850
|
oauth_token?: string;
|
|
@@ -1047,9 +1049,9 @@ declare namespace gapi.client {
|
|
|
1047
1049
|
key?: string;
|
|
1048
1050
|
/** OAuth 2.0 token for the current user. */
|
|
1049
1051
|
oauth_token?: string;
|
|
1050
|
-
/** The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
1052
|
+
/** Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
1051
1053
|
pageSize?: number;
|
|
1052
|
-
/** A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. */
|
|
1054
|
+
/** Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. */
|
|
1053
1055
|
pageToken?: string;
|
|
1054
1056
|
/** Returns response with indentations and line breaks. */
|
|
1055
1057
|
prettyPrint?: boolean;
|
|
@@ -1190,9 +1192,9 @@ declare namespace gapi.client {
|
|
|
1190
1192
|
key?: string;
|
|
1191
1193
|
/** OAuth 2.0 token for the current user. */
|
|
1192
1194
|
oauth_token?: string;
|
|
1193
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
1195
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
1194
1196
|
pageSize?: number;
|
|
1195
|
-
/** A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. */
|
|
1197
|
+
/** Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. */
|
|
1196
1198
|
pageToken?: string;
|
|
1197
1199
|
/** Required. The resource name of the parent property. Example: 'properties/123' */
|
|
1198
1200
|
parent: string;
|
|
@@ -1219,7 +1221,7 @@ declare namespace gapi.client {
|
|
|
1219
1221
|
fields?: string;
|
|
1220
1222
|
/** 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. */
|
|
1221
1223
|
key?: string;
|
|
1222
|
-
/**
|
|
1224
|
+
/** Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} */
|
|
1223
1225
|
name: string;
|
|
1224
1226
|
/** OAuth 2.0 token for the current user. */
|
|
1225
1227
|
oauth_token?: string;
|
|
@@ -1250,7 +1252,7 @@ declare namespace gapi.client {
|
|
|
1250
1252
|
fields?: string;
|
|
1251
1253
|
/** 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. */
|
|
1252
1254
|
key?: string;
|
|
1253
|
-
/**
|
|
1255
|
+
/** Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} */
|
|
1254
1256
|
name: string;
|
|
1255
1257
|
/** OAuth 2.0 token for the current user. */
|
|
1256
1258
|
oauth_token?: string;
|
|
@@ -1428,9 +1430,9 @@ declare namespace gapi.client {
|
|
|
1428
1430
|
key?: string;
|
|
1429
1431
|
/** OAuth 2.0 token for the current user. */
|
|
1430
1432
|
oauth_token?: string;
|
|
1431
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
1433
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
1432
1434
|
pageSize?: number;
|
|
1433
|
-
/** A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. */
|
|
1435
|
+
/** Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. */
|
|
1434
1436
|
pageToken?: string;
|
|
1435
1437
|
/** Required. Example format: properties/1234 */
|
|
1436
1438
|
parent: string;
|
|
@@ -1457,7 +1459,7 @@ declare namespace gapi.client {
|
|
|
1457
1459
|
fields?: string;
|
|
1458
1460
|
/** 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. */
|
|
1459
1461
|
key?: string;
|
|
1460
|
-
/**
|
|
1462
|
+
/** Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} */
|
|
1461
1463
|
name: string;
|
|
1462
1464
|
/** OAuth 2.0 token for the current user. */
|
|
1463
1465
|
oauth_token?: string;
|
|
@@ -1488,7 +1490,7 @@ declare namespace gapi.client {
|
|
|
1488
1490
|
fields?: string;
|
|
1489
1491
|
/** 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. */
|
|
1490
1492
|
key?: string;
|
|
1491
|
-
/**
|
|
1493
|
+
/** Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} */
|
|
1492
1494
|
name: string;
|
|
1493
1495
|
/** OAuth 2.0 token for the current user. */
|
|
1494
1496
|
oauth_token?: string;
|
|
@@ -1695,7 +1697,7 @@ declare namespace gapi.client {
|
|
|
1695
1697
|
fields?: string;
|
|
1696
1698
|
/** 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. */
|
|
1697
1699
|
key?: string;
|
|
1698
|
-
/**
|
|
1700
|
+
/** Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} */
|
|
1699
1701
|
name: string;
|
|
1700
1702
|
/** OAuth 2.0 token for the current user. */
|
|
1701
1703
|
oauth_token?: string;
|
|
@@ -1726,7 +1728,7 @@ declare namespace gapi.client {
|
|
|
1726
1728
|
fields?: string;
|
|
1727
1729
|
/** 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. */
|
|
1728
1730
|
key?: string;
|
|
1729
|
-
/**
|
|
1731
|
+
/** Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} */
|
|
1730
1732
|
name: string;
|
|
1731
1733
|
/** OAuth 2.0 token for the current user. */
|
|
1732
1734
|
oauth_token?: string;
|
|
@@ -1873,9 +1875,9 @@ declare namespace gapi.client {
|
|
|
1873
1875
|
key?: string;
|
|
1874
1876
|
/** OAuth 2.0 token for the current user. */
|
|
1875
1877
|
oauth_token?: string;
|
|
1876
|
-
/** The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. */
|
|
1878
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. */
|
|
1877
1879
|
pageSize?: number;
|
|
1878
|
-
/** A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. */
|
|
1880
|
+
/** Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. */
|
|
1879
1881
|
pageToken?: string;
|
|
1880
1882
|
/** Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets */
|
|
1881
1883
|
parent: string;
|
|
@@ -1902,7 +1904,7 @@ declare namespace gapi.client {
|
|
|
1902
1904
|
fields?: string;
|
|
1903
1905
|
/** 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. */
|
|
1904
1906
|
key?: string;
|
|
1905
|
-
/**
|
|
1907
|
+
/** Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} */
|
|
1906
1908
|
name: string;
|
|
1907
1909
|
/** OAuth 2.0 token for the current user. */
|
|
1908
1910
|
oauth_token?: string;
|
|
@@ -1933,7 +1935,7 @@ declare namespace gapi.client {
|
|
|
1933
1935
|
fields?: string;
|
|
1934
1936
|
/** 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. */
|
|
1935
1937
|
key?: string;
|
|
1936
|
-
/**
|
|
1938
|
+
/** Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} */
|
|
1937
1939
|
name: string;
|
|
1938
1940
|
/** OAuth 2.0 token for the current user. */
|
|
1939
1941
|
oauth_token?: string;
|
|
@@ -2109,7 +2111,7 @@ declare namespace gapi.client {
|
|
|
2109
2111
|
fields?: string;
|
|
2110
2112
|
/** 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. */
|
|
2111
2113
|
key?: string;
|
|
2112
|
-
/**
|
|
2114
|
+
/** Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" */
|
|
2113
2115
|
name: string;
|
|
2114
2116
|
/** OAuth 2.0 token for the current user. */
|
|
2115
2117
|
oauth_token?: string;
|
|
@@ -2140,7 +2142,7 @@ declare namespace gapi.client {
|
|
|
2140
2142
|
fields?: string;
|
|
2141
2143
|
/** 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. */
|
|
2142
2144
|
key?: string;
|
|
2143
|
-
/**
|
|
2145
|
+
/** Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" */
|
|
2144
2146
|
name: string;
|
|
2145
2147
|
/** OAuth 2.0 token for the current user. */
|
|
2146
2148
|
oauth_token?: string;
|
|
@@ -2261,9 +2263,9 @@ declare namespace gapi.client {
|
|
|
2261
2263
|
key?: string;
|
|
2262
2264
|
/** OAuth 2.0 token for the current user. */
|
|
2263
2265
|
oauth_token?: string;
|
|
2264
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2266
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2265
2267
|
pageSize?: number;
|
|
2266
|
-
/** A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. */
|
|
2268
|
+
/** Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. */
|
|
2267
2269
|
pageToken?: string;
|
|
2268
2270
|
/** Required. Format: properties/{property_id} Example: `properties/1234` */
|
|
2269
2271
|
parent: string;
|
|
@@ -2379,9 +2381,9 @@ declare namespace gapi.client {
|
|
|
2379
2381
|
key?: string;
|
|
2380
2382
|
/** OAuth 2.0 token for the current user. */
|
|
2381
2383
|
oauth_token?: string;
|
|
2382
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
2384
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
2383
2385
|
pageSize?: number;
|
|
2384
|
-
/** A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. */
|
|
2386
|
+
/** Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. */
|
|
2385
2387
|
pageToken?: string;
|
|
2386
2388
|
/** Required. Example format: properties/1234 */
|
|
2387
2389
|
parent: string;
|
|
@@ -2408,7 +2410,7 @@ declare namespace gapi.client {
|
|
|
2408
2410
|
fields?: string;
|
|
2409
2411
|
/** 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. */
|
|
2410
2412
|
key?: string;
|
|
2411
|
-
/**
|
|
2413
|
+
/** Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. */
|
|
2412
2414
|
name: string;
|
|
2413
2415
|
/** OAuth 2.0 token for the current user. */
|
|
2414
2416
|
oauth_token?: string;
|
|
@@ -2439,7 +2441,7 @@ declare namespace gapi.client {
|
|
|
2439
2441
|
fields?: string;
|
|
2440
2442
|
/** 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. */
|
|
2441
2443
|
key?: string;
|
|
2442
|
-
/**
|
|
2444
|
+
/** Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. */
|
|
2443
2445
|
name: string;
|
|
2444
2446
|
/** OAuth 2.0 token for the current user. */
|
|
2445
2447
|
oauth_token?: string;
|
|
@@ -2586,9 +2588,9 @@ declare namespace gapi.client {
|
|
|
2586
2588
|
key?: string;
|
|
2587
2589
|
/** OAuth 2.0 token for the current user. */
|
|
2588
2590
|
oauth_token?: string;
|
|
2589
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2591
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2590
2592
|
pageSize?: number;
|
|
2591
|
-
/** A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. */
|
|
2593
|
+
/** Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. */
|
|
2592
2594
|
pageToken?: string;
|
|
2593
2595
|
/** Required. The resource name of the parent property. Example: 'properties/123' */
|
|
2594
2596
|
parent: string;
|
|
@@ -2876,9 +2878,9 @@ declare namespace gapi.client {
|
|
|
2876
2878
|
key?: string;
|
|
2877
2879
|
/** OAuth 2.0 token for the current user. */
|
|
2878
2880
|
oauth_token?: string;
|
|
2879
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2881
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2880
2882
|
pageSize?: number;
|
|
2881
|
-
/** A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. */
|
|
2883
|
+
/** Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. */
|
|
2882
2884
|
pageToken?: string;
|
|
2883
2885
|
/** Returns response with indentations and line breaks. */
|
|
2884
2886
|
prettyPrint?: boolean;
|
|
@@ -2905,7 +2907,7 @@ declare namespace gapi.client {
|
|
|
2905
2907
|
fields?: string;
|
|
2906
2908
|
/** 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. */
|
|
2907
2909
|
key?: string;
|
|
2908
|
-
/**
|
|
2910
|
+
/** Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" */
|
|
2909
2911
|
name: string;
|
|
2910
2912
|
/** OAuth 2.0 token for the current user. */
|
|
2911
2913
|
oauth_token?: string;
|
|
@@ -2936,7 +2938,7 @@ declare namespace gapi.client {
|
|
|
2936
2938
|
fields?: string;
|
|
2937
2939
|
/** 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. */
|
|
2938
2940
|
key?: string;
|
|
2939
|
-
/**
|
|
2941
|
+
/** Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" */
|
|
2940
2942
|
name: string;
|
|
2941
2943
|
/** OAuth 2.0 token for the current user. */
|
|
2942
2944
|
oauth_token?: string;
|
|
@@ -3025,7 +3027,7 @@ declare namespace gapi.client {
|
|
|
3025
3027
|
fields?: string;
|
|
3026
3028
|
/** 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. */
|
|
3027
3029
|
key?: string;
|
|
3028
|
-
/**
|
|
3030
|
+
/** Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings */
|
|
3029
3031
|
name: string;
|
|
3030
3032
|
/** OAuth 2.0 token for the current user. */
|
|
3031
3033
|
oauth_token?: string;
|
|
@@ -3056,7 +3058,7 @@ declare namespace gapi.client {
|
|
|
3056
3058
|
fields?: string;
|
|
3057
3059
|
/** 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. */
|
|
3058
3060
|
key?: string;
|
|
3059
|
-
/**
|
|
3061
|
+
/** Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings */
|
|
3060
3062
|
name: string;
|
|
3061
3063
|
/** OAuth 2.0 token for the current user. */
|
|
3062
3064
|
oauth_token?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Google Analytics Admin API:
|
|
|
11
11
|
npm install @types/gapi.client.analyticsadmin-v1beta --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.analyticsadmin-v1beta"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|