@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230302 → 0.0.20230307
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 +219 -30
- package/package.json +1 -1
- package/readme.md +6 -1
- package/tests.ts +32 -4
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: 20230307
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -530,6 +530,8 @@ declare namespace gapi.client {
|
|
|
530
530
|
displayVideo360AdvertiserLink?: GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink;
|
|
531
531
|
/** A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history. */
|
|
532
532
|
displayVideo360AdvertiserLinkProposal?: GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal;
|
|
533
|
+
/** A snapshot of EnhancedMeasurementSettings resource in change history. */
|
|
534
|
+
enhancedMeasurementSettings?: GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings;
|
|
533
535
|
/** A snapshot of an ExpandedDataSet resource in change history. */
|
|
534
536
|
expandedDataSet?: GoogleAnalyticsAdminV1alphaExpandedDataSet;
|
|
535
537
|
/** A snapshot of a FirebaseLink resource in change history. */
|
|
@@ -590,6 +592,18 @@ declare namespace gapi.client {
|
|
|
590
592
|
/** Required. Formats: - accounts/{account} - properties/{property} */
|
|
591
593
|
parent?: string;
|
|
592
594
|
}
|
|
595
|
+
interface GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest {
|
|
596
|
+
/** Required. The tag to add to the Universal Analytics property */
|
|
597
|
+
connectedSiteTag?: GoogleAnalyticsAdminV1alphaConnectedSiteTag;
|
|
598
|
+
/**
|
|
599
|
+
* The Universal Analytics property to create connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example:
|
|
600
|
+
* properties/1234
|
|
601
|
+
*/
|
|
602
|
+
property?: string;
|
|
603
|
+
}
|
|
604
|
+
// tslint:disable-next-line:no-empty-interface
|
|
605
|
+
interface GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagResponse {
|
|
606
|
+
}
|
|
593
607
|
interface GoogleAnalyticsAdminV1alphaCreateUserLinkRequest {
|
|
594
608
|
/** Optional. If set, then email the new user notifying them that they've been granted permissions to the resource. */
|
|
595
609
|
notifyNewUser?: boolean;
|
|
@@ -772,6 +786,36 @@ declare namespace gapi.client {
|
|
|
772
786
|
*/
|
|
773
787
|
validationEmail?: string;
|
|
774
788
|
}
|
|
789
|
+
interface GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings {
|
|
790
|
+
/** If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension. */
|
|
791
|
+
fileDownloadsEnabled?: boolean;
|
|
792
|
+
/** If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default. */
|
|
793
|
+
formInteractionsEnabled?: boolean;
|
|
794
|
+
/**
|
|
795
|
+
* Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example:
|
|
796
|
+
* "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
|
797
|
+
*/
|
|
798
|
+
name?: string;
|
|
799
|
+
/** If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain. */
|
|
800
|
+
outboundClicksEnabled?: boolean;
|
|
801
|
+
/** If enabled, capture a page view event each time the website changes the browser history state. */
|
|
802
|
+
pageChangesEnabled?: boolean;
|
|
803
|
+
/** If enabled, capture scroll events each time a visitor gets to the bottom of a page. */
|
|
804
|
+
scrollsEnabled?: boolean;
|
|
805
|
+
/** Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty. */
|
|
806
|
+
searchQueryParameter?: string;
|
|
807
|
+
/** If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter). */
|
|
808
|
+
siteSearchEnabled?: boolean;
|
|
809
|
+
/**
|
|
810
|
+
* Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings
|
|
811
|
+
* themselves, but determines whether they are respected.
|
|
812
|
+
*/
|
|
813
|
+
streamEnabled?: boolean;
|
|
814
|
+
/** Additional URL query parameters. Max length is 1024 characters. */
|
|
815
|
+
uriQueryParameter?: string;
|
|
816
|
+
/** If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. */
|
|
817
|
+
videoEngagementEnabled?: boolean;
|
|
818
|
+
}
|
|
775
819
|
interface GoogleAnalyticsAdminV1alphaExpandedDataSet {
|
|
776
820
|
/** Output only. Time when expanded data set began (or will begin) collecing data. */
|
|
777
821
|
dataCollectionStartTime?: string;
|
|
@@ -932,23 +976,14 @@ declare namespace gapi.client {
|
|
|
932
976
|
}
|
|
933
977
|
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest {
|
|
934
978
|
/**
|
|
935
|
-
* The
|
|
936
|
-
*
|
|
937
|
-
*/
|
|
938
|
-
pageSize?: number;
|
|
939
|
-
/**
|
|
940
|
-
* A page token, received from a previous `ListConnectedSiteTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
941
|
-
* `ListConnectedSiteTags` must match the call that provided the page token.
|
|
979
|
+
* The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. A maximum of 20 connected site tags will be returned. Example Format:
|
|
980
|
+
* `properties/1234`
|
|
942
981
|
*/
|
|
943
|
-
pageToken?: string;
|
|
944
|
-
/** The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. Format: `properties/1234` */
|
|
945
982
|
property?: string;
|
|
946
983
|
}
|
|
947
984
|
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse {
|
|
948
|
-
/** The site tags for the Universal Analytics property */
|
|
985
|
+
/** The site tags for the Universal Analytics property. A maximum of 20 connected site tags will be returned. */
|
|
949
986
|
connectedSiteTags?: GoogleAnalyticsAdminV1alphaConnectedSiteTag[];
|
|
950
|
-
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
951
|
-
nextPageToken?: string;
|
|
952
987
|
}
|
|
953
988
|
interface GoogleAnalyticsAdminV1alphaListConversionEventsResponse {
|
|
954
989
|
/** The requested conversion events */
|
|
@@ -1346,8 +1381,8 @@ declare namespace gapi.client {
|
|
|
1346
1381
|
/** OAuth 2.0 token for the current user. */
|
|
1347
1382
|
oauth_token?: string;
|
|
1348
1383
|
/**
|
|
1349
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
1350
|
-
* accounts/{account} - properties/{property}
|
|
1384
|
+
* Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this
|
|
1385
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
1351
1386
|
*/
|
|
1352
1387
|
parent: string;
|
|
1353
1388
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1377,8 +1412,8 @@ declare namespace gapi.client {
|
|
|
1377
1412
|
/** OAuth 2.0 token for the current user. */
|
|
1378
1413
|
oauth_token?: string;
|
|
1379
1414
|
/**
|
|
1380
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
1381
|
-
* accounts/{account} - properties/{property}
|
|
1415
|
+
* Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this
|
|
1416
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
1382
1417
|
*/
|
|
1383
1418
|
parent: string;
|
|
1384
1419
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1443,8 +1478,8 @@ declare namespace gapi.client {
|
|
|
1443
1478
|
/** OAuth 2.0 token for the current user. */
|
|
1444
1479
|
oauth_token?: string;
|
|
1445
1480
|
/**
|
|
1446
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
1447
|
-
* accounts/{account} - properties/{property}
|
|
1481
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
1482
|
+
* - accounts/{account} - properties/{property}
|
|
1448
1483
|
*/
|
|
1449
1484
|
parent: string;
|
|
1450
1485
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1474,8 +1509,8 @@ declare namespace gapi.client {
|
|
|
1474
1509
|
/** OAuth 2.0 token for the current user. */
|
|
1475
1510
|
oauth_token?: string;
|
|
1476
1511
|
/**
|
|
1477
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
1478
|
-
* accounts/{account} - properties/{property}
|
|
1512
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
1513
|
+
* - accounts/{account} - properties/{property}
|
|
1479
1514
|
*/
|
|
1480
1515
|
parent: string;
|
|
1481
1516
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2681,8 +2716,8 @@ declare namespace gapi.client {
|
|
|
2681
2716
|
/** OAuth 2.0 token for the current user. */
|
|
2682
2717
|
oauth_token?: string;
|
|
2683
2718
|
/**
|
|
2684
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
2685
|
-
* accounts/{account} - properties/{property}
|
|
2719
|
+
* Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this
|
|
2720
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
2686
2721
|
*/
|
|
2687
2722
|
parent: string;
|
|
2688
2723
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2712,8 +2747,8 @@ declare namespace gapi.client {
|
|
|
2712
2747
|
/** OAuth 2.0 token for the current user. */
|
|
2713
2748
|
oauth_token?: string;
|
|
2714
2749
|
/**
|
|
2715
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
2716
|
-
* accounts/{account} - properties/{property}
|
|
2750
|
+
* Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this
|
|
2751
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
2717
2752
|
*/
|
|
2718
2753
|
parent: string;
|
|
2719
2754
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2778,8 +2813,8 @@ declare namespace gapi.client {
|
|
|
2778
2813
|
/** OAuth 2.0 token for the current user. */
|
|
2779
2814
|
oauth_token?: string;
|
|
2780
2815
|
/**
|
|
2781
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
2782
|
-
* accounts/{account} - properties/{property}
|
|
2816
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
2817
|
+
* - accounts/{account} - properties/{property}
|
|
2783
2818
|
*/
|
|
2784
2819
|
parent: string;
|
|
2785
2820
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2809,8 +2844,8 @@ declare namespace gapi.client {
|
|
|
2809
2844
|
/** OAuth 2.0 token for the current user. */
|
|
2810
2845
|
oauth_token?: string;
|
|
2811
2846
|
/**
|
|
2812
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
2813
|
-
* accounts/{account} - properties/{property}
|
|
2847
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
2848
|
+
* - accounts/{account} - properties/{property}
|
|
2814
2849
|
*/
|
|
2815
2850
|
parent: string;
|
|
2816
2851
|
/** Returns response with indentations and line breaks. */
|
|
@@ -4279,6 +4314,36 @@ declare namespace gapi.client {
|
|
|
4279
4314
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4280
4315
|
uploadType?: string;
|
|
4281
4316
|
}): Request<GoogleAnalyticsAdminV1alphaDataStream>;
|
|
4317
|
+
/** Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
|
|
4318
|
+
getEnhancedMeasurementSettings(request?: {
|
|
4319
|
+
/** V1 error format. */
|
|
4320
|
+
"$.xgafv"?: string;
|
|
4321
|
+
/** OAuth access token. */
|
|
4322
|
+
access_token?: string;
|
|
4323
|
+
/** Data format for response. */
|
|
4324
|
+
alt?: string;
|
|
4325
|
+
/** JSONP */
|
|
4326
|
+
callback?: string;
|
|
4327
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4328
|
+
fields?: string;
|
|
4329
|
+
/** 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. */
|
|
4330
|
+
key?: string;
|
|
4331
|
+
/**
|
|
4332
|
+
* Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example:
|
|
4333
|
+
* "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
|
4334
|
+
*/
|
|
4335
|
+
name: string;
|
|
4336
|
+
/** OAuth 2.0 token for the current user. */
|
|
4337
|
+
oauth_token?: string;
|
|
4338
|
+
/** Returns response with indentations and line breaks. */
|
|
4339
|
+
prettyPrint?: boolean;
|
|
4340
|
+
/** 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. */
|
|
4341
|
+
quotaUser?: string;
|
|
4342
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4343
|
+
upload_protocol?: string;
|
|
4344
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4345
|
+
uploadType?: string;
|
|
4346
|
+
}): Request<GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings>;
|
|
4282
4347
|
/** Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. */
|
|
4283
4348
|
getGlobalSiteTag(request?: {
|
|
4284
4349
|
/** V1 error format. */
|
|
@@ -4403,6 +4468,78 @@ declare namespace gapi.client {
|
|
|
4403
4468
|
uploadType?: string;
|
|
4404
4469
|
},
|
|
4405
4470
|
body: GoogleAnalyticsAdminV1alphaDataStream): Request<GoogleAnalyticsAdminV1alphaDataStream>;
|
|
4471
|
+
/** Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
|
|
4472
|
+
updateEnhancedMeasurementSettings(request: {
|
|
4473
|
+
/** V1 error format. */
|
|
4474
|
+
"$.xgafv"?: string;
|
|
4475
|
+
/** OAuth access token. */
|
|
4476
|
+
access_token?: string;
|
|
4477
|
+
/** Data format for response. */
|
|
4478
|
+
alt?: string;
|
|
4479
|
+
/** JSONP */
|
|
4480
|
+
callback?: string;
|
|
4481
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4482
|
+
fields?: string;
|
|
4483
|
+
/** 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. */
|
|
4484
|
+
key?: string;
|
|
4485
|
+
/**
|
|
4486
|
+
* Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example:
|
|
4487
|
+
* "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
|
4488
|
+
*/
|
|
4489
|
+
name: string;
|
|
4490
|
+
/** OAuth 2.0 token for the current user. */
|
|
4491
|
+
oauth_token?: string;
|
|
4492
|
+
/** Returns response with indentations and line breaks. */
|
|
4493
|
+
prettyPrint?: boolean;
|
|
4494
|
+
/** 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. */
|
|
4495
|
+
quotaUser?: string;
|
|
4496
|
+
/**
|
|
4497
|
+
* Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use
|
|
4498
|
+
* one path with the string "*" to match all fields.
|
|
4499
|
+
*/
|
|
4500
|
+
updateMask?: string;
|
|
4501
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4502
|
+
upload_protocol?: string;
|
|
4503
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4504
|
+
uploadType?: string;
|
|
4505
|
+
/** Request body */
|
|
4506
|
+
resource: GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings;
|
|
4507
|
+
}): Request<GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings>;
|
|
4508
|
+
updateEnhancedMeasurementSettings(request: {
|
|
4509
|
+
/** V1 error format. */
|
|
4510
|
+
"$.xgafv"?: string;
|
|
4511
|
+
/** OAuth access token. */
|
|
4512
|
+
access_token?: string;
|
|
4513
|
+
/** Data format for response. */
|
|
4514
|
+
alt?: string;
|
|
4515
|
+
/** JSONP */
|
|
4516
|
+
callback?: string;
|
|
4517
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4518
|
+
fields?: string;
|
|
4519
|
+
/** 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. */
|
|
4520
|
+
key?: string;
|
|
4521
|
+
/**
|
|
4522
|
+
* Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example:
|
|
4523
|
+
* "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
|
4524
|
+
*/
|
|
4525
|
+
name: string;
|
|
4526
|
+
/** OAuth 2.0 token for the current user. */
|
|
4527
|
+
oauth_token?: string;
|
|
4528
|
+
/** Returns response with indentations and line breaks. */
|
|
4529
|
+
prettyPrint?: boolean;
|
|
4530
|
+
/** 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. */
|
|
4531
|
+
quotaUser?: string;
|
|
4532
|
+
/**
|
|
4533
|
+
* Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use
|
|
4534
|
+
* one path with the string "*" to match all fields.
|
|
4535
|
+
*/
|
|
4536
|
+
updateMask?: string;
|
|
4537
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4538
|
+
upload_protocol?: string;
|
|
4539
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4540
|
+
uploadType?: string;
|
|
4541
|
+
},
|
|
4542
|
+
body: GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings): Request<GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings>;
|
|
4406
4543
|
measurementProtocolSecrets: MeasurementProtocolSecretsResource;
|
|
4407
4544
|
}
|
|
4408
4545
|
interface DisplayVideo360AdvertiserLinkProposalsResource {
|
|
@@ -6214,6 +6351,58 @@ declare namespace gapi.client {
|
|
|
6214
6351
|
uploadType?: string;
|
|
6215
6352
|
},
|
|
6216
6353
|
body: GoogleAnalyticsAdminV1alphaProperty): Request<GoogleAnalyticsAdminV1alphaProperty>;
|
|
6354
|
+
/** Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties. */
|
|
6355
|
+
createConnectedSiteTag(request: {
|
|
6356
|
+
/** V1 error format. */
|
|
6357
|
+
"$.xgafv"?: string;
|
|
6358
|
+
/** OAuth access token. */
|
|
6359
|
+
access_token?: string;
|
|
6360
|
+
/** Data format for response. */
|
|
6361
|
+
alt?: string;
|
|
6362
|
+
/** JSONP */
|
|
6363
|
+
callback?: string;
|
|
6364
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6365
|
+
fields?: string;
|
|
6366
|
+
/** 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. */
|
|
6367
|
+
key?: string;
|
|
6368
|
+
/** OAuth 2.0 token for the current user. */
|
|
6369
|
+
oauth_token?: string;
|
|
6370
|
+
/** Returns response with indentations and line breaks. */
|
|
6371
|
+
prettyPrint?: boolean;
|
|
6372
|
+
/** 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. */
|
|
6373
|
+
quotaUser?: string;
|
|
6374
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6375
|
+
upload_protocol?: string;
|
|
6376
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6377
|
+
uploadType?: string;
|
|
6378
|
+
/** Request body */
|
|
6379
|
+
resource: GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest;
|
|
6380
|
+
}): Request<{}>;
|
|
6381
|
+
createConnectedSiteTag(request: {
|
|
6382
|
+
/** V1 error format. */
|
|
6383
|
+
"$.xgafv"?: string;
|
|
6384
|
+
/** OAuth access token. */
|
|
6385
|
+
access_token?: string;
|
|
6386
|
+
/** Data format for response. */
|
|
6387
|
+
alt?: string;
|
|
6388
|
+
/** JSONP */
|
|
6389
|
+
callback?: string;
|
|
6390
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6391
|
+
fields?: string;
|
|
6392
|
+
/** 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. */
|
|
6393
|
+
key?: string;
|
|
6394
|
+
/** OAuth 2.0 token for the current user. */
|
|
6395
|
+
oauth_token?: string;
|
|
6396
|
+
/** Returns response with indentations and line breaks. */
|
|
6397
|
+
prettyPrint?: boolean;
|
|
6398
|
+
/** 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. */
|
|
6399
|
+
quotaUser?: string;
|
|
6400
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6401
|
+
upload_protocol?: string;
|
|
6402
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6403
|
+
uploadType?: string;
|
|
6404
|
+
},
|
|
6405
|
+
body: GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest): Request<{}>;
|
|
6217
6406
|
/**
|
|
6218
6407
|
* 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
|
|
6219
6408
|
* 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
|
|
@@ -6505,7 +6694,7 @@ declare namespace gapi.client {
|
|
|
6505
6694
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6506
6695
|
uploadType?: string;
|
|
6507
6696
|
}): Request<GoogleAnalyticsAdminV1alphaListPropertiesResponse>;
|
|
6508
|
-
/** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
|
|
6697
|
+
/** Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property. */
|
|
6509
6698
|
listConnectedSiteTags(request: {
|
|
6510
6699
|
/** V1 error format. */
|
|
6511
6700
|
"$.xgafv"?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -130,6 +130,11 @@ Creates an "GA4" property with the specified location and attributes.
|
|
|
130
130
|
*/
|
|
131
131
|
await gapi.client.analyticsadmin.properties.create({ });
|
|
132
132
|
|
|
133
|
+
/*
|
|
134
|
+
Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.
|
|
135
|
+
*/
|
|
136
|
+
await gapi.client.analyticsadmin.properties.createConnectedSiteTag({ });
|
|
137
|
+
|
|
133
138
|
/*
|
|
134
139
|
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.
|
|
135
140
|
*/
|
|
@@ -171,7 +176,7 @@ Returns child Properties under the specified parent Account. Only "GA4" properti
|
|
|
171
176
|
await gapi.client.analyticsadmin.properties.list({ });
|
|
172
177
|
|
|
173
178
|
/*
|
|
174
|
-
Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property.
|
|
179
|
+
Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.
|
|
175
180
|
*/
|
|
176
181
|
await gapi.client.analyticsadmin.properties.listConnectedSiteTags({ });
|
|
177
182
|
|
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: 20230307
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -442,6 +442,15 @@ gapi.load('client', async () => {
|
|
|
442
442
|
timeZone: "Test string",
|
|
443
443
|
updateTime: "Test string",
|
|
444
444
|
});
|
|
445
|
+
/** Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties. */
|
|
446
|
+
await gapi.client.analyticsadmin.properties.createConnectedSiteTag({
|
|
447
|
+
}, {
|
|
448
|
+
connectedSiteTag: {
|
|
449
|
+
displayName: "Test string",
|
|
450
|
+
tagId: "Test string",
|
|
451
|
+
},
|
|
452
|
+
property: "Test string",
|
|
453
|
+
});
|
|
445
454
|
/**
|
|
446
455
|
* 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
|
|
447
456
|
* 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.
|
|
@@ -487,11 +496,9 @@ gapi.load('client', async () => {
|
|
|
487
496
|
pageToken: "Test string",
|
|
488
497
|
showDeleted: true,
|
|
489
498
|
});
|
|
490
|
-
/** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
|
|
499
|
+
/** Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property. */
|
|
491
500
|
await gapi.client.analyticsadmin.properties.listConnectedSiteTags({
|
|
492
501
|
}, {
|
|
493
|
-
pageSize: 42,
|
|
494
|
-
pageToken: "Test string",
|
|
495
502
|
property: "Test string",
|
|
496
503
|
});
|
|
497
504
|
/** Updates a property. */
|
|
@@ -1170,6 +1177,10 @@ gapi.load('client', async () => {
|
|
|
1170
1177
|
await gapi.client.analyticsadmin.properties.dataStreams.get({
|
|
1171
1178
|
name: "Test string",
|
|
1172
1179
|
});
|
|
1180
|
+
/** Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
|
|
1181
|
+
await gapi.client.analyticsadmin.properties.dataStreams.getEnhancedMeasurementSettings({
|
|
1182
|
+
name: "Test string",
|
|
1183
|
+
});
|
|
1173
1184
|
/** Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. */
|
|
1174
1185
|
await gapi.client.analyticsadmin.properties.dataStreams.getGlobalSiteTag({
|
|
1175
1186
|
name: "Test string",
|
|
@@ -1204,6 +1215,23 @@ gapi.load('client', async () => {
|
|
|
1204
1215
|
measurementId: "Test string",
|
|
1205
1216
|
},
|
|
1206
1217
|
});
|
|
1218
|
+
/** Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
|
|
1219
|
+
await gapi.client.analyticsadmin.properties.dataStreams.updateEnhancedMeasurementSettings({
|
|
1220
|
+
name: "Test string",
|
|
1221
|
+
updateMask: "Test string",
|
|
1222
|
+
}, {
|
|
1223
|
+
fileDownloadsEnabled: true,
|
|
1224
|
+
formInteractionsEnabled: true,
|
|
1225
|
+
name: "Test string",
|
|
1226
|
+
outboundClicksEnabled: true,
|
|
1227
|
+
pageChangesEnabled: true,
|
|
1228
|
+
scrollsEnabled: true,
|
|
1229
|
+
searchQueryParameter: "Test string",
|
|
1230
|
+
siteSearchEnabled: true,
|
|
1231
|
+
streamEnabled: true,
|
|
1232
|
+
uriQueryParameter: "Test string",
|
|
1233
|
+
videoEngagementEnabled: true,
|
|
1234
|
+
});
|
|
1207
1235
|
/** Creates a measurement protocol secret. */
|
|
1208
1236
|
await gapi.client.analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create({
|
|
1209
1237
|
parent: "Test string",
|