google-apis-analyticsadmin_v1alpha 0.44.0 → 0.45.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: 39a7c0fd9f29e24766bf675629e7cfd7ce60295441977e989f67c0249b0b193e
4
- data.tar.gz: 1b004bc486738dc3bd27577592d7893787d0679ea7e397343991ed1c15113f71
3
+ metadata.gz: 73b57fe447e2fc51d94329a3523349ff7248c3d1d9260ad6d98290e9a9fdc93f
4
+ data.tar.gz: 35465b8de277c261d05424494dbaa1464cfd98f8b5eb83436d15cd92cfaf1191
5
5
  SHA512:
6
- metadata.gz: fe2c09f0bebf544a7d953faec6d99dcc391f7335b9229dec900195dd64a4b72fcb8a2c0f7d21a3ffd523419e775b453244653989a9bb6ceb7d078ec104116d49
7
- data.tar.gz: dc0528eca97553bc1cb88bce771ca8564e0c3e2d34d4c0205706900092b762c68a533563b1f820c8ff62705960a923e03a77e8b4024d23cf225e0aa76ff14207
6
+ metadata.gz: 0fc2da45405f47830a40634eb8fc7786d75a0f56b4c67e6fb73e3083cc06215445264c4a49df7604365a731af900a848533f0ce5faccbc532bbf66d1a7e8e29e
7
+ data.tar.gz: 43ca41788f6059b4ff8a1f44d2445886ee6f84b30e5336c443bc6b5ce949b25d8b7d99cfb20ae508edf2ffe96b9928c0ffd1a5e7c7fe591bcf4d6fba553a345c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.45.0 (2023-02-05)
4
+
5
+ * Regenerated from discovery document revision 20230131
6
+ * Regenerated using generator version 0.11.1
7
+
3
8
  ### v0.44.0 (2022-12-07)
4
9
 
5
10
  * Regenerated from discovery document revision 20221205
@@ -2692,6 +2692,48 @@ module Google
2692
2692
  end
2693
2693
  end
2694
2694
 
2695
+ # Request for fetching the opt out status for the automated GA4 setup process.
2696
+ class GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest
2697
+ include Google::Apis::Core::Hashable
2698
+
2699
+ # Required. The UA property to get the opt out status. Note this request uses
2700
+ # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format:
2701
+ # properties/`internalWebPropertyId` Example: properties/1234
2702
+ # Corresponds to the JSON property `property`
2703
+ # @return [String]
2704
+ attr_accessor :property
2705
+
2706
+ def initialize(**args)
2707
+ update!(**args)
2708
+ end
2709
+
2710
+ # Update properties of this object
2711
+ def update!(**args)
2712
+ @property = args[:property] if args.key?(:property)
2713
+ end
2714
+ end
2715
+
2716
+ # Response message for fetching the opt out status for the automated GA4 setup
2717
+ # process.
2718
+ class GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse
2719
+ include Google::Apis::Core::Hashable
2720
+
2721
+ # The opt out status for the UA property.
2722
+ # Corresponds to the JSON property `optOut`
2723
+ # @return [Boolean]
2724
+ attr_accessor :opt_out
2725
+ alias_method :opt_out?, :opt_out
2726
+
2727
+ def initialize(**args)
2728
+ update!(**args)
2729
+ end
2730
+
2731
+ # Update properties of this object
2732
+ def update!(**args)
2733
+ @opt_out = args[:opt_out] if args.key?(:opt_out)
2734
+ end
2735
+ end
2736
+
2695
2737
  # A link between a GA4 property and a Firebase project.
2696
2738
  class GoogleAnalyticsAdminV1alphaFirebaseLink
2697
2739
  include Google::Apis::Core::Hashable
@@ -3870,6 +3912,48 @@ module Google
3870
3912
  end
3871
3913
  end
3872
3914
 
