@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230304 → 0.0.20230308
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 +329 -1
- package/package.json +1 -1
- package/readme.md +15 -0
- package/tests.ts +42 -1
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: 20230308
|
|
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. */
|
|
@@ -562,6 +564,12 @@ declare namespace gapi.client {
|
|
|
562
564
|
*/
|
|
563
565
|
userActorEmail?: string;
|
|
564
566
|
}
|
|
567
|
+
interface GoogleAnalyticsAdminV1alphaConnectedSiteTag {
|
|
568
|
+
/** Required. User-provided display name for the connected site tag. Must be less than 256 characters. */
|
|
569
|
+
displayName?: string;
|
|
570
|
+
/** Required. "Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345). */
|
|
571
|
+
tagId?: string;
|
|
572
|
+
}
|
|
565
573
|
interface GoogleAnalyticsAdminV1alphaConversionEvent {
|
|
566
574
|
/** Output only. Time when this conversion event was created in the property. */
|
|
567
575
|
createTime?: string;
|
|
@@ -584,6 +592,18 @@ declare namespace gapi.client {
|
|
|
584
592
|
/** Required. Formats: - accounts/{account} - properties/{property} */
|
|
585
593
|
parent?: string;
|
|
586
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
|
+
}
|
|
587
607
|
interface GoogleAnalyticsAdminV1alphaCreateUserLinkRequest {
|
|
588
608
|
/** Optional. If set, then email the new user notifying them that they've been granted permissions to the resource. */
|
|
589
609
|
notifyNewUser?: boolean;
|
|
@@ -702,6 +722,15 @@ declare namespace gapi.client {
|
|
|
702
722
|
/** Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} */
|
|
703
723
|
name?: string;
|
|
704
724
|
}
|
|
725
|
+
interface GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest {
|
|
726
|
+
/**
|
|
727
|
+
* The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example:
|
|
728
|
+
* properties/1234
|
|
729
|
+
*/
|
|
730
|
+
property?: string;
|
|
731
|
+
/** Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345). */
|
|
732
|
+
tagId?: string;
|
|
733
|
+
}
|
|
705
734
|
interface GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest {
|
|
706
735
|
/** Required. Example format: accounts/1234/userLinks/5678 */
|
|
707
736
|
name?: string;
|
|
@@ -757,6 +786,36 @@ declare namespace gapi.client {
|
|
|
757
786
|
*/
|
|
758
787
|
validationEmail?: string;
|
|
759
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
|
+
}
|
|
760
819
|
interface GoogleAnalyticsAdminV1alphaExpandedDataSet {
|
|
761
820
|
/** Output only. Time when expanded data set began (or will begin) collecing data. */
|
|
762
821
|
dataCollectionStartTime?: string;
|
|
@@ -915,6 +974,17 @@ declare namespace gapi.client {
|
|
|
915
974
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
916
975
|
nextPageToken?: string;
|
|
917
976
|
}
|
|
977
|
+
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest {
|
|
978
|
+
/**
|
|
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`
|
|
981
|
+
*/
|
|
982
|
+
property?: string;
|
|
983
|
+
}
|
|
984
|
+
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse {
|
|
985
|
+
/** The site tags for the Universal Analytics property. A maximum of 20 connected site tags will be returned. */
|
|
986
|
+
connectedSiteTags?: GoogleAnalyticsAdminV1alphaConnectedSiteTag[];
|
|
987
|
+
}
|
|
918
988
|
interface GoogleAnalyticsAdminV1alphaListConversionEventsResponse {
|
|
919
989
|
/** The requested conversion events */
|
|
920
990
|
conversionEvents?: GoogleAnalyticsAdminV1alphaConversionEvent[];
|
|
@@ -4244,6 +4314,36 @@ declare namespace gapi.client {
|
|
|
4244
4314
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4245
4315
|
uploadType?: string;
|
|
4246
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>;
|
|
4247
4347
|
/** Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. */
|
|
4248
4348
|
getGlobalSiteTag(request?: {
|
|
4249
4349
|
/** V1 error format. */
|
|
@@ -4368,6 +4468,78 @@ declare namespace gapi.client {
|
|
|
4368
4468
|
uploadType?: string;
|
|
4369
4469
|
},
|
|
4370
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>;
|
|
4371
4543
|
measurementProtocolSecrets: MeasurementProtocolSecretsResource;
|
|
4372
4544
|
}
|
|
4373
4545
|
interface DisplayVideo360AdvertiserLinkProposalsResource {
|
|
@@ -6179,6 +6351,58 @@ declare namespace gapi.client {
|
|
|
6179
6351
|
uploadType?: string;
|
|
6180
6352
|
},
|
|
6181
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<{}>;
|
|
6182
6406
|
/**
|
|
6183
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
|
|
6184
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
|
|
@@ -6210,6 +6434,58 @@ declare namespace gapi.client {
|
|
|
6210
6434
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6211
6435
|
uploadType?: string;
|
|
6212
6436
|
}): Request<GoogleAnalyticsAdminV1alphaProperty>;
|
|
6437
|
+
/** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
|
|
6438
|
+
deleteConnectedSiteTag(request: {
|
|
6439
|
+
/** V1 error format. */
|
|
6440
|
+
"$.xgafv"?: string;
|
|
6441
|
+
/** OAuth access token. */
|
|
6442
|
+
access_token?: string;
|
|
6443
|
+
/** Data format for response. */
|
|
6444
|
+
alt?: string;
|
|
6445
|
+
/** JSONP */
|
|
6446
|
+
callback?: string;
|
|
6447
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6448
|
+
fields?: string;
|
|
6449
|
+
/** 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. */
|
|
6450
|
+
key?: string;
|
|
6451
|
+
/** OAuth 2.0 token for the current user. */
|
|
6452
|
+
oauth_token?: string;
|
|
6453
|
+
/** Returns response with indentations and line breaks. */
|
|
6454
|
+
prettyPrint?: boolean;
|
|
6455
|
+
/** 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. */
|
|
6456
|
+
quotaUser?: string;
|
|
6457
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6458
|
+
upload_protocol?: string;
|
|
6459
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6460
|
+
uploadType?: string;
|
|
6461
|
+
/** Request body */
|
|
6462
|
+
resource: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest;
|
|
6463
|
+
}): Request<{}>;
|
|
6464
|
+
deleteConnectedSiteTag(request: {
|
|
6465
|
+
/** V1 error format. */
|
|
6466
|
+
"$.xgafv"?: string;
|
|
6467
|
+
/** OAuth access token. */
|
|
6468
|
+
access_token?: string;
|
|
6469
|
+
/** Data format for response. */
|
|
6470
|
+
alt?: string;
|
|
6471
|
+
/** JSONP */
|
|
6472
|
+
callback?: string;
|
|
6473
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6474
|
+
fields?: string;
|
|
6475
|
+
/** 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. */
|
|
6476
|
+
key?: string;
|
|
6477
|
+
/** OAuth 2.0 token for the current user. */
|
|
6478
|
+
oauth_token?: string;
|
|
6479
|
+
/** Returns response with indentations and line breaks. */
|
|
6480
|
+
prettyPrint?: boolean;
|
|
6481
|
+
/** 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. */
|
|
6482
|
+
quotaUser?: string;
|
|
6483
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6484
|
+
upload_protocol?: string;
|
|
6485
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6486
|
+
uploadType?: string;
|
|
6487
|
+
},
|
|
6488
|
+
body: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest): Request<{}>;
|
|
6213
6489
|
/** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
|
|
6214
6490
|
fetchAutomatedGa4ConfigurationOptOut(request: {
|
|
6215
6491
|
/** V1 error format. */
|
|
@@ -6418,6 +6694,58 @@ declare namespace gapi.client {
|
|
|
6418
6694
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6419
6695
|
uploadType?: string;
|
|
6420
6696
|
}): Request<GoogleAnalyticsAdminV1alphaListPropertiesResponse>;
|
|
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. */
|
|
6698
|
+
listConnectedSiteTags(request: {
|
|
6699
|
+
/** V1 error format. */
|
|
6700
|
+
"$.xgafv"?: string;
|
|
6701
|
+
/** OAuth access token. */
|
|
6702
|
+
access_token?: string;
|
|
6703
|
+
/** Data format for response. */
|
|
6704
|
+
alt?: string;
|
|
6705
|
+
/** JSONP */
|
|
6706
|
+
callback?: string;
|
|
6707
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6708
|
+
fields?: string;
|
|
6709
|
+
/** 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. */
|
|
6710
|
+
key?: string;
|
|
6711
|
+
/** OAuth 2.0 token for the current user. */
|
|
6712
|
+
oauth_token?: string;
|
|
6713
|
+
/** Returns response with indentations and line breaks. */
|
|
6714
|
+
prettyPrint?: boolean;
|
|
6715
|
+
/** 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. */
|
|
6716
|
+
quotaUser?: string;
|
|
6717
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6718
|
+
upload_protocol?: string;
|
|
6719
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6720
|
+
uploadType?: string;
|
|
6721
|
+
/** Request body */
|
|
6722
|
+
resource: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest;
|
|
6723
|
+
}): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
|
|
6724
|
+
listConnectedSiteTags(request: {
|
|
6725
|
+
/** V1 error format. */
|
|
6726
|
+
"$.xgafv"?: string;
|
|
6727
|
+
/** OAuth access token. */
|
|
6728
|
+
access_token?: string;
|
|
6729
|
+
/** Data format for response. */
|
|
6730
|
+
alt?: string;
|
|
6731
|
+
/** JSONP */
|
|
6732
|
+
callback?: string;
|
|
6733
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6734
|
+
fields?: string;
|
|
6735
|
+
/** 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. */
|
|
6736
|
+
key?: string;
|
|
6737
|
+
/** OAuth 2.0 token for the current user. */
|
|
6738
|
+
oauth_token?: string;
|
|
6739
|
+
/** Returns response with indentations and line breaks. */
|
|
6740
|
+
prettyPrint?: boolean;
|
|
6741
|
+
/** 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. */
|
|
6742
|
+
quotaUser?: string;
|
|
6743
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6744
|
+
upload_protocol?: string;
|
|
6745
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6746
|
+
uploadType?: string;
|
|
6747
|
+
},
|
|
6748
|
+
body: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
|
|
6421
6749
|
/** Updates a property. */
|
|
6422
6750
|
patch(request: {
|
|
6423
6751
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -130,11 +130,21 @@ 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
|
*/
|
|
136
141
|
await gapi.client.analyticsadmin.properties.delete({ name: "name", });
|
|
137
142
|
|
|
143
|
+
/*
|
|
144
|
+
Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
|
|
145
|
+
*/
|
|
146
|
+
await gapi.client.analyticsadmin.properties.deleteConnectedSiteTag({ });
|
|
147
|
+
|
|
138
148
|
/*
|
|
139
149
|
Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
|
|
140
150
|
*/
|
|
@@ -165,6 +175,11 @@ Returns child Properties under the specified parent Account. Only "GA4" properti
|
|
|
165
175
|
*/
|
|
166
176
|
await gapi.client.analyticsadmin.properties.list({ });
|
|
167
177
|
|
|
178
|
+
/*
|
|
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.
|
|
180
|
+
*/
|
|
181
|
+
await gapi.client.analyticsadmin.properties.listConnectedSiteTags({ });
|
|
182
|
+
|
|
168
183
|
/*
|
|
169
184
|
Updates a property.
|
|
170
185
|
*/
|
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: 20230308
|
|
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.
|
|
@@ -450,6 +459,12 @@ gapi.load('client', async () => {
|
|
|
450
459
|
await gapi.client.analyticsadmin.properties.delete({
|
|
451
460
|
name: "Test string",
|
|
452
461
|
});
|
|
462
|
+
/** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
|
|
463
|
+
await gapi.client.analyticsadmin.properties.deleteConnectedSiteTag({
|
|
464
|
+
}, {
|
|
465
|
+
property: "Test string",
|
|
466
|
+
tagId: "Test string",
|
|
467
|
+
});
|
|
453
468
|
/** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
|
|
454
469
|
await gapi.client.analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut({
|
|
455
470
|
}, {
|
|
@@ -481,6 +496,11 @@ gapi.load('client', async () => {
|
|
|
481
496
|
pageToken: "Test string",
|
|
482
497
|
showDeleted: true,
|
|
483
498
|
});
|
|
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. */
|
|
500
|
+
await gapi.client.analyticsadmin.properties.listConnectedSiteTags({
|
|
501
|
+
}, {
|
|
502
|
+
property: "Test string",
|
|
503
|
+
});
|
|
484
504
|
/** Updates a property. */
|
|
485
505
|
await gapi.client.analyticsadmin.properties.patch({
|
|
486
506
|
name: "Test string",
|
|
@@ -1157,6 +1177,10 @@ gapi.load('client', async () => {
|
|
|
1157
1177
|
await gapi.client.analyticsadmin.properties.dataStreams.get({
|
|
1158
1178
|
name: "Test string",
|
|
1159
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
|
+
});
|
|
1160
1184
|
/** Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. */
|
|
1161
1185
|
await gapi.client.analyticsadmin.properties.dataStreams.getGlobalSiteTag({
|
|
1162
1186
|
name: "Test string",
|
|
@@ -1191,6 +1215,23 @@ gapi.load('client', async () => {
|
|
|
1191
1215
|
measurementId: "Test string",
|
|
1192
1216
|
},
|
|
1193
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
|
+
});
|
|
1194
1235
|
/** Creates a measurement protocol secret. */
|
|
1195
1236
|
await gapi.client.analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create({
|
|
1196
1237
|
parent: "Test string",
|