@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230223 → 0.0.20230228
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 +143 -4
- package/package.json +1 -1
- package/readme.md +10 -0
- package/tests.ts +14 -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: 20230228
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -560,6 +560,12 @@ declare namespace gapi.client {
|
|
|
560
560
|
*/
|
|
561
561
|
userActorEmail?: string;
|
|
562
562
|
}
|
|
563
|
+
interface GoogleAnalyticsAdminV1alphaConnectedSiteTag {
|
|
564
|
+
/** Required. User-provided display name for the connected site tag. Must be less than 256 characters. */
|
|
565
|
+
displayName?: string;
|
|
566
|
+
/** Required. Measurement ID to forward events to. Also known as “G-ID” (For example: G-12345). */
|
|
567
|
+
measurementId?: string;
|
|
568
|
+
}
|
|
563
569
|
interface GoogleAnalyticsAdminV1alphaConversionEvent {
|
|
564
570
|
/** Output only. Time when this conversion event was created in the property. */
|
|
565
571
|
createTime?: string;
|
|
@@ -569,7 +575,7 @@ declare namespace gapi.client {
|
|
|
569
575
|
* number of custom conversion events that may be created per property.
|
|
570
576
|
*/
|
|
571
577
|
custom?: boolean;
|
|
572
|
-
/** Output only. If set, this event can currently be deleted
|
|
578
|
+
/** Output only. If set, this event can currently be deleted with DeleteConversionEvent. */
|
|
573
579
|
deletable?: boolean;
|
|
574
580
|
/** Immutable. The event name for this conversion event. Examples: 'click', 'purchase' */
|
|
575
581
|
eventName?: string;
|
|
@@ -700,6 +706,15 @@ declare namespace gapi.client {
|
|
|
700
706
|
/** Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} */
|
|
701
707
|
name?: string;
|
|
702
708
|
}
|
|
709
|
+
interface GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest {
|
|
710
|
+
/** The measurement ID of the tag to remove from the Universal Analytics property. Also known as "G-ID". Example: "G-12345" */
|
|
711
|
+
measurementId?: string;
|
|
712
|
+
/**
|
|
713
|
+
* The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example:
|
|
714
|
+
* properties/1234
|
|
715
|
+
*/
|
|
716
|
+
property?: string;
|
|
717
|
+
}
|
|
703
718
|
interface GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest {
|
|
704
719
|
/** Required. Example format: accounts/1234/userLinks/5678 */
|
|
705
720
|
name?: string;
|
|
@@ -913,6 +928,26 @@ declare namespace gapi.client {
|
|
|
913
928
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
914
929
|
nextPageToken?: string;
|
|
915
930
|
}
|
|
931
|
+
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest {
|
|
932
|
+
/**
|
|
933
|
+
* 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.
|
|
934
|
+
* The maximum value is 200; (higher values will be coerced to the maximum)
|
|
935
|
+
*/
|
|
936
|
+
pageSize?: number;
|
|
937
|
+
/**
|
|
938
|
+
* A page token, received from a previous `ListConnectedSiteTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
939
|
+
* `ListConnectedSiteTags` must match the call that provided the page token.
|
|
940
|
+
*/
|
|
941
|
+
pageToken?: string;
|
|
942
|
+
/** The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. Format: `properties/1234` */
|
|
943
|
+
property?: string;
|
|
944
|
+
}
|
|
945
|
+
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse {
|
|
946
|
+
/** The site tags for the Universal Analytics property */
|
|
947
|
+
connectedSiteTags?: GoogleAnalyticsAdminV1alphaConnectedSiteTag[];
|
|
948
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
949
|
+
nextPageToken?: string;
|
|
950
|
+
}
|
|
916
951
|
interface GoogleAnalyticsAdminV1alphaListConversionEventsResponse {
|
|
917
952
|
/** The requested conversion events */
|
|
918
953
|
conversionEvents?: GoogleAnalyticsAdminV1alphaConversionEvent[];
|
|
@@ -1038,7 +1073,7 @@ declare namespace gapi.client {
|
|
|
1038
1073
|
parent?: string;
|
|
1039
1074
|
/**
|
|
1040
1075
|
* Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.
|
|
1041
|
-
* "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created
|
|
1076
|
+
* "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created with the Google Analytics Admin API.
|
|
1042
1077
|
*/
|
|
1043
1078
|
propertyType?: string;
|
|
1044
1079
|
/** Output only. The Google Analytics service level that applies to this property. */
|
|
@@ -1067,7 +1102,7 @@ declare namespace gapi.client {
|
|
|
1067
1102
|
interface GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest {
|
|
1068
1103
|
/** The account to create. */
|
|
1069
1104
|
account?: GoogleAnalyticsAdminV1alphaAccount;
|
|
1070
|
-
/** Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in
|
|
1105
|
+
/** Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. */
|
|
1071
1106
|
redirectUri?: string;
|
|
1072
1107
|
}
|
|
1073
1108
|
interface GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse {
|
|
@@ -6208,6 +6243,58 @@ declare namespace gapi.client {
|
|
|
6208
6243
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6209
6244
|
uploadType?: string;
|
|
6210
6245
|
}): Request<GoogleAnalyticsAdminV1alphaProperty>;
|
|
6246
|
+
/** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
|
|
6247
|
+
deleteConnectedSiteTag(request: {
|
|
6248
|
+
/** V1 error format. */
|
|
6249
|
+
"$.xgafv"?: string;
|
|
6250
|
+
/** OAuth access token. */
|
|
6251
|
+
access_token?: string;
|
|
6252
|
+
/** Data format for response. */
|
|
6253
|
+
alt?: string;
|
|
6254
|
+
/** JSONP */
|
|
6255
|
+
callback?: string;
|
|
6256
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6257
|
+
fields?: string;
|
|
6258
|
+
/** 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. */
|
|
6259
|
+
key?: string;
|
|
6260
|
+
/** OAuth 2.0 token for the current user. */
|
|
6261
|
+
oauth_token?: string;
|
|
6262
|
+
/** Returns response with indentations and line breaks. */
|
|
6263
|
+
prettyPrint?: boolean;
|
|
6264
|
+
/** 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. */
|
|
6265
|
+
quotaUser?: string;
|
|
6266
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6267
|
+
upload_protocol?: string;
|
|
6268
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6269
|
+
uploadType?: string;
|
|
6270
|
+
/** Request body */
|
|
6271
|
+
resource: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest;
|
|
6272
|
+
}): Request<{}>;
|
|
6273
|
+
deleteConnectedSiteTag(request: {
|
|
6274
|
+
/** V1 error format. */
|
|
6275
|
+
"$.xgafv"?: string;
|
|
6276
|
+
/** OAuth access token. */
|
|
6277
|
+
access_token?: string;
|
|
6278
|
+
/** Data format for response. */
|
|
6279
|
+
alt?: string;
|
|
6280
|
+
/** JSONP */
|
|
6281
|
+
callback?: string;
|
|
6282
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6283
|
+
fields?: string;
|
|
6284
|
+
/** 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. */
|
|
6285
|
+
key?: string;
|
|
6286
|
+
/** OAuth 2.0 token for the current user. */
|
|
6287
|
+
oauth_token?: string;
|
|
6288
|
+
/** Returns response with indentations and line breaks. */
|
|
6289
|
+
prettyPrint?: boolean;
|
|
6290
|
+
/** 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. */
|
|
6291
|
+
quotaUser?: string;
|
|
6292
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6293
|
+
upload_protocol?: string;
|
|
6294
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6295
|
+
uploadType?: string;
|
|
6296
|
+
},
|
|
6297
|
+
body: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest): Request<{}>;
|
|
6211
6298
|
/** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
|
|
6212
6299
|
fetchAutomatedGa4ConfigurationOptOut(request: {
|
|
6213
6300
|
/** V1 error format. */
|
|
@@ -6416,6 +6503,58 @@ declare namespace gapi.client {
|
|
|
6416
6503
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6417
6504
|
uploadType?: string;
|
|
6418
6505
|
}): Request<GoogleAnalyticsAdminV1alphaListPropertiesResponse>;
|
|
6506
|
+
/** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
|
|
6507
|
+
listConnectedSiteTags(request: {
|
|
6508
|
+
/** V1 error format. */
|
|
6509
|
+
"$.xgafv"?: string;
|
|
6510
|
+
/** OAuth access token. */
|
|
6511
|
+
access_token?: string;
|
|
6512
|
+
/** Data format for response. */
|
|
6513
|
+
alt?: string;
|
|
6514
|
+
/** JSONP */
|
|
6515
|
+
callback?: string;
|
|
6516
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6517
|
+
fields?: string;
|
|
6518
|
+
/** 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. */
|
|
6519
|
+
key?: string;
|
|
6520
|
+
/** OAuth 2.0 token for the current user. */
|
|
6521
|
+
oauth_token?: string;
|
|
6522
|
+
/** Returns response with indentations and line breaks. */
|
|
6523
|
+
prettyPrint?: boolean;
|
|
6524
|
+
/** 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. */
|
|
6525
|
+
quotaUser?: string;
|
|
6526
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6527
|
+
upload_protocol?: string;
|
|
6528
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6529
|
+
uploadType?: string;
|
|
6530
|
+
/** Request body */
|
|
6531
|
+
resource: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest;
|
|
6532
|
+
}): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
|
|
6533
|
+
listConnectedSiteTags(request: {
|
|
6534
|
+
/** V1 error format. */
|
|
6535
|
+
"$.xgafv"?: string;
|
|
6536
|
+
/** OAuth access token. */
|
|
6537
|
+
access_token?: string;
|
|
6538
|
+
/** Data format for response. */
|
|
6539
|
+
alt?: string;
|
|
6540
|
+
/** JSONP */
|
|
6541
|
+
callback?: string;
|
|
6542
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6543
|
+
fields?: string;
|
|
6544
|
+
/** 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. */
|
|
6545
|
+
key?: string;
|
|
6546
|
+
/** OAuth 2.0 token for the current user. */
|
|
6547
|
+
oauth_token?: string;
|
|
6548
|
+
/** Returns response with indentations and line breaks. */
|
|
6549
|
+
prettyPrint?: boolean;
|
|
6550
|
+
/** 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. */
|
|
6551
|
+
quotaUser?: string;
|
|
6552
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6553
|
+
upload_protocol?: string;
|
|
6554
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6555
|
+
uploadType?: string;
|
|
6556
|
+
},
|
|
6557
|
+
body: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
|
|
6419
6558
|
/** Updates a property. */
|
|
6420
6559
|
patch(request: {
|
|
6421
6560
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -135,6 +135,11 @@ Marks target Property as soft-deleted (ie: "trashed") and returns it. This API d
|
|
|
135
135
|
*/
|
|
136
136
|
await gapi.client.analyticsadmin.properties.delete({ name: "name", });
|
|
137
137
|
|
|
138
|
+
/*
|
|
139
|
+
Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
|
|
140
|
+
*/
|
|
141
|
+
await gapi.client.analyticsadmin.properties.deleteConnectedSiteTag({ });
|
|
142
|
+
|
|
138
143
|
/*
|
|
139
144
|
Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
|
|
140
145
|
*/
|
|
@@ -165,6 +170,11 @@ Returns child Properties under the specified parent Account. Only "GA4" properti
|
|
|
165
170
|
*/
|
|
166
171
|
await gapi.client.analyticsadmin.properties.list({ });
|
|
167
172
|
|
|
173
|
+
/*
|
|
174
|
+
Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property.
|
|
175
|
+
*/
|
|
176
|
+
await gapi.client.analyticsadmin.properties.listConnectedSiteTags({ });
|
|
177
|
+
|
|
168
178
|
/*
|
|
169
179
|
Updates a property.
|
|
170
180
|
*/
|
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: 20230228
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -450,6 +450,12 @@ gapi.load('client', async () => {
|
|
|
450
450
|
await gapi.client.analyticsadmin.properties.delete({
|
|
451
451
|
name: "Test string",
|
|
452
452
|
});
|
|
453
|
+
/** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
|
|
454
|
+
await gapi.client.analyticsadmin.properties.deleteConnectedSiteTag({
|
|
455
|
+
}, {
|
|
456
|
+
measurementId: "Test string",
|
|
457
|
+
property: "Test string",
|
|
458
|
+
});
|
|
453
459
|
/** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
|
|
454
460
|
await gapi.client.analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut({
|
|
455
461
|
}, {
|
|
@@ -481,6 +487,13 @@ gapi.load('client', async () => {
|
|
|
481
487
|
pageToken: "Test string",
|
|
482
488
|
showDeleted: true,
|
|
483
489
|
});
|
|
490
|
+
/** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
|
|
491
|
+
await gapi.client.analyticsadmin.properties.listConnectedSiteTags({
|
|
492
|
+
}, {
|
|
493
|
+
pageSize: 42,
|
|
494
|
+
pageToken: "Test string",
|
|
495
|
+
property: "Test string",
|
|
496
|
+
});
|
|
484
497
|
/** Updates a property. */
|
|
485
498
|
await gapi.client.analyticsadmin.properties.patch({
|
|
486
499
|
name: "Test string",
|