google-apis-analyticsadmin_v1alpha 0.12.0 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 56bfbda3eb904d697531e5e1d544aefa110e6822610ec762efc87ca95110e93a
4
- data.tar.gz: e0ef818819c346342c7b38ae4dc8928cdf0b5c8093b7a525966d377710c84954
3
+ metadata.gz: 580adde5d146df811d804e48bdbb795a5d6385c63899db3e7bab8819397b9965
4
+ data.tar.gz: 392ddad13e21dd7b5344ff495c4c8b61a52498a3bfa80e5c61f750379440c9ec
5
5
  SHA512:
6
- metadata.gz: 245e82745214aef0a5c7dfe5ef4ad0b13d599e665a363e704fc7157a09c486d8a764ad17a85c8894cacb7ddbcf0288a78b8391856c071b2e899c0a116b19925d
7
- data.tar.gz: eaf70c87465fe5ce9ffe1cebc2f5d8e3182bdfbd91976d1ff5c38b428403cd6f54cc08543759b27be1542741d24bcd916c8ac7f6d0eed26d9e7bbee5f49ebbfe
6
+ metadata.gz: f610d66bdab64b44a4832dea1a9f3507cd583a19db2a6fb7b3606fb61d320517953ba9fc02d3de1817859e8dfe2312030fa0d41f4c58f439c1689d55dc842fa0
7
+ data.tar.gz: 5ecf13a77732892293b1cb7599e56e0fb0704b11478fa28c9cb2d98af15d4df3460413dab37ff537f8cff598c9e9a4ead90dccba01ec9ce6678d526925c4426a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.16.0 (2021-09-24)
4
+
5
+ * Regenerated from discovery document revision 20210922
6
+
7
+ ### v0.15.0 (2021-09-17)
8
+
9
+ * Regenerated from discovery document revision 20210916
10
+
11
+ ### v0.14.0 (2021-08-24)
12
+
13
+ * Regenerated from discovery document revision 20210822
14
+
15
+ ### v0.13.0 (2021-07-21)
16
+
17
+ * Regenerated from discovery document revision 20210720
18
+
3
19
  ### v0.12.0 (2021-07-14)
4
20
 
5
21
  * Regenerated from discovery document revision 20210712
@@ -531,6 +531,11 @@ module Google
531
531
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
532
532
  attr_accessor :custom_metric
533
533
 
534
+ # Settings values for data retention. This is a singleton resource.
535
+ # Corresponds to the JSON property `dataRetentionSettings`
536
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
537
+ attr_accessor :data_retention_settings
538
+
534
539
  # A link between a GA4 property and a Display & Video 360 advertiser.
535
540
  # Corresponds to the JSON property `displayVideo360AdvertiserLink`
536
541
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink]
@@ -590,6 +595,7 @@ module Google
590
595
  @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
591
596
  @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
592
597
  @custom_metric = args[:custom_metric] if args.key?(:custom_metric)
598
+ @data_retention_settings = args[:data_retention_settings] if args.key?(:data_retention_settings)
593
599
  @display_video360_advertiser_link = args[:display_video360_advertiser_link] if args.key?(:display_video360_advertiser_link)
594
600
  @display_video360_advertiser_link_proposal = args[:display_video360_advertiser_link_proposal] if args.key?(:display_video360_advertiser_link_proposal)
595
601
  @firebase_link = args[:firebase_link] if args.key?(:firebase_link)
@@ -829,7 +835,7 @@ module Google
829
835
  # @return [String]
830
836
  attr_accessor :display_name
831
837
 
832
- # Required. Immutable. The type for the custom metric's value.
838
+ # Required. The type for the custom metric's value.
833
839
  # Corresponds to the JSON property `measurementUnit`
834
840
  # @return [String]
835
841
  attr_accessor :measurement_unit
@@ -868,6 +874,40 @@ module Google
868
874
  end
869
875
  end
870
876
 
