@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230301 → 0.0.20230304
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 +17 -156
- package/package.json +1 -1
- package/readme.md +0 -10
- package/tests.ts +1 -14
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: 20230304
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -562,12 +562,6 @@ declare namespace gapi.client {
|
|
|
562
562
|
*/
|
|
563
563
|
userActorEmail?: string;
|
|
564
564
|
}
|
|
565
|
-
interface GoogleAnalyticsAdminV1alphaConnectedSiteTag {
|
|
566
|
-
/** Required. User-provided display name for the connected site tag. Must be less than 256 characters. */
|
|
567
|
-
displayName?: string;
|
|
568
|
-
/** Required. Measurement ID to forward events to. Also known as “G-ID” (For example: G-12345). */
|
|
569
|
-
measurementId?: string;
|
|
570
|
-
}
|
|
571
565
|
interface GoogleAnalyticsAdminV1alphaConversionEvent {
|
|
572
566
|
/** Output only. Time when this conversion event was created in the property. */
|
|
573
567
|
createTime?: string;
|
|
@@ -708,15 +702,6 @@ declare namespace gapi.client {
|
|
|
708
702
|
/** Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} */
|
|
709
703
|
name?: string;
|
|
710
704
|
}
|
|
711
|
-
interface GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest {
|
|
712
|
-
/** The measurement ID of the tag to remove from the Universal Analytics property. Also known as "G-ID". Example: "G-12345" */
|
|
713
|
-
measurementId?: string;
|
|
714
|
-
/**
|
|
715
|
-
* The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example:
|
|
716
|
-
* properties/1234
|
|
717
|
-
*/
|
|
718
|
-
property?: string;
|
|
719
|
-
}
|
|
720
705
|
interface GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest {
|
|
721
706
|
/** Required. Example format: accounts/1234/userLinks/5678 */
|
|
722
707
|
name?: string;
|
|
@@ -930,26 +915,6 @@ declare namespace gapi.client {
|
|
|
930
915
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
931
916
|
nextPageToken?: string;
|
|
932
917
|
}
|
|
933
|
-
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest {
|
|
934
|
-
/**
|
|
935
|
-
* 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.
|
|
936
|
-
* The maximum value is 200; (higher values will be coerced to the maximum)
|
|
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.
|
|
942
|
-
*/
|
|
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
|
-
property?: string;
|
|
946
|
-
}
|
|
947
|
-
interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse {
|
|
948
|
-
/** The site tags for the Universal Analytics property */
|
|
949
|
-
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
|
-
}
|
|
953
918
|
interface GoogleAnalyticsAdminV1alphaListConversionEventsResponse {
|
|
954
919
|
/** The requested conversion events */
|
|
955
920
|
conversionEvents?: GoogleAnalyticsAdminV1alphaConversionEvent[];
|
|
@@ -1346,8 +1311,8 @@ declare namespace gapi.client {
|
|
|
1346
1311
|
/** OAuth 2.0 token for the current user. */
|
|
1347
1312
|
oauth_token?: string;
|
|
1348
1313
|
/**
|
|
1349
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
1350
|
-
* accounts/{account} - properties/{property}
|
|
1314
|
+
* 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
|
|
1315
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
1351
1316
|
*/
|
|
1352
1317
|
parent: string;
|
|
1353
1318
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1377,8 +1342,8 @@ declare namespace gapi.client {
|
|
|
1377
1342
|
/** OAuth 2.0 token for the current user. */
|
|
1378
1343
|
oauth_token?: string;
|
|
1379
1344
|
/**
|
|
1380
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
1381
|
-
* accounts/{account} - properties/{property}
|
|
1345
|
+
* 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
|
|
1346
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
1382
1347
|
*/
|
|
1383
1348
|
parent: string;
|
|
1384
1349
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1443,8 +1408,8 @@ declare namespace gapi.client {
|
|
|
1443
1408
|
/** OAuth 2.0 token for the current user. */
|
|
1444
1409
|
oauth_token?: string;
|
|
1445
1410
|
/**
|
|
1446
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
1447
|
-
* accounts/{account} - properties/{property}
|
|
1411
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
1412
|
+
* - accounts/{account} - properties/{property}
|
|
1448
1413
|
*/
|
|
1449
1414
|
parent: string;
|
|
1450
1415
|
/** Returns response with indentations and line breaks. */
|
|
@@ -1474,8 +1439,8 @@ declare namespace gapi.client {
|
|
|
1474
1439
|
/** OAuth 2.0 token for the current user. */
|
|
1475
1440
|
oauth_token?: string;
|
|
1476
1441
|
/**
|
|
1477
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
1478
|
-
* accounts/{account} - properties/{property}
|
|
1442
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
1443
|
+
* - accounts/{account} - properties/{property}
|
|
1479
1444
|
*/
|
|
1480
1445
|
parent: string;
|
|
1481
1446
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2681,8 +2646,8 @@ declare namespace gapi.client {
|
|
|
2681
2646
|
/** OAuth 2.0 token for the current user. */
|
|
2682
2647
|
oauth_token?: string;
|
|
2683
2648
|
/**
|
|
2684
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
2685
|
-
* accounts/{account} - properties/{property}
|
|
2649
|
+
* 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
|
|
2650
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
2686
2651
|
*/
|
|
2687
2652
|
parent: string;
|
|
2688
2653
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2712,8 +2677,8 @@ declare namespace gapi.client {
|
|
|
2712
2677
|
/** OAuth 2.0 token for the current user. */
|
|
2713
2678
|
oauth_token?: string;
|
|
2714
2679
|
/**
|
|
2715
|
-
* Required. The account or property that owns the access bindings. The parent field in
|
|
2716
|
-
* accounts/{account} - properties/{property}
|
|
2680
|
+
* 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
|
|
2681
|
+
* field. Formats: - accounts/{account} - properties/{property}
|
|
2717
2682
|
*/
|
|
2718
2683
|
parent: string;
|
|
2719
2684
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2778,8 +2743,8 @@ declare namespace gapi.client {
|
|
|
2778
2743
|
/** OAuth 2.0 token for the current user. */
|
|
2779
2744
|
oauth_token?: string;
|
|
2780
2745
|
/**
|
|
2781
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
2782
|
-
* accounts/{account} - properties/{property}
|
|
2746
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
2747
|
+
* - accounts/{account} - properties/{property}
|
|
2783
2748
|
*/
|
|
2784
2749
|
parent: string;
|
|
2785
2750
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2809,8 +2774,8 @@ declare namespace gapi.client {
|
|
|
2809
2774
|
/** OAuth 2.0 token for the current user. */
|
|
2810
2775
|
oauth_token?: string;
|
|
2811
2776
|
/**
|
|
2812
|
-
* Required. The account or property that owns the access bindings. The parent
|
|
2813
|
-
* accounts/{account} - properties/{property}
|
|
2777
|
+
* Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
|
|
2778
|
+
* - accounts/{account} - properties/{property}
|
|
2814
2779
|
*/
|
|
2815
2780
|
parent: string;
|
|
2816
2781
|
/** Returns response with indentations and line breaks. */
|
|
@@ -6245,58 +6210,6 @@ declare namespace gapi.client {
|
|
|
6245
6210
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6246
6211
|
uploadType?: string;
|
|
6247
6212
|
}): Request<GoogleAnalyticsAdminV1alphaProperty>;
|
|
6248
|
-
/** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
|
|
6249
|
-
deleteConnectedSiteTag(request: {
|
|
6250
|
-
/** V1 error format. */
|
|
6251
|
-
"$.xgafv"?: string;
|
|
6252
|
-
/** OAuth access token. */
|
|
6253
|
-
access_token?: string;
|
|
6254
|
-
/** Data format for response. */
|
|
6255
|
-
alt?: string;
|
|
6256
|
-
/** JSONP */
|
|
6257
|
-
callback?: string;
|
|
6258
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
6259
|
-
fields?: string;
|
|
6260
|
-
/** 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. */
|
|
6261
|
-
key?: string;
|
|
6262
|
-
/** OAuth 2.0 token for the current user. */
|
|
6263
|
-
oauth_token?: string;
|
|
6264
|
-
/** Returns response with indentations and line breaks. */
|
|
6265
|
-
prettyPrint?: boolean;
|
|
6266
|
-
/** 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. */
|
|
6267
|
-
quotaUser?: string;
|
|
6268
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6269
|
-
upload_protocol?: string;
|
|
6270
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6271
|
-
uploadType?: string;
|
|
6272
|
-
/** Request body */
|
|
6273
|
-
resource: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest;
|
|
6274
|
-
}): Request<{}>;
|
|
6275
|
-
deleteConnectedSiteTag(request: {
|
|
6276
|
-
/** V1 error format. */
|
|
6277
|
-
"$.xgafv"?: string;
|
|
6278
|
-
/** OAuth access token. */
|
|
6279
|
-
access_token?: string;
|
|
6280
|
-
/** Data format for response. */
|
|
6281
|
-
alt?: string;
|
|
6282
|
-
/** JSONP */
|
|
6283
|
-
callback?: string;
|
|
6284
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
6285
|
-
fields?: string;
|
|
6286
|
-
/** 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. */
|
|
6287
|
-
key?: string;
|
|
6288
|
-
/** OAuth 2.0 token for the current user. */
|
|
6289
|
-
oauth_token?: string;
|
|
6290
|
-
/** Returns response with indentations and line breaks. */
|
|
6291
|
-
prettyPrint?: boolean;
|
|
6292
|
-
/** 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. */
|
|
6293
|
-
quotaUser?: string;
|
|
6294
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6295
|
-
upload_protocol?: string;
|
|
6296
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6297
|
-
uploadType?: string;
|
|
6298
|
-
},
|
|
6299
|
-
body: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest): Request<{}>;
|
|
6300
6213
|
/** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
|
|
6301
6214
|
fetchAutomatedGa4ConfigurationOptOut(request: {
|
|
6302
6215
|
/** V1 error format. */
|
|
@@ -6505,58 +6418,6 @@ declare namespace gapi.client {
|
|
|
6505
6418
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6506
6419
|
uploadType?: string;
|
|
6507
6420
|
}): Request<GoogleAnalyticsAdminV1alphaListPropertiesResponse>;
|
|
6508
|
-
/** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
|
|
6509
|
-
listConnectedSiteTags(request: {
|
|
6510
|
-
/** V1 error format. */
|
|
6511
|
-
"$.xgafv"?: string;
|
|
6512
|
-
/** OAuth access token. */
|
|
6513
|
-
access_token?: string;
|
|
6514
|
-
/** Data format for response. */
|
|
6515
|
-
alt?: string;
|
|
6516
|
-
/** JSONP */
|
|
6517
|
-
callback?: string;
|
|
6518
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
6519
|
-
fields?: string;
|
|
6520
|
-
/** 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. */
|
|
6521
|
-
key?: string;
|
|
6522
|
-
/** OAuth 2.0 token for the current user. */
|
|
6523
|
-
oauth_token?: string;
|
|
6524
|
-
/** Returns response with indentations and line breaks. */
|
|
6525
|
-
prettyPrint?: boolean;
|
|
6526
|
-
/** 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. */
|
|
6527
|
-
quotaUser?: string;
|
|
6528
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6529
|
-
upload_protocol?: string;
|
|
6530
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6531
|
-
uploadType?: string;
|
|
6532
|
-
/** Request body */
|
|
6533
|
-
resource: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest;
|
|
6534
|
-
}): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
|
|
6535
|
-
listConnectedSiteTags(request: {
|
|
6536
|
-
/** V1 error format. */
|
|
6537
|
-
"$.xgafv"?: string;
|
|
6538
|
-
/** OAuth access token. */
|
|
6539
|
-
access_token?: string;
|
|
6540
|
-
/** Data format for response. */
|
|
6541
|
-
alt?: string;
|
|
6542
|
-
/** JSONP */
|
|
6543
|
-
callback?: string;
|
|
6544
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
6545
|
-
fields?: string;
|
|
6546
|
-
/** 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. */
|
|
6547
|
-
key?: string;
|
|
6548
|
-
/** OAuth 2.0 token for the current user. */
|
|
6549
|
-
oauth_token?: string;
|
|
6550
|
-
/** Returns response with indentations and line breaks. */
|
|
6551
|
-
prettyPrint?: boolean;
|
|
6552
|
-
/** 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. */
|
|
6553
|
-
quotaUser?: string;
|
|
6554
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6555
|
-
upload_protocol?: string;
|
|
6556
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6557
|
-
uploadType?: string;
|
|
6558
|
-
},
|
|
6559
|
-
body: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
|
|
6560
6421
|
/** Updates a property. */
|
|
6561
6422
|
patch(request: {
|
|
6562
6423
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -135,11 +135,6 @@ 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
|
-
|
|
143
138
|
/*
|
|
144
139
|
Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
|
|
145
140
|
*/
|
|
@@ -170,11 +165,6 @@ Returns child Properties under the specified parent Account. Only "GA4" properti
|
|
|
170
165
|
*/
|
|
171
166
|
await gapi.client.analyticsadmin.properties.list({ });
|
|
172
167
|
|
|
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
|
-
|
|
178
168
|
/*
|
|
179
169
|
Updates a property.
|
|
180
170
|
*/
|
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: 20230304
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -450,12 +450,6 @@ 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
|
-
});
|
|
459
453
|
/** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
|
|
460
454
|
await gapi.client.analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut({
|
|
461
455
|
}, {
|
|
@@ -487,13 +481,6 @@ gapi.load('client', async () => {
|
|
|
487
481
|
pageToken: "Test string",
|
|
488
482
|
showDeleted: true,
|
|
489
483
|
});
|
|
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
|
-
});
|
|
497
484
|
/** Updates a property. */
|
|
498
485
|
await gapi.client.analyticsadmin.properties.patch({
|
|
499
486
|
name: "Test string",
|