3915
+ # Request for setting the opt out status for the automated GA4 setup process.
3916
+ class GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest
3917
+ include Google::Apis::Core::Hashable
3918
+
3919
+ # The status to set.
3920
+ # Corresponds to the JSON property `optOut`
3921
+ # @return [Boolean]
3922
+ attr_accessor :opt_out
3923
+ alias_method :opt_out?, :opt_out
3924
+
3925
+ # Required. The UA property to set the opt out status. Note this request uses
3926
+ # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format:
3927
+ # properties/`internalWebPropertyId` Example: properties/1234
3928
+ # Corresponds to the JSON property `property`
3929
+ # @return [String]
3930
+ attr_accessor :property
3931
+
3932
+ def initialize(**args)
3933
+ update!(**args)
3934
+ end
3935
+
3936
+ # Update properties of this object
3937
+ def update!(**args)
3938
+ @opt_out = args[:opt_out] if args.key?(:opt_out)
3939
+ @property = args[:property] if args.key?(:property)
3940
+ end
3941
+ end
3942
+
3943
+ # Response message for setting the opt out status for the automated GA4 setup
3944
+ # process.
3945
+ class GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse
3946
+ include Google::Apis::Core::Hashable
3947
+
3948
+ def initialize(**args)
3949
+ update!(**args)
3950
+ end
3951
+
3952
+ # Update properties of this object
3953
+ def update!(**args)
3954
+ end
3955
+ end
3956
+
3873
3957
  # Request message for UpdateUserLink RPC.
3874
3958
  class GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest
3875
3959
  include Google::Apis::Core::Hashable
@@ -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.44.0"
19
+ GEM_VERSION = "0.45.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.11.0"
22
+ GENERATOR_VERSION = "0.11.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20221205"
25
+ REVISION = "20230131"
26
26
  end
27
27
  end
28
28
  end
@@ -490,6 +490,18 @@ module Google
490
490
  include Google::Apis::Core::JsonObjectSupport
491
491
  end
492
492
 
493
+ class GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest
494
+ class Representation < Google::Apis::Core::JsonRepresentation; end
495
+
496
+ include Google::Apis::Core::JsonObjectSupport
497
+ end
498
+
499
+ class GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse
500
+ class Representation < Google::Apis::Core::JsonRepresentation; end
501
+
502
+ include Google::Apis::Core::JsonObjectSupport
503
+ end
504
+
493
505
  class GoogleAnalyticsAdminV1alphaFirebaseLink
494
506
  class Representation < Google::Apis::Core::JsonRepresentation; end
495
507
 
@@ -682,6 +694,18 @@ module Google
682
694
  include Google::Apis::Core::JsonObjectSupport
683
695
  end
684
696
 
697
+ class GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest
698
+ class Representation < Google::Apis::Core::JsonRepresentation; end
699
+
700
+ include Google::Apis::Core::JsonObjectSupport
701
+ end
702
+
703
+ class GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse
704
+ class Representation < Google::Apis::Core::JsonRepresentation; end
705
+
706
+ include Google::Apis::Core::JsonObjectSupport
707
+ end
708
+
685
709
  class GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest
686
710
  class Representation < Google::Apis::Core::JsonRepresentation; end
687
711
 
@@ -1486,6 +1510,20 @@ module Google
1486
1510
  end
1487
1511
  end
1488
1512
 
1513
+ class GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest
1514
+ # @private
1515
+ class Representation < Google::Apis::Core::JsonRepresentation
1516
+ property :property, as: 'property'
1517
+ end
1518
+ end
1519
+
1520
+ class GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse
1521
+ # @private
1522
+ class Representation < Google::Apis::Core::JsonRepresentation
1523
+ property :opt_out, as: 'optOut'
1524
+ end
1525
+ end
1526
+
1489
1527
  class GoogleAnalyticsAdminV1alphaFirebaseLink
1490
1528
  # @private
1491
1529
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1813,6 +1851,20 @@ module Google
1813
1851
  end
1814
1852
  end
1815
1853
 
