google-apis-analyticsadmin_v1alpha 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8997904c942768285965989f7b6b4f1a9713fa9b06b2278f13d7b04de89719ac
-  data.tar.gz: fc3b5d5c8c38d2132ef6089519c06890a47d67ecca1663257ec98cfcadca7bec
+  metadata.gz: 4d1e135a8f62f5634076cbfda434b1a4a8cabf5a934eca2b5f0958c800375ab3
+  data.tar.gz: 6b75c899052d46a087c831217589fa33cbb520e7c2f88094fd146a05a0b9ce74
 SHA512:
-  metadata.gz: 0faf70224d76cca9a2534af5dff4238fc6ece38aacb60e854cb0d53f65df78044987e20736dbd3dbed068e7996d1c023f9c05aa5bab8485022a66183aae185c0
-  data.tar.gz: 599a72810b717aff0a3a347226541090aec5409e25c169f1905f2fbeefe4cecdfa55fd4f445c96b2fdb0c68b72d4107d0491272c77587401cc44b297921e9c7d
+  metadata.gz: 88c6e8e417fc652caaa056fe909f8f1fdbc46b4fde78f79a6a2778730682be5cfc6a5d589a02686752138c9cf6ed26fc51c4f67a1b0e8b2a2d6ad6b024a01ed6
+  data.tar.gz: a6957aa1bd9b983e3113827c352d49598a79434a574af4bc257e7f4a3b0c301c0d7440510c3cf559fe06cb3d008452977bfc191aa0a0534f3c256c5e55467fe9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-analyticsadmin_v1alpha
 
+### v0.30.0 (2022-06-07)
+
+* Regenerated from discovery document revision 20220604
+* Regenerated using generator version 0.5.0
+
 ### v0.29.0 (2022-06-02)
 
 * Unspecified changes

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

@@ -209,6 +209,51 @@ module Google
         end
       end
       
+      # The attribution settings used for a given property. This is a singleton
+      # resource.
+      class GoogleAnalyticsAdminV1alphaAttributionSettings
+        include Google::Apis::Core::Hashable
+      
+        # Required. The lookback window configuration for acquisition conversion events.
+        # The default window size is 30 days.
+        # Corresponds to the JSON property `acquisitionConversionEventLookbackWindow`
+        # @return [String]
+        attr_accessor :acquisition_conversion_event_lookback_window
+      
+        # Output only. Resource name of this attribution settings resource. Format:
+        # properties/`property_id`/attributionSettings Example: "properties/1000/
+        # attributionSettings"
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Required. The lookback window for all other, non-acquisition conversion events.
+        # The default window size is 90 days.
+        # Corresponds to the JSON property `otherConversionEventLookbackWindow`
+        # @return [String]
+        attr_accessor :other_conversion_event_lookback_window
+      
+        # Required. The reporting attribution model used to calculate conversion credit
+        # in this property's reports. Changing the attribution model will apply to both
+        # historical and future data. These changes will be reflected in reports with
+        # conversion and revenue data. User and session data will be unaffected.
+        # Corresponds to the JSON property `reportingAttributionModel`
+        # @return [String]
+        attr_accessor :reporting_attribution_model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @acquisition_conversion_event_lookback_window = args[:acquisition_conversion_event_lookback_window] if args.key?(:acquisition_conversion_event_lookback_window)
+          @name = args[:name] if args.key?(:name)
+          @other_conversion_event_lookback_window = args[:other_conversion_event_lookback_window] if args.key?(:other_conversion_event_lookback_window)
+          @reporting_attribution_model = args[:reporting_attribution_model] if args.key?(:reporting_attribution_model)
+        end
+      end
+      
       # Read-only resource used to summarize a principal's effective roles.
       class GoogleAnalyticsAdminV1alphaAuditUserLink
         include Google::Apis::Core::Hashable
@@ -494,6 +539,12 @@ module Google
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount]
         attr_accessor :account
       
+        # The attribution settings used for a given property. This is a singleton
+        # resource.
+        # Corresponds to the JSON property `attributionSettings`
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
+        attr_accessor :attribution_settings
+      
         # A conversion event in a Google Analytics property.
         # Corresponds to the JSON property `conversionEvent`
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
@@ -564,6 +615,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @account = args[:account] if args.key?(:account)
+          @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
           @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
           @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
           @custom_metric = args[:custom_metric] if args.key?(:custom_metric)

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.29.0"
+      GEM_VERSION = "0.30.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.4.1"
+      GENERATOR_VERSION = "0.5.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220319"
+      REVISION = "20220604"
     end
   end
 end

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

@@ -70,6 +70,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaAttributionSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaAuditUserLink
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -456,6 +462,16 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaAttributionSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :acquisition_conversion_event_lookback_window, as: 'acquisitionConversionEventLookbackWindow'
+          property :name, as: 'name'
+          property :other_conversion_event_lookback_window, as: 'otherConversionEventLookbackWindow'
+          property :reporting_attribution_model, as: 'reportingAttributionModel'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaAuditUserLink
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -555,6 +571,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :account, as: 'account', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount::Representation
       
+          property :attribution_settings, as: 'attributionSettings', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
+      
           property :conversion_event, as: 'conversionEvent', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
       
           property :custom_dimension, as: 'customDimension', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation

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

@@ -822,6 +822,37 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Lookup for a AttributionSettings singleton.
+        # @param [String] name
+        #   Required. The name of the attribution settings to retrieve. Format: properties/
+        #   `property`/attributionSettings
+        # @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::GoogleAnalyticsAdminV1alphaAttributionSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
+        #
+        # @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_attribution_settings(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings
+          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 the singleton data retention settings for this property.
         # @param [String] name
         #   Required. The name of the settings to lookup. Format: properties/`property`/
@@ -980,6 +1011,46 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates attribution settings on a property.
+        # @param [String] name
+        #   Output only. Resource name of this attribution settings resource. Format:
+        #   properties/`property_id`/attributionSettings Example: "properties/1000/
+        #   attributionSettings"
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings] google_analytics_admin_v1alpha_attribution_settings_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::GoogleAnalyticsAdminV1alphaAttributionSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings]
+        #
+        # @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 update_property_attribution_settings(name, google_analytics_admin_v1alpha_attribution_settings_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::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
+          command.request_object = google_analytics_admin_v1alpha_attribution_settings_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAttributionSettings
+          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
+        
         # Updates the singleton data retention settings for this property.
         # @param [String] name
         #   Output only. Resource name for this DataRetentionSetting resource. Format:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsadmin_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-13 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.29.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.30.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
 post_install_message: 
 rdoc_options: []