@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230129 → 0.0.20230131

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.
Files changed (4) hide show
  1. package/index.d.ts +128 -1
  2. package/package.json +1 -1
  3. package/readme.md +10 -0
  4. package/tests.ts +12 -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: 20230129
12
+ // Revision: 20230131
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -769,6 +769,17 @@ declare namespace gapi.client {
769
769
  /** Required. The string value to be matched against. */
770
770
  value?: string;
771
771
  }
772
+ interface GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest {
773
+ /**
774
+ * Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format:
775
+ * properties/{internalWebPropertyId} Example: properties/1234
776
+ */
777
+ property?: string;
778
+ }
779
+ interface GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse {
780
+ /** The opt out status for the UA property. */
781
+ optOut?: boolean;
782
+ }
772
783
  interface GoogleAnalyticsAdminV1alphaFirebaseLink {
773
784
  /** Output only. Time when this FirebaseLink was originally created. */
774
785
  createTime?: string;
@@ -1117,6 +1128,18 @@ declare namespace gapi.client {
1117
1128
  /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1118
1129
  nextPageToken?: string;
1119
1130
  }
1131
+ interface GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest {
1132
+ /** The status to set. */
1133
+ optOut?: boolean;
1134
+ /**
1135
+ * Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format:
1136
+ * properties/{internalWebPropertyId} Example: properties/1234
1137
+ */
1138
+ property?: string;
1139
+ }
1140
+ // tslint:disable-next-line:no-empty-interface
1141
+ interface GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse {
1142
+ }
1120
1143
  interface GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest {
1121
1144
  /** Required. The user link to update. */
1122
1145
  userLink?: GoogleAnalyticsAdminV1alphaUserLink;
@@ -4965,6 +4988,58 @@ declare namespace gapi.client {
4965
4988
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4966
4989
  uploadType?: string;
4967
4990
  }): Request<GoogleAnalyticsAdminV1alphaProperty>;
4991
+ /** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
4992
+ fetchAutomatedGa4ConfigurationOptOut(request: {
4993
+ /** V1 error format. */
4994
+ "$.xgafv"?: string;
4995
+ /** OAuth access token. */
4996
+ access_token?: string;
4997
+ /** Data format for response. */
4998
+ alt?: string;
4999
+ /** JSONP */
5000
+ callback?: string;
5001
+ /** Selector specifying which fields to include in a partial response. */
5002
+ fields?: string;
5003
+ /** 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. */
5004
+ key?: string;
5005
+ /** OAuth 2.0 token for the current user. */
5006
+ oauth_token?: string;
5007
+ /** Returns response with indentations and line breaks. */
5008
+ prettyPrint?: boolean;
5009
+ /** 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. */
5010
+ quotaUser?: string;
5011
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5012
+ upload_protocol?: string;
5013
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5014
+ uploadType?: string;
5015
+ /** Request body */
5016
+ resource: GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest;
5017
+ }): Request<GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse>;
5018
+ fetchAutomatedGa4ConfigurationOptOut(request: {
5019
+ /** V1 error format. */
5020
+ "$.xgafv"?: string;
5021
+ /** OAuth access token. */
5022
+ access_token?: string;
5023
+ /** Data format for response. */
5024
+ alt?: string;
5025
+ /** JSONP */
5026
+ callback?: string;
5027
+ /** Selector specifying which fields to include in a partial response. */
5028
+ fields?: string;
5029
+ /** 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. */
5030
+ key?: string;
5031
+ /** OAuth 2.0 token for the current user. */
5032
+ oauth_token?: string;
5033
+ /** Returns response with indentations and line breaks. */
5034
+ prettyPrint?: boolean;
5035
+ /** 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. */
5036
+ quotaUser?: string;
5037
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5038
+ upload_protocol?: string;
5039
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5040
+ uploadType?: string;
5041
+ },
5042
+ body: GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest): Request<GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse>;
4968
5043
  /** Lookup for a single "GA4" Property. */