877
+ # Settings values for data retention. This is a singleton resource.
878
+ class GoogleAnalyticsAdminV1alphaDataRetentionSettings
879
+ include Google::Apis::Core::Hashable
880
+
881
+ # The length of time that event-level data is retained.
882
+ # Corresponds to the JSON property `eventDataRetention`
883
+ # @return [String]
884
+ attr_accessor :event_data_retention
885
+
886
+ # Output only. Resource name for this DataRetentionSetting resource. Format:
887
+ # properties/`property`/dataRetentionSettings
888
+ # Corresponds to the JSON property `name`
889
+ # @return [String]
890
+ attr_accessor :name
891
+
892
+ # If true, reset the retention period for the user identifier with every event
893
+ # from that user.
894
+ # Corresponds to the JSON property `resetUserDataOnNewActivity`
895
+ # @return [Boolean]
896
+ attr_accessor :reset_user_data_on_new_activity
897
+ alias_method :reset_user_data_on_new_activity?, :reset_user_data_on_new_activity
898
+
899
+ def initialize(**args)
900
+ update!(**args)
901
+ end
902
+
903
+ # Update properties of this object
904
+ def update!(**args)
905
+ @event_data_retention = args[:event_data_retention] if args.key?(:event_data_retention)
906
+ @name = args[:name] if args.key?(:name)
907
+ @reset_user_data_on_new_activity = args[:reset_user_data_on_new_activity] if args.key?(:reset_user_data_on_new_activity)
908
+ end
909
+ end
910
+
871
911
  # A resource message representing data sharing settings of a Google Analytics
872
912
  # account.
873
913
  class GoogleAnalyticsAdminV1alphaDataSharingSettings
@@ -1867,6 +1907,12 @@ module Google
1867
1907
  class GoogleAnalyticsAdminV1alphaProperty
1868
1908
  include Google::Apis::Core::Hashable
1869
1909
 
1910
+ # Immutable. The resource name of the parent account Format: accounts/`
1911
+ # account_id` Example: "accounts/123"
1912
+ # Corresponds to the JSON property `account`
1913
+ # @return [String]
1914
+ attr_accessor :account
1915
+
1870
1916
  # Output only. Time when the entity was originally created.
1871
1917
  # Corresponds to the JSON property `createTime`
1872
1918
  # @return [String]
@@ -1940,6 +1986,7 @@ module Google
1940
1986
 
1941
1987
  # Update properties of this object
1942
1988
  def update!(**args)
1989
+ @account = args[:account] if args.key?(:account)
1943
1990
  @create_time = args[:create_time] if args.key?(:create_time)
1944
1991
  @currency_code = args[:currency_code] if args.key?(:currency_code)
1945
1992
  @delete_time = args[:delete_time] if args.key?(:delete_time)
@@ -2148,9 +2195,9 @@ module Google
2148
2195
 
2149
2196
  # Roles directly assigned to this user for this account or property. Valid
2150
2197
  # values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit
2151
- # predefinedRoles/manage-users Excludes roles that are inherited from a higher-
2152
- # level entity, group, or organization admin role. A UserLink that is updated to
2153
- # have an empty list of direct_roles will be deleted.
2198
+ # predefinedRoles/admin Excludes roles that are inherited from a higher-level
2199
+ # entity, group, or organization admin role. A UserLink that is updated to have
2200
+ # an empty list of direct_roles will be deleted.
2154
2201
  # Corresponds to the JSON property `directRoles`
2155
2202
  # @return [Array<String>]
2156
2203
  attr_accessor :direct_roles
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AnalyticsadminV1alpha
18
18
  # Version of the google-apis-analyticsadmin_v1alpha gem
19
- GEM_VERSION = "0.12.0"
19
+ GEM_VERSION = "0.16.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210712"
25
+ REVISION = "20210922"
26
26
  end
27
27
  end
28
28
  end
@@ -166,6 +166,12 @@ module Google
166
166
  include Google::Apis::Core::JsonObjectSupport
167
167
  end
168
168
 
169
+ class GoogleAnalyticsAdminV1alphaDataRetentionSettings
170
+ class Representation < Google::Apis::Core::JsonRepresentation; end
171
+
172
+ include Google::Apis::Core::JsonObjectSupport
173
+ end
174
+
169
175
  class GoogleAnalyticsAdminV1alphaDataSharingSettings
170
176
  class Representation < Google::Apis::Core::JsonRepresentation; end
171
177
 
@@ -556,6 +562,8 @@ module Google
556
562
 
557
563
  property :custom_metric, as: 'customMetric', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
558
564
 
565
+ property :data_retention_settings, as: 'dataRetentionSettings', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
566
+
559
567
  property :display_video360_advertiser_link, as: 'displayVideo360AdvertiserLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink::Representation
560
568
 
561
569
  property :display_video360_advertiser_link_proposal, as: 'displayVideo360AdvertiserLinkProposal', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal::Representation