1854
+ class GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest
1855
+ # @private
1856
+ class Representation < Google::Apis::Core::JsonRepresentation
1857
+ property :opt_out, as: 'optOut'
1858
+ property :property, as: 'property'
1859
+ end
1860
+ end
1861
+
1862
+ class GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse
1863
+ # @private
1864
+ class Representation < Google::Apis::Core::JsonRepresentation
1865
+ end
1866
+ end
1867
+
1816
1868
  class GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest
1817
1869
  # @private
1818
1870
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -791,6 +791,37 @@ module Google
791
791
  execute_or_queue_command(command, &block)
792
792
  end
793
793
 
794
+ # Fetches the opt out status for the automated GA4 setup process for a UA
795
+ # property. Note: this has no effect on GA4 property.
796
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest] google_analytics_admin_v1alpha_fetch_automated_ga4_configuration_opt_out_request_object
797
+ # @param [String] fields
798
+ # Selector specifying which fields to include in a partial response.
799
+ # @param [String] quota_user
800
+ # Available to use for quota purposes for server-side applications. Can be any
801
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
802
+ # @param [Google::Apis::RequestOptions] options
803
+ # Request-specific options
804
+ #
805
+ # @yield [result, err] Result & error if block supplied
806
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse] parsed result object
807
+ # @yieldparam err [StandardError] error object if request failed
808
+ #
809
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse]
810
+ #
811
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
812
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
813
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
814
+ def fetch_property_automated_ga4_configuration_opt_out(google_analytics_admin_v1alpha_fetch_automated_ga4_configuration_opt_out_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
815
+ command = make_simple_command(:post, 'v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut', options)
816
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest::Representation
817
+ command.request_object = google_analytics_admin_v1alpha_fetch_automated_ga4_configuration_opt_out_request_object
818
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse::Representation
819
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse
820
+ command.query['fields'] = fields unless fields.nil?
821
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
822
+ execute_or_queue_command(command, &block)
823
+ end
824
+
794
825
  # Lookup for a single "GA4" Property.
795
826
  # @param [String] name
796
827
  # Required. The name of the property to lookup. Format: properties/`property_id`
@@ -1055,6 +1086,37 @@ module Google
1055
1086
  execute_or_queue_command(command, &block)
1056
1087
  end
1057
1088
 
1089
+ # Sets the opt out status for the automated GA4 setup process for a UA property.
1090
+ # Note: this has no effect on GA4 property.
1091
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest] google_analytics_admin_v1alpha_set_automated_ga4_configuration_opt_out_request_object
1092
+ # @param [String] fields
1093
+ # Selector specifying which fields to include in a partial response.
1094
+ # @param [String] quota_user
1095
+ # Available to use for quota purposes for server-side applications. Can be any
1096
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1097
+ # @param [Google::Apis::RequestOptions] options
1098
+ # Request-specific options
1099
+ #
1100
+ # @yield [result, err] Result & error if block supplied
1101
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse] parsed result object
1102
+ # @yieldparam err [StandardError] error object if request failed
1103
+ #
1104
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse]
1105
+ #
1106
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1107
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1108
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1109
+ def set_property_automated_ga4_configuration_opt_out(google_analytics_admin_v1alpha_set_automated_ga4_configuration_opt_out_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1110
+ command = make_simple_command(:post, 'v1alpha/properties:setAutomatedGa4ConfigurationOptOut', options)
1111
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest::Representation
1112
+ command.request_object = google_analytics_admin_v1alpha_set_automated_ga4_configuration_opt_out_request_object
1113
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse::Representation
1114
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse
1115
+ command.query['fields'] = fields unless fields.nil?
1116
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1117
+ execute_or_queue_command(command, &block)
1118
+ end
1119
+
1058
1120
  # Updates attribution settings on a property.
1059
1121
  # @param [String] name
1060
1122
  # Output only. Resource name of this attribution settings resource. Format:
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.44.0
4
+ version: 0.45.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: 2022-12-12 00:00:00.000000000 Z
11
+ date: 2023-02-05 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/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.44.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.45.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.3.14
78
+ rubygems_version: 3.4.2
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Google Analytics Admin API V1alpha