google-apis-analyticsadmin_v1alpha 0.13.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438f6795ced1eca79b21b25a5d12202c630b57be62382c5624e531230612089a
-  data.tar.gz: f380cfc733d2b0e3531ee125b8ff6e099225eb64da933c6fdd6fa31476f0a023
+  metadata.gz: 2bcbf276bbbb98e5259e87065bd0a299e007088d9158fdfb339503f1a11b4e13
+  data.tar.gz: 369b8bb9dc4f0954715e3941dad8fce3e38f34bbb18f26f2f446332ea5d04011
 SHA512:
-  metadata.gz: 96b45f838263af442aa18732564fd95a8c5f8b000c683b2089041bd5c248ca3061b5b3ed075af9e17f12f104bb22d2b9faba8f35248c87e36ebe0d063891ca12
-  data.tar.gz: 5981974dc64d3963bfc0db9b9dc593472228bfbc68b8f73592b4eb41488700b92a7fff7370d3ab999549ca266b3cd721228803a8b77845acd840f573787b8f17
+  metadata.gz: 9257b7c64a02a3b28bd989544f60bbf939220330e27842deff37540831f354179ce6b6d1a7bb40c1431ab9c56f54eb5756be7aa238787a49b42ba12a05dc0716
+  data.tar.gz: 4faaa69db909ffb1328c462e3b0bcf5448ef797196727acd78550b18673835efa7e8ca8c811f269df6b00083d06c61fa345ffd509334d6b0af156ba5fcbe8262

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release history for google-apis-analyticsadmin_v1alpha
 
+### v0.17.0 (2021-10-06)
+
+* Regenerated from discovery document revision 20211005
+
+### v0.16.0 (2021-09-24)
+
+* Regenerated from discovery document revision 20210922
+
+### v0.15.0 (2021-09-17)
+
+* Regenerated from discovery document revision 20210916
+
+### v0.14.0 (2021-08-24)
+
+* Regenerated from discovery document revision 20210822
+
 ### v0.13.0 (2021-07-21)
 
 * Regenerated from discovery document revision 20210720

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

@@ -114,6 +114,43 @@ module Google
         end
       end
       
+      # Request message for AcknowledgeUserDataCollection RPC.
+      class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. An acknowledgement that the caller of this method understands the
+        # terms of user data collection. This field must contain the exact value: "I
+        # acknowledge that I have the necessary privacy disclosures and rights from my
+        # end users for the collection and processing of their data, including the
+        # association of such data with the visitation information Google Analytics
+        # collects from my site and/or app property."
+        # Corresponds to the JSON property `acknowledgement`
+        # @return [String]
+        attr_accessor :acknowledgement
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @acknowledgement = args[:acknowledgement] if args.key?(:acknowledgement)
+        end
+      end
+      
+      # Response message for AcknowledgeUserDataCollection RPC.
+      class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # A resource message representing a Google Analytics Android app stream.
       class GoogleAnalyticsAdminV1alphaAndroidAppDataStream
         include Google::Apis::Core::Hashable
@@ -231,7 +268,7 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Roles directly assigned to this user for this entity. Format: predefinedRoles/
-        # read Excludes roles that are inherited from an account (if this is for a
+        # viewer Excludes roles that are inherited from an account (if this is for a
         # property), group, or organization admin role.
         # Corresponds to the JSON property `directRoles`
         # @return [Array<String>]
@@ -239,7 +276,7 @@ module Google
       
         # Union of all permissions a user has at this account or property (includes
         # direct permissions, group-inherited permissions, etc.). Format:
-        # predefinedRoles/read
+        # predefinedRoles/viewer
         # Corresponds to the JSON property `effectiveRoles`
         # @return [Array<String>]
         attr_accessor :effective_roles
@@ -531,6 +568,11 @@ module Google
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
         attr_accessor :custom_metric
       
+        # Settings values for data retention. This is a singleton resource.
+        # Corresponds to the JSON property `dataRetentionSettings`
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
+        attr_accessor :data_retention_settings
+      
         # A link between a GA4 property and a Display & Video 360 advertiser.
         # Corresponds to the JSON property `displayVideo360AdvertiserLink`
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink]
@@ -590,6 +632,7 @@ module Google
           @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_retention_settings = args[:data_retention_settings] if args.key?(:data_retention_settings)
           @display_video360_advertiser_link = args[:display_video360_advertiser_link] if args.key?(:display_video360_advertiser_link)
           @display_video360_advertiser_link_proposal = args[:display_video360_advertiser_link_proposal] if args.key?(:display_video360_advertiser_link_proposal)
           @firebase_link = args[:firebase_link] if args.key?(:firebase_link)
@@ -868,6 +911,40 @@ module Google
         end
       end
       
