google-apis-analyticsadmin_v1alpha 0.71.0 → 0.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fb9d6c7ad96a05d733d2c0d77e18972e793b4565cafe899afb7cd44c9303d45
-  data.tar.gz: ad6bb672b7b894cb2a5565aa562b30019e074b321714eb722e22d166747ca3c5
+  metadata.gz: 595c384105d239bda5f359c48887d62ac4f77ac16fb80a7c7d792a5d5722f95c
+  data.tar.gz: 3f35c86f5f91c37061430a18aab3e2b1cde16244cba5e26e21db232a3658d02c
 SHA512:
-  metadata.gz: 3861bd78c14d342aadb629e267f3d1058203fbc462ee9bd243e083fc62f294c80f2c504bef8a4952d38882b4069d853a64450456c2496d358fb2978d564eaddd
-  data.tar.gz: 8218aee49caaf2193dae0b527b46e8f8e50f94c1285b89fad8714d7ff4c66bc332fad12d45538eb3afd0968abc7b9cd94f1021d8850866688c7dc40ffa4eb710
+  metadata.gz: cebbd962263376e5bd89c3838b2873dd4cd4af3fc5fce482e16eef479ea49863f6b219c62fb241e848048f0288c86cb3a0a25b3f2a7087525a807af52a77a8fb
+  data.tar.gz: 59e96ed8bd9a85f84b5e6bcbcb5f4fa82e849b0fe88b5748776632ae644c57810707fa2b6bf587e50c180b119daea03f4b1de91e8293bf0a50042960b708a121

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-analyticsadmin_v1alpha
 
+### v0.72.0 (2024-04-07)
+
+* Regenerated from discovery document revision 20240402
+
 ### v0.71.0 (2024-03-17)
 
 * Regenerated from discovery document revision 20240312

data/lib/google/apis/analyticsadmin_v1alpha/classes.rb

@@ -627,6 +627,13 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
+        # Output only. The URI for a Google Marketing Platform organization resource.
+        # Only set when this account is connected to a GMP organization. Format:
+        # marketingplatformadmin.googleapis.com/organizations/`org_id`
+        # Corresponds to the JSON property `gmpOrganization`
+        # @return [String]
+        attr_accessor :gmp_organization
+      
         # Output only. Resource name of this account. Format: accounts/`account` Example:
         # "accounts/100"
         # Corresponds to the JSON property `name`
@@ -652,6 +659,7 @@ module Google
           @create_time = args[:create_time] if args.key?(:create_time)
           @deleted = args[:deleted] if args.key?(:deleted)
           @display_name = args[:display_name] if args.key?(:display_name)
+          @gmp_organization = args[:gmp_organization] if args.key?(:gmp_organization)
           @name = args[:name] if args.key?(:name)
           @region_code = args[:region_code] if args.key?(:region_code)
           @update_time = args[:update_time] if args.key?(:update_time)
@@ -3782,6 +3790,100 @@ module Google
         end
       end
       
+      # A key event in a Google Analytics property.
+      class GoogleAnalyticsAdminV1alphaKeyEvent
+        include Google::Apis::Core::Hashable
+      
+        # Required. The method by which Key Events will be counted across multiple
+        # events within a session.
+        # Corresponds to the JSON property `countingMethod`
+        # @return [String]
+        attr_accessor :counting_method
+      
+        # Output only. Time when this key event was created in the property.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # 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.
+        # Corresponds to the JSON property `custom`
+        # @return [Boolean]
+        attr_accessor :custom
+        alias_method :custom?, :custom
+      
+        # Defines a default value/currency for a key event.
+        # Corresponds to the JSON property `defaultValue`
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue]
+        attr_accessor :default_value
+      
+        # Output only. If set to true, this event can be deleted.
+        # Corresponds to the JSON property `deletable`
+        # @return [Boolean]
+        attr_accessor :deletable
+        alias_method :deletable?, :deletable
+      
+        # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+        # Corresponds to the JSON property `eventName`
+        # @return [String]
+        attr_accessor :event_name
+      
+        # Output only. Resource name of this key event. Format: properties/`property`/
+        # keyEvents/`key_event`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @counting_method = args[:counting_method] if args.key?(:counting_method)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @custom = args[:custom] if args.key?(:custom)
+          @default_value = args[:default_value] if args.key?(:default_value)
+          @deletable = args[:deletable] if args.key?(:deletable)
+          @event_name = args[:event_name] if args.key?(:event_name)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
+      # Defines a default value/currency for a key event.
+      class GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
+        include Google::Apis::Core::Hashable
+      
+        # 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.
+        # Corresponds to the JSON property `currencyCode`
+        # @return [String]
+        attr_accessor :currency_code
+      
+        # 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.
+        # Corresponds to the JSON property `numericValue`
+        # @return [Float]
+        attr_accessor :numeric_value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @currency_code = args[:currency_code] if args.key?(:currency_code)
+          @numeric_value = args[:numeric_value] if args.key?(:numeric_value)
+        end
+      end
+      
       # Status information for a link proposal.
       class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
         include Google::Apis::Core::Hashable
