@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230502 → 0.0.20230503

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: 20230502
+// Revision: 20230503
 
 /// <reference types="gapi.client" />
 
@@ -699,6 +699,9 @@ declare namespace gapi.client {
             /** A snapshot of EnhancedMeasurementSettings resource in change history. */
             enhancedMeasurementSettings?:
                 GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings;
+            /** A snapshot of an EventCreateRule resource in change history. */
+            eventCreateRule?:
+                GoogleAnalyticsAdminV1alphaEventCreateRule;
             /** A snapshot of an ExpandedDataSet resource in change history. */
             expandedDataSet?:
                 GoogleAnalyticsAdminV1alphaExpandedDataSet;
@@ -1139,6 +1142,26 @@ declare namespace gapi.client {
             videoEngagementEnabled?:
                 boolean;
         }
+        interface GoogleAnalyticsAdminV1alphaEventCreateRule {
+            /** Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter */
+            destinationEvent?:
+                string;
+            /** Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied. */
+            eventConditions?:
+                GoogleAnalyticsAdminV1alphaMatchingCondition[];
+            /** Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules */
+            name?:
+                string;
+            /** Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. */
+            parameterMutations?:
+                GoogleAnalyticsAdminV1alphaParameterMutation[];
+            /**
+             * If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied
+             * after the parameters have been copied.
+             */
+            sourceCopyParameters?:
+                boolean;
+        }
         interface GoogleAnalyticsAdminV1alphaExpandedDataSet {
             /** Output only. Time when expanded data set began (or will begin) collecing data. */
             dataCollectionStartTime?:
@@ -1428,6 +1451,14 @@ declare namespace gapi.client {
             nextPageToken?:
                 string;
         }
+        interface GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse {
+            /** List of EventCreateRules. These will be ordered stably, but in an arbitrary order. */
+            eventCreateRules?:
+                GoogleAnalyticsAdminV1alphaEventCreateRule[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?:
+                string;
+        }
         interface GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse {
             /** List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order. */
             expandedDataSets?:
@@ -1487,6 +1518,26 @@ declare namespace gapi.client {
             userLinks?:
                 GoogleAnalyticsAdminV1alphaUserLink[];
         }
+        interface GoogleAnalyticsAdminV1alphaMatchingCondition {
+            /** Required. The type of comparison to be applied to the value. */
+            comparisonType?:
+                string;
+            /**
+             * Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition
+             * will apply to a parameter with the specified name. This value cannot contain spaces.
+             */
+            field?:
+                string;
+            /** Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'. */
+            negated?:
+                boolean;
+            /**
+             * Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the
+             * parameter value.
+             */
+            value?:
+                string;
+        }
         interface GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret {
             /** Required. Human-readable display name for this secret. */
             displayName?:
@@ -1509,6 +1560,21 @@ declare namespace gapi.client {
             int64Value?:
                 string;
         }
+        interface GoogleAnalyticsAdminV1alphaParameterMutation {
+            /**
+             * Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters,
+             * digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+             */
+            parameter?:
+                string;
+            /**
+             * Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another
+             * parameter, use syntax like "[[other_parameter]]" For more details, see this [help center
+             * article](https://support.google.com/analytics/answer/10085872?hl=en#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+             */
+            parameterValue?:
+                string;
+        }
         interface GoogleAnalyticsAdminV1alphaProperty {
             /** Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123" */
             account?:
@@ -5896,6 +5962,308 @@ declare namespace gapi.client {
             },
             body: GoogleAnalyticsAdminV1alphaCustomMetric): Request<GoogleAnalyticsAdminV1alphaCustomMetric>;
         }
+        interface EventCreateRulesResource {
+            /** Creates an EventCreateRule. */
+            create(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;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Required. Example format: properties/123/dataStreams/456 */
+                parent:
+                    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 body */
+                resource:
+                    GoogleAnalyticsAdminV1alphaEventCreateRule;
+            }): Request<GoogleAnalyticsAdminV1alphaEventCreateRule>;
+            create(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;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Required. Example format: properties/123/dataStreams/456 */
+                parent:
+                    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;
+            },
+            body: GoogleAnalyticsAdminV1alphaEventCreateRule): Request<GoogleAnalyticsAdminV1alphaEventCreateRule>;
+            /** Deletes an EventCreateRule. */
+            delete(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. Example format: properties/123/dataStreams/456/eventCreateRules/789 */
+                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<{}>;
+            /** Lookup for a single EventCreateRule. */
+            get(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 EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789 */
+                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<GoogleAnalyticsAdminV1alphaEventCreateRule>;
+            /** Lists EventCreateRules on a web data stream. */
+            list(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;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
+                pageSize?:
+                    number;
+                /**
+                 * A page token, received from a previous `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
+                 * `ListEventCreateRules` must match the call that provided the page token.
+                 */
+                pageToken?:
+                    string;
+                /** Required. Example format: properties/123/dataStreams/456 */
+                parent:
+                    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<GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse>;
+            /** Updates an EventCreateRule. */
+            patch(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. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules */
+                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:
+                    GoogleAnalyticsAdminV1alphaEventCreateRule;
+            }): Request<GoogleAnalyticsAdminV1alphaEventCreateRule>;
+            patch(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. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules */
+                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: GoogleAnalyticsAdminV1alphaEventCreateRule): Request<GoogleAnalyticsAdminV1alphaEventCreateRule>;
+        }
         interface MeasurementProtocolSecretsResource {
             /** Creates a measurement protocol secret. */
             create(request: {
@@ -6676,6 +7044,8 @@ declare namespace gapi.client {
                     string;
             },
             body: GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings): Request<GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings>;
+            eventCreateRules:
+                EventCreateRulesResource;
             measurementProtocolSecrets:
                 MeasurementProtocolSecretsResource;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
-  "version": "0.0.20230502",
+  "version": "0.0.20230503",
   "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: 20230502
+// Revision: 20230503
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1321,6 +1321,65 @@ gapi.load('client', async () => {
             uriQueryParameter: "Test string",
             videoEngagementEnabled: true,
         });
+        /** Creates an EventCreateRule. */
+        await gapi.client.analyticsadmin.properties.dataStreams.eventCreateRules.create({
+            parent: "Test string",
+        }, {
+            destinationEvent: "Test string",
+            eventConditions: [
+                {
+                    comparisonType: "Test string",
+                    field: "Test string",
+                    negated: true,
+                    value: "Test string",
+                }
+            ],
+            name: "Test string",
+            parameterMutations: [
+                {
+                    parameter: "Test string",
+                    parameterValue: "Test string",
+                }
+            ],
+            sourceCopyParameters: true,
+        });
+        /** Deletes an EventCreateRule. */
+        await gapi.client.analyticsadmin.properties.dataStreams.eventCreateRules.delete({
+            name: "Test string",
+        });
+        /** Lookup for a single EventCreateRule. */
+        await gapi.client.analyticsadmin.properties.dataStreams.eventCreateRules.get({
+            name: "Test string",
+        });
+        /** Lists EventCreateRules on a web data stream. */
+        await gapi.client.analyticsadmin.properties.dataStreams.eventCreateRules.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates an EventCreateRule. */
+        await gapi.client.analyticsadmin.properties.dataStreams.eventCreateRules.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            destinationEvent: "Test string",
+            eventConditions: [
+                {
+                    comparisonType: "Test string",
+                    field: "Test string",
+                    negated: true,
+                    value: "Test string",
+                }
+            ],
+            name: "Test string",
+            parameterMutations: [
+                {
+                    parameter: "Test string",
+                    parameterValue: "Test string",
+                }
+            ],
+            sourceCopyParameters: true,
+        });
         /** Creates a measurement protocol secret. */
         await gapi.client.analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create({
             parent: "Test string",