+      # Settings values for data retention. This is a singleton resource.
+      class GoogleAnalyticsAdminV1alphaDataRetentionSettings
+        include Google::Apis::Core::Hashable
+      
+        # The length of time that event-level data is retained.
+        # Corresponds to the JSON property `eventDataRetention`
+        # @return [String]
+        attr_accessor :event_data_retention
+      
+        # Output only. Resource name for this DataRetentionSetting resource. Format:
+        # properties/`property`/dataRetentionSettings
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # If true, reset the retention period for the user identifier with every event
+        # from that user.
+        # Corresponds to the JSON property `resetUserDataOnNewActivity`
+        # @return [Boolean]
+        attr_accessor :reset_user_data_on_new_activity
+        alias_method :reset_user_data_on_new_activity?, :reset_user_data_on_new_activity
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @event_data_retention = args[:event_data_retention] if args.key?(:event_data_retention)
+          @name = args[:name] if args.key?(:name)
+          @reset_user_data_on_new_activity = args[:reset_user_data_on_new_activity] if args.key?(:reset_user_data_on_new_activity)
+        end
+      end
+      
       # A resource message representing data sharing settings of a Google Analytics
       # account.
       class GoogleAnalyticsAdminV1alphaDataSharingSettings
@@ -1867,6 +1944,12 @@ module Google
       class GoogleAnalyticsAdminV1alphaProperty
         include Google::Apis::Core::Hashable
       
+        # Immutable. The resource name of the parent account Format: accounts/`
+        # account_id` Example: "accounts/123"
+        # Corresponds to the JSON property `account`
+        # @return [String]
+        attr_accessor :account
+      
         # Output only. Time when the entity was originally created.
         # Corresponds to the JSON property `createTime`
         # @return [String]
@@ -1940,6 +2023,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @account = args[:account] if args.key?(:account)
           @create_time = args[:create_time] if args.key?(:create_time)
           @currency_code = args[:currency_code] if args.key?(:currency_code)
           @delete_time = args[:delete_time] if args.key?(:delete_time)
@@ -2147,10 +2231,11 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Roles directly assigned to this user for this account or property. Valid
-        # values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit
-        # predefinedRoles/manage-users Excludes roles that are inherited from a higher-
-        # level entity, group, or organization admin role. A UserLink that is updated to
-        # have an empty list of direct_roles will be deleted.
+        # values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor
+        # predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-
+        # data Excludes roles that are inherited from a higher-level entity, group, or
+        # organization admin role. A UserLink that is updated to have an empty list of
+        # direct_roles will be deleted.
         # Corresponds to the JSON property `directRoles`
         # @return [Array<String>]
         attr_accessor :direct_roles

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.13.0"
+      GEM_VERSION = "0.17.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210720"
+      REVISION = "20211005"
     end
   end
 end

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

@@ -34,6 +34,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaAndroidAppDataStream
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -166,6 +178,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaDataRetentionSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaDataSharingSettings
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -411,6 +429,19 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :acknowledgement, as: 'acknowledgement'
+        end
+      end
+      
+      class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaAndroidAppDataStream
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -556,6 +587,8 @@ module Google
       
           property :custom_metric, as: 'customMetric', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
       
+          property :data_retention_settings, as: 'dataRetentionSettings', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
+      
           property :display_video360_advertiser_link, as: 'displayVideo360AdvertiserLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink::Representation
       
           property :display_video360_advertiser_link_proposal, as: 'displayVideo360AdvertiserLinkProposal', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal::Representation
@@ -635,6 +668,15 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaDataRetentionSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :event_data_retention, as: 'eventDataRetention'
+          property :name, as: 'name'
+          property :reset_user_data_on_new_activity, as: 'resetUserDataOnNewActivity'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaDataSharingSettings
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -906,6 +948,7 @@ module Google
       class GoogleAnalyticsAdminV1alphaProperty
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :account, as: 'account'
           property :create_time, as: 'createTime'
           property :currency_code, as: 'currencyCode'
           property :delete_time, as: 'deleteTime'

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

@@ -689,6 +689,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Acknowledges the terms of user data collection for the specified property.
+        # This acknowledgement must be completed (either in the Google Analytics UI or
+        # via this API) before MeasurementProtocolSecret resources may be created.
+        # @param [String] property
+        #   Required. The property for which to acknowledge user data collection.
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest] google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_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::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse]
+        #
+        # @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 acknowledge_property_user_data_collection(property, google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+property}:acknowledgeUserDataCollection', options)
+          command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest::Representation
+          command.request_object = google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
+          command.params['property'] = property unless property.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 an "GA4" property with the specified location and attributes.
         # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
         # @param [String] fields
@@ -787,6 +822,37 @@ module Google
           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`/
+        #   dataRetentionSettings Example: "properties/1000/dataRetentionSettings"
+        # @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::GoogleAnalyticsAdminV1alphaDataRetentionSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
+        #
+        # @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_data_retention_settings(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings
+          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
+        
         # Lookup for Google Signals settings for a property.
         # @param [String] name
         #   Required. The name of the google signals settings to retrieve. Format:
@@ -912,6 +978,45 @@ module Google
           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:
+        #   properties/`property`/dataRetentionSettings
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings] google_analytics_admin_v1alpha_data_retention_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::GoogleAnalyticsAdminV1alphaDataRetentionSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
+        #
+        # @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_data_retention_settings(name, google_analytics_admin_v1alpha_data_retention_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::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
+          command.request_object = google_analytics_admin_v1alpha_data_retention_settings_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings
+          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 Google Signals settings for a property.
         # @param [String] name
         #   Output only. Resource name of this setting. Format: properties/`property_id`/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsadmin_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-10-11 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/master/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.13.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsadmin_v1alpha
 post_install_message: 
 rdoc_options: []