@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230923 → 0.0.20230927

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20230923
+// Revision: 20230927
 
 /// <reference types="gapi.client" />
 
@@ -698,6 +698,9 @@ declare namespace gapi.client {
             /** A snapshot of a CustomMetric resource in change history. */
             customMetric?:
                 GoogleAnalyticsAdminV1alphaCustomMetric;
+            /** A snapshot of DataRedactionSettings resource in change history. */
+            dataRedactionSettings?:
+                GoogleAnalyticsAdminV1alphaDataRedactionSettings;
             /** A snapshot of a data retention settings resource in change history. */
             dataRetentionSettings?:
                 GoogleAnalyticsAdminV1alphaDataRetentionSettings;
@@ -972,6 +975,29 @@ declare namespace gapi.client {
             scope?:
                 string;
         }
+        interface GoogleAnalyticsAdminV1alphaDataRedactionSettings {
+            /** If enabled, any event parameter or user property values that look like an email will be redacted. */
+            emailRedactionEnabled?:
+                boolean;
+            /**
+             * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example:
+             * "properties/1000/dataStreams/2000/dataRedactionSettings"
+             */
+            name?:
+                string;
+            /**
+             * The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if
+             * query_parameter_replacement_enabled is true. Keys cannot contain commas.
+             */
+            queryParameterKeys?:
+                string[];
+            /**
+             * Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be
+             * run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.
+             */
+            queryParameterRedactionEnabled?:
+                boolean;
+        }
         interface GoogleAnalyticsAdminV1alphaDataRetentionSettings {
             /** The length of time that event-level data is retained. */
             eventDataRetention?:
@@ -7470,6 +7496,48 @@ declare namespace gapi.client {
                 uploadType?:
                     string;
             }): Request<GoogleAnalyticsAdminV1alphaDataStream>;
+            /** Lookup for a single DataRedactionSettings. */
+            getDataRedactionSettings(request?: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /**
+                 * Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example:
+                 * "properties/1000/dataStreams/2000/dataRedactionSettings"
+                 */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            }): Request<GoogleAnalyticsAdminV1alphaDataRedactionSettings>;
             /** Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
             getEnhancedMeasurementSettings(request?: {
                 /** V1 error format. */
@@ -7689,6 +7757,105 @@ declare namespace gapi.client {
                     string;
             },
             body: GoogleAnalyticsAdminV1alphaDataStream): Request<GoogleAnalyticsAdminV1alphaDataStream>;
+            /** Updates a DataRedactionSettings on a property. */
+            updateDataRedactionSettings(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /**
+                 * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example:
+                 * "properties/1000/dataStreams/2000/dataRedactionSettings"
+                 */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /**
+                 * 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
+                 * one path with the string "*" to match all fields.
+                 */
+                updateMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    GoogleAnalyticsAdminV1alphaDataRedactionSettings;
+            }): Request<GoogleAnalyticsAdminV1alphaDataRedactionSettings>;
+            updateDataRedactionSettings(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /**
+                 * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example:
+                 * "properties/1000/dataStreams/2000/dataRedactionSettings"
+                 */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /**
+                 * 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
+                 * one path with the string "*" to match all fields.
+                 */
+                updateMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleAnalyticsAdminV1alphaDataRedactionSettings): Request<GoogleAnalyticsAdminV1alphaDataRedactionSettings>;
             /** Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
             updateEnhancedMeasurementSettings(request: {
                 /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
-  "version": "0.0.20230923",
+  "version": "0.0.20230927",
   "description": "TypeScript typings for Google Analytics Admin API v1alpha",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230923
+// Revision: 20230927
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1301,6 +1301,10 @@ gapi.load('client', async () => {
         await gapi.client.analyticsadmin.properties.dataStreams.get({
             name: "Test string",
         });
+        /** Lookup for a single DataRedactionSettings. */
+        await gapi.client.analyticsadmin.properties.dataStreams.getDataRedactionSettings({
+            name: "Test string",
+        });
         /** Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
         await gapi.client.analyticsadmin.properties.dataStreams.getEnhancedMeasurementSettings({
             name: "Test string",
@@ -1339,6 +1343,18 @@ gapi.load('client', async () => {
                 measurementId: "Test string",
             },
         });
+        /** Updates a DataRedactionSettings on a property. */
+        await gapi.client.analyticsadmin.properties.dataStreams.updateDataRedactionSettings({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            emailRedactionEnabled: true,
+            name: "Test string",
+            queryParameterKeys: [
+                "Test string"
+            ],
+            queryParameterRedactionEnabled: true,
+        });
         /** Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. */
         await gapi.client.analyticsadmin.properties.dataStreams.updateEnhancedMeasurementSettings({
             name: "Test string",