@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20240401 → 0.0.20240403

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: 20240401
+// Revision: 20240403
 
 /// <reference types="gapi.client" />
 
@@ -903,6 +903,28 @@ declare namespace gapi.client {
       /** Required. The Filter Expression that defines the Grouping Rule. */
       expression?: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression;
     }
+    interface GoogleAnalyticsAdminV1alphaKeyEvent {
+      /** Required. The method by which Key Events will be counted across multiple events within a session. */
+      countingMethod?: string;
+      /** Output only. Time when this key event was created in the property. */
+      createTime?: string;
+      /** Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property. */
+      custom?: boolean;
+      /** Optional. Defines a default value/currency for a key event. */
+      defaultValue?: GoogleAnalyticsAdminV1alphaKeyEventDefaultValue;
+      /** Output only. If set to true, this event can be deleted. */
+      deletable?: boolean;
+      /** Immutable. The event name for this key event. Examples: 'click', 'purchase' */
+      eventName?: string;
+      /** Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event} */
+      name?: string;
+    }
+    interface GoogleAnalyticsAdminV1alphaKeyEventDefaultValue {
+      /** Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information. */
+      currencyCode?: string;
+      /** Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset. */
+      numericValue?: number;
+    }
     interface GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails {
       /** Output only. The source of this proposal. */
       linkProposalInitiatingProduct?: string;
@@ -1027,6 +1049,12 @@ declare namespace gapi.client {
       /** 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 GoogleAnalyticsAdminV1alphaListKeyEventsResponse {
+      /** The requested Key Events */
+      keyEvents?: GoogleAnalyticsAdminV1alphaKeyEvent[];
+      /** 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 GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse {
       /** A list of secrets for the parent stream specified in the request. */
       measurementProtocolSecrets?: GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret[];
@@ -6040,6 +6068,213 @@ declare namespace gapi.client {
         body: GoogleAnalyticsAdminV1alphaGoogleAdsLink
       ): Request<GoogleAnalyticsAdminV1alphaGoogleAdsLink>;
     }
+    interface KeyEventsResource {
+      /** Creates a Key Event. */
+      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. The resource name of the parent property where this Key Event will be created. Format: properties/123 */
+        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: GoogleAnalyticsAdminV1alphaKeyEvent;
+      }): Request<GoogleAnalyticsAdminV1alphaKeyEvent>;
+      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. The resource name of the parent property where this Key Event will be created. Format: properties/123 */
+          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: GoogleAnalyticsAdminV1alphaKeyEvent
+      ): Request<GoogleAnalyticsAdminV1alphaKeyEvent>;
+      /** Deletes a Key Event. */
+      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. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" */
+        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<{}>;
+      /** Retrieve a single Key Event. */
+      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 resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" */
+        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<GoogleAnalyticsAdminV1alphaKeyEvent>;
+      /** Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found. */
+      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 `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. */
+        pageToken?: string;
+        /** Required. The resource name of the parent property. Example: 'properties/123' */
+        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<GoogleAnalyticsAdminV1alphaListKeyEventsResponse>;
+      /** Updates a Key Event. */
+      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 of this key event. Format: properties/{property}/keyEvents/{key_event} */
+        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: GoogleAnalyticsAdminV1alphaKeyEvent;
+      }): Request<GoogleAnalyticsAdminV1alphaKeyEvent>;
+      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 of this key event. Format: properties/{property}/keyEvents/{key_event} */
+          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: GoogleAnalyticsAdminV1alphaKeyEvent
+      ): Request<GoogleAnalyticsAdminV1alphaKeyEvent>;
+    }
     interface RollupPropertySourceLinksResource {
       /** Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. */
       create(request: {
@@ -7606,6 +7841,7 @@ declare namespace gapi.client {
       expandedDataSets: ExpandedDataSetsResource;
       firebaseLinks: FirebaseLinksResource;
       googleAdsLinks: GoogleAdsLinksResource;
+      keyEvents: KeyEventsResource;
       rollupPropertySourceLinks: RollupPropertySourceLinksResource;
       searchAds360Links: SearchAds360LinksResource;
       subpropertyEventFilters: SubpropertyEventFiltersResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
-  "version": "0.0.20240401",
+  "version": "0.0.20240403",
   "description": "TypeScript typings for Google Analytics Admin API v1alpha",
   "repository": {
     "type": "git",