@@ -4326,6 +4428,32 @@ module Google
         end
       end
       
+      # Response message for ListKeyEvents RPC.
+      class GoogleAnalyticsAdminV1alphaListKeyEventsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The requested Key Events
+        # Corresponds to the JSON property `keyEvents`
+        # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent>]
+        attr_accessor :key_events
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @key_events = args[:key_events] if args.key?(:key_events)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for ListMeasurementProtocolSecret RPC
       class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
         include Google::Apis::Core::Hashable

data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AnalyticsadminV1alpha
       # Version of the google-apis-analyticsadmin_v1alpha gem
-      GEM_VERSION = "0.71.0"
+      GEM_VERSION = "0.72.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240312"
+      REVISION = "20240402"
     end
   end
 end

data/lib/google/apis/analyticsadmin_v1alpha/representations.rb

@@ -658,6 +658,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaKeyEvent
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -784,6 +796,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaListKeyEventsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1174,6 +1192,7 @@ module Google
           property :create_time, as: 'createTime'
           property :deleted, as: 'deleted'
           property :display_name, as: 'displayName'
+          property :gmp_organization, as: 'gmpOrganization'
           property :name, as: 'name'
           property :region_code, as: 'regionCode'
           property :update_time, as: 'updateTime'
@@ -2057,6 +2076,28 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaKeyEvent
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :counting_method, as: 'countingMethod'
+          property :create_time, as: 'createTime'
+          property :custom, as: 'custom'
+          property :default_value, as: 'defaultValue', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue::Representation
+      
+          property :deletable, as: 'deletable'
+          property :event_name, as: 'eventName'
+          property :name, as: 'name'
+        end
+      end
+      
+      class GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :currency_code, as: 'currencyCode'
+          property :numeric_value, as: 'numericValue'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2243,6 +2284,15 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaListKeyEventsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :key_events, as: 'keyEvents', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/analyticsadmin_v1alpha/service.rb

@@ -4764,6 +4764,182 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates a Key Event.
+        # @param [String] parent
+        #   Required. The resource name of the parent property where this Key Event will
+        #   be created. Format: properties/123
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] google_analytics_admin_v1alpha_key_event_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_property_key_event(parent, google_analytics_admin_v1alpha_key_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+parent}/keyEvents', options)
+          command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
+          command.request_object = google_analytics_admin_v1alpha_key_event_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes a Key Event.
+        # @param [String] name
+        #   Required. The resource name of the Key Event to delete. Format: properties/`
+        #   property`/keyEvents/`key_event` Example: "properties/123/keyEvents/456"
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_property_key_event(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieve a single Key Event.
+        # @param [String] name
+        #   Required. The resource name of the Key Event to retrieve. Format: properties/`
+        #   property`/keyEvents/`key_event` Example: "properties/123/keyEvents/456"
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_property_key_event(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Returns a list of Key Events in the specified parent property. Returns an
+        # empty list if no Key Events are found.
+        # @param [String] parent
+        #   Required. The resource name of the parent property. Example: 'properties/123'
+        # @param [Fixnum] page_size
+        #   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)
+        # @param [String] page_token
+        #   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.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_property_key_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+parent}/keyEvents', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Updates a Key Event.
+        # @param [String] name
+        #   Output only. Resource name of this key event. Format: properties/`property`/
+        #   keyEvents/`key_event`
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] google_analytics_admin_v1alpha_key_event_object
+        # @param [String] update_mask
+        #   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.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_property_key_event(name, google_analytics_admin_v1alpha_key_event_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1alpha/{+name}', options)
+          command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
+          command.request_object = google_analytics_admin_v1alpha_key_event_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsadmin_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.71.0
+  version: 0.72.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.71.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.72.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
 post_install_message: 
 rdoc_options: []