4969
5044
  get(request?: {
4970
5045
  /** V1 error format. */
@@ -5249,6 +5324,58 @@ declare namespace gapi.client {
5249
5324
  uploadType?: string;
5250
5325
  },
5251
5326
  body: GoogleAnalyticsAdminV1alphaRunAccessReportRequest): Request<GoogleAnalyticsAdminV1alphaRunAccessReportResponse>;
5327
+ /** Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
5328
+ setAutomatedGa4ConfigurationOptOut(request: {
5329
+ /** V1 error format. */
5330
+ "$.xgafv"?: string;
5331
+ /** OAuth access token. */
5332
+ access_token?: string;
5333
+ /** Data format for response. */
5334
+ alt?: string;
5335
+ /** JSONP */
5336
+ callback?: string;
5337
+ /** Selector specifying which fields to include in a partial response. */
5338
+ fields?: string;
5339
+ /** 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. */
5340
+ key?: string;
5341
+ /** OAuth 2.0 token for the current user. */
5342
+ oauth_token?: string;
5343
+ /** Returns response with indentations and line breaks. */
5344
+ prettyPrint?: boolean;
5345
+ /** 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. */
5346
+ quotaUser?: string;
5347
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5348
+ upload_protocol?: string;
5349
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5350
+ uploadType?: string;
5351
+ /** Request body */
5352
+ resource: GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest;
5353
+ }): Request<{}>;
5354
+ setAutomatedGa4ConfigurationOptOut(request: {
5355
+ /** V1 error format. */
5356
+ "$.xgafv"?: string;
5357
+ /** OAuth access token. */
5358
+ access_token?: string;
5359
+ /** Data format for response. */
5360
+ alt?: string;
5361
+ /** JSONP */
5362
+ callback?: string;
5363
+ /** Selector specifying which fields to include in a partial response. */
5364
+ fields?: string;
5365
+ /** 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. */
5366
+ key?: string;
5367
+ /** OAuth 2.0 token for the current user. */
5368
+ oauth_token?: string;
5369
+ /** Returns response with indentations and line breaks. */
5370
+ prettyPrint?: boolean;
5371
+ /** 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. */
5372
+ quotaUser?: string;
5373
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5374
+ upload_protocol?: string;
5375
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5376
+ uploadType?: string;
5377
+ },
5378
+ body: GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest): Request<{}>;
5252
5379
  /** Updates attribution settings on a property. */
5253
5380
  updateAttributionSettings(request: {
5254
5381
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
3
- "version": "0.0.20230129",
3
+ "version": "0.0.20230131",
4
4
  "description": "TypeScript typings for Google Analytics Admin API v1alpha",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -130,6 +130,11 @@ Marks target Property as soft-deleted (ie: "trashed") and returns it. This API d
130
130
  */
131
131
  await gapi.client.analyticsadmin.properties.delete({ name: "name", });
132
132
 
133
+ /*
134
+ Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
135
+ */
136
+ await gapi.client.analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut({ });
137
+
133
138
  /*
134
139
  Lookup for a single "GA4" Property.
135
140
  */
@@ -165,6 +170,11 @@ Returns a customized report of data access records. The report provides records
165
170
  */
166
171
  await gapi.client.analyticsadmin.properties.runAccessReport({ entity: "entity", });
167
172
 
173
+ /*
174
+ Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
175
+ */
176
+ await gapi.client.analyticsadmin.properties.setAutomatedGa4ConfigurationOptOut({ });
177
+
168
178
  /*
169
179
  Updates attribution settings on 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: 20230129
6
+ // Revision: 20230131
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -242,6 +242,11 @@ gapi.load('client', async () => {
242
242
  await gapi.client.analyticsadmin.properties.delete({
243
243
  name: "Test string",
244
244
  });
245
+ /** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
246
+ await gapi.client.analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut({
247
+ }, {
248
+ property: "Test string",
249
+ });
245
250
  /** Lookup for a single "GA4" Property. */
246
251
  await gapi.client.analyticsadmin.properties.get({
247
252
  name: "Test string",
@@ -410,6 +415,12 @@ gapi.load('client', async () => {
410
415
  returnEntityQuota: true,
411
416
  timeZone: "Test string",
412
417
  });
418
+ /** Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
419
+ await gapi.client.analyticsadmin.properties.setAutomatedGa4ConfigurationOptOut({
420
+ }, {
421
+ optOut: true,
422
+ property: "Test string",
423
+ });
413
424
  /** Updates attribution settings on a property. */
414
425
  await gapi.client.analyticsadmin.properties.updateAttributionSettings({
415
426
  name: "Test string",