@@ -635,6 +643,15 @@ module Google
635
643
  end
636
644
  end
637
645
 
646
+ class GoogleAnalyticsAdminV1alphaDataRetentionSettings
647
+ # @private
648
+ class Representation < Google::Apis::Core::JsonRepresentation
649
+ property :event_data_retention, as: 'eventDataRetention'
650
+ property :name, as: 'name'
651
+ property :reset_user_data_on_new_activity, as: 'resetUserDataOnNewActivity'
652
+ end
653
+ end
654
+
638
655
  class GoogleAnalyticsAdminV1alphaDataSharingSettings
639
656
  # @private
640
657
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -906,6 +923,7 @@ module Google
906
923
  class GoogleAnalyticsAdminV1alphaProperty
907
924
  # @private
908
925
  class Representation < Google::Apis::Core::JsonRepresentation
926
+ property :account, as: 'account'
909
927
  property :create_time, as: 'createTime'
910
928
  property :currency_code, as: 'currencyCode'
911
929
  property :delete_time, as: 'deleteTime'
@@ -787,6 +787,37 @@ module Google
787
787
  execute_or_queue_command(command, &block)
788
788
  end
789
789
 
790
+ # Returns the singleton data retention settings for this property.
791
+ # @param [String] name
792
+ # Required. The name of the settings to lookup. Format: properties/`property`/
793
+ # dataRetentionSettings Example: "properties/1000/dataRetentionSettings"
794
+ # @param [String] fields
795
+ # Selector specifying which fields to include in a partial response.
796
+ # @param [String] quota_user
797
+ # Available to use for quota purposes for server-side applications. Can be any
798
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
799
+ # @param [Google::Apis::RequestOptions] options
800
+ # Request-specific options
801
+ #
802
+ # @yield [result, err] Result & error if block supplied
803
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings] parsed result object
804
+ # @yieldparam err [StandardError] error object if request failed
805
+ #
806
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
807
+ #
808
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
809
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
810
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
811
+ def get_property_data_retention_settings(name, fields: nil, quota_user: nil, options: nil, &block)
812
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
813
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
814
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings
815
+ command.params['name'] = name unless name.nil?
816
+ command.query['fields'] = fields unless fields.nil?
817
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
818
+ execute_or_queue_command(command, &block)
819
+ end
820
+
790
821
  # Lookup for Google Signals settings for a property.
791
822
  # @param [String] name
792
823
  # Required. The name of the google signals settings to retrieve. Format:
@@ -912,6 +943,45 @@ module Google
912
943
  execute_or_queue_command(command, &block)
913
944
  end
914
945
 
946
+ # Updates the singleton data retention settings for this property.
947
+ # @param [String] name
948
+ # Output only. Resource name for this DataRetentionSetting resource. Format:
949
+ # properties/`property`/dataRetentionSettings
950
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings] google_analytics_admin_v1alpha_data_retention_settings_object
951
+ # @param [String] update_mask
952
+ # Required. The list of fields to be updated. Field names must be in snake case (
953
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
954
+ # entire entity, use one path with the string "*" to match all fields.
955
+ # @param [String] fields
956
+ # Selector specifying which fields to include in a partial response.
957
+ # @param [String] quota_user
958
+ # Available to use for quota purposes for server-side applications. Can be any
959
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
960
+ # @param [Google::Apis::RequestOptions] options
961
+ # Request-specific options
962
+ #
963
+ # @yield [result, err] Result & error if block supplied
964
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings] parsed result object
965
+ # @yieldparam err [StandardError] error object if request failed
966
+ #
967
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
968
+ #
969
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
970
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
971
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
972
+ 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)
973
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
974
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
975
+ command.request_object = google_analytics_admin_v1alpha_data_retention_settings_object
976
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings::Representation
977
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings
978
+ command.params['name'] = name unless name.nil?
979
+ command.query['updateMask'] = update_mask unless update_mask.nil?
980
+ command.query['fields'] = fields unless fields.nil?
981
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
982
+ execute_or_queue_command(command, &block)
983
+ end
984
+
915
985
  # Updates Google Signals settings for a property.
916
986
  # @param [String] name
917
987
  # Output only. Resource name of this setting. Format: properties/`property_id`/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsadmin_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.12.0
4
+ version: 0.16.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-19 00:00:00.000000000 Z
11
+ date: 2021-09-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.12.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.16.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsadmin_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []