google-apis-analyticsadmin_v1alpha 0.71.0 → 0.73.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3fb9d6c7ad96a05d733d2c0d77e18972e793b4565cafe899afb7cd44c9303d45
4
- data.tar.gz: ad6bb672b7b894cb2a5565aa562b30019e074b321714eb722e22d166747ca3c5
3
+ metadata.gz: e50c3c6824080af725ee4fdb79e7cddaa99175b059a3ecbf27fe51943faa150c
4
+ data.tar.gz: 0d1c8979c75c34876ff50fe8b64453507aedeb13d3b6dbcbf154e624293448c1
5
5
  SHA512:
6
- metadata.gz: 3861bd78c14d342aadb629e267f3d1058203fbc462ee9bd243e083fc62f294c80f2c504bef8a4952d38882b4069d853a64450456c2496d358fb2978d564eaddd
7
- data.tar.gz: 8218aee49caaf2193dae0b527b46e8f8e50f94c1285b89fad8714d7ff4c66bc332fad12d45538eb3afd0968abc7b9cd94f1021d8850866688c7dc40ffa4eb710
6
+ metadata.gz: b57aa0b14a04fddcd8d53a20611b05b4f5355e69b8bb80e35876ca1b7aca0d95133e363328786034b180b5fdce7e38dae312b2d01345568a630ec85d314f84b9
7
+ data.tar.gz: 3ccd5fdcced66248e13240aaed2efb76b736be11cde210834ddda43716167df7a990bb1f14a19b440bf17807716061b4d40bea1f175adcfb6df1ef97c82a0646
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.73.0 (2024-05-26)
4
+
5
+ * Regenerated from discovery document revision 20240517
6
+ * Regenerated using generator version 0.15.0
7
+
8
+ ### v0.72.0 (2024-04-07)
9
+
10
+ * Regenerated from discovery document revision 20240402
11
+
3
12
  ### v0.71.0 (2024-03-17)
4
13
 
5
14
  * Regenerated from discovery document revision 20240312
@@ -627,6 +627,13 @@ module Google
627
627
  # @return [String]
628
628
  attr_accessor :display_name
629
629
 
630
+ # Output only. The URI for a Google Marketing Platform organization resource.
631
+ # Only set when this account is connected to a GMP organization. Format:
632
+ # marketingplatformadmin.googleapis.com/organizations/`org_id`
633
+ # Corresponds to the JSON property `gmpOrganization`
634
+ # @return [String]
635
+ attr_accessor :gmp_organization
636
+
630
637
  # Output only. Resource name of this account. Format: accounts/`account` Example:
631
638
  # "accounts/100"
632
639
  # Corresponds to the JSON property `name`
@@ -652,6 +659,7 @@ module Google
652
659
  @create_time = args[:create_time] if args.key?(:create_time)
653
660
  @deleted = args[:deleted] if args.key?(:deleted)
654
661
  @display_name = args[:display_name] if args.key?(:display_name)
662
+ @gmp_organization = args[:gmp_organization] if args.key?(:gmp_organization)
655
663
  @name = args[:name] if args.key?(:name)
656
664
  @region_code = args[:region_code] if args.key?(:region_code)
657
665
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -896,6 +904,11 @@ module Google
896
904
  attr_accessor :ads_personalization_enabled
897
905
  alias_method :ads_personalization_enabled?, :ads_personalization_enabled
898
906
 
907
+ # Output only. Time when the Audience was created.
908
+ # Corresponds to the JSON property `createTime`
909
+ # @return [String]
910
+ attr_accessor :create_time
911
+
899
912
  # Required. The description of the Audience.
900
913
  # Corresponds to the JSON property `description`
901
914
  # @return [String]
@@ -943,6 +956,7 @@ module Google
943
956
  # Update properties of this object
944
957
  def update!(**args)
945
958
  @ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
959
+ @create_time = args[:create_time] if args.key?(:create_time)
946
960
  @description = args[:description] if args.key?(:description)
947
961
  @display_name = args[:display_name] if args.key?(:display_name)
948
962
  @event_trigger = args[:event_trigger] if args.key?(:event_trigger)
@@ -2464,12 +2478,6 @@ module Google
2464
2478
  class GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest
2465
2479
  include Google::Apis::Core::Hashable
2466
2480
 
2467
- # Required. The ordinary property for which to create a subproperty. Format:
2468
- # properties/property_id Example: properties/123
2469
- # Corresponds to the JSON property `parent`
2470
- # @return [String]
2471
- attr_accessor :parent
2472
-
2473
2481
  # A resource message representing a Google Analytics GA4 property.
2474
2482
  # Corresponds to the JSON property `subproperty`
2475
2483
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
@@ -2486,7 +2494,6 @@ module Google
2486
2494
 
2487
2495
  # Update properties of this object
2488
2496
  def update!(**args)
2489
- @parent = args[:parent] if args.key?(:parent)
2490
2497
  @subproperty = args[:subproperty] if args.key?(:subproperty)
2491
2498
  @subproperty_event_filter = args[:subproperty_event_filter] if args.key?(:subproperty_event_filter)
2492
2499
  end
@@ -3782,6 +3789,100 @@ module Google
3782
3789
  end
3783
3790
  end
3784
3791
 
3792
+ # A key event in a Google Analytics property.
3793
+ class GoogleAnalyticsAdminV1alphaKeyEvent
3794
+ include Google::Apis::Core::Hashable
3795
+
3796
+ # Required. The method by which Key Events will be counted across multiple
3797
+ # events within a session.
3798
+ # Corresponds to the JSON property `countingMethod`
3799
+ # @return [String]
3800
+ attr_accessor :counting_method
3801
+
3802
+ # Output only. Time when this key event was created in the property.
3803
+ # Corresponds to the JSON property `createTime`
3804
+ # @return [String]
3805
+ attr_accessor :create_time
3806
+
3807
+ # Output only. If set to true, this key event refers to a custom event. If set
3808
+ # to false, this key event refers to a default event in GA. Default events
3809
+ # typically have special meaning in GA. Default events are usually created for
3810
+ # you by the GA system, but in some cases can be created by property admins.
3811
+ # Custom events count towards the maximum number of custom key events that may
3812
+ # be created per property.
3813
+ # Corresponds to the JSON property `custom`
3814
+ # @return [Boolean]
3815
+ attr_accessor :custom
3816
+ alias_method :custom?, :custom
3817
+
3818
+ # Defines a default value/currency for a key event.
3819
+ # Corresponds to the JSON property `defaultValue`
3820
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue]
3821
+ attr_accessor :default_value
3822
+
3823
+ # Output only. If set to true, this event can be deleted.
3824
+ # Corresponds to the JSON property `deletable`
3825
+ # @return [Boolean]
3826
+ attr_accessor :deletable
3827
+ alias_method :deletable?, :deletable
3828
+
3829
+ # Immutable. The event name for this key event. Examples: 'click', 'purchase'
3830
+ # Corresponds to the JSON property `eventName`
3831
+ # @return [String]
3832
+ attr_accessor :event_name
3833
+
3834
+ # Output only. Resource name of this key event. Format: properties/`property`/
3835
+ # keyEvents/`key_event`
3836
+ # Corresponds to the JSON property `name`
3837
+ # @return [String]
3838
+ attr_accessor :name
3839
+
3840
+ def initialize(**args)
3841
+ update!(**args)
3842
+ end
3843
+
3844
+ # Update properties of this object
3845
+ def update!(**args)
3846
+ @counting_method = args[:counting_method] if args.key?(:counting_method)
3847
+ @create_time = args[:create_time] if args.key?(:create_time)
3848
+ @custom = args[:custom] if args.key?(:custom)
3849
+ @default_value = args[:default_value] if args.key?(:default_value)
3850
+ @deletable = args[:deletable] if args.key?(:deletable)
3851
+ @event_name = args[:event_name] if args.key?(:event_name)
3852
+ @name = args[:name] if args.key?(:name)
3853
+ end
3854
+ end
3855
+
3856
+ # Defines a default value/currency for a key event.
3857
+ class GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
3858
+ include Google::Apis::Core::Hashable
3859
+
3860
+ # Required. When an occurrence of this Key Event (specified by event_name) has
3861
+ # no set currency this currency will be applied as the default. Must be in ISO
3862
+ # 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more
3863
+ # information.
3864
+ # Corresponds to the JSON property `currencyCode`
3865
+ # @return [String]
3866
+ attr_accessor :currency_code
3867
+
3868
+ # Required. This will be used to populate the "value" parameter for all
3869
+ # occurrences of this Key Event (specified by event_name) where that parameter
3870
+ # is unset.
3871
+ # Corresponds to the JSON property `numericValue`
3872
+ # @return [Float]
3873
+ attr_accessor :numeric_value
3874
+
3875
+ def initialize(**args)
3876
+ update!(**args)
3877
+ end
3878
+
3879
+ # Update properties of this object
3880
+ def update!(**args)
3881
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
3882
+ @numeric_value = args[:numeric_value] if args.key?(:numeric_value)
3883
+ end
3884
+ end
3885
+
3785
3886
  # Status information for a link proposal.
3786
3887
  class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
3787
3888
  include Google::Apis::Core::Hashable
@@ -4326,6 +4427,32 @@ module Google
4326
4427
  end
4327
4428
  end
4328
4429
 
4430
+ # Response message for ListKeyEvents RPC.
4431
+ class GoogleAnalyticsAdminV1alphaListKeyEventsResponse
4432
+ include Google::Apis::Core::Hashable
4433
+
4434
+ # The requested Key Events
4435
+ # Corresponds to the JSON property `keyEvents`
4436
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent>]
4437
+ attr_accessor :key_events
4438
+
4439
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
4440
+ # field is omitted, there are no subsequent pages.
4441
+ # Corresponds to the JSON property `nextPageToken`
4442
+ # @return [String]
4443
+ attr_accessor :next_page_token
4444
+
4445
+ def initialize(**args)
4446
+ update!(**args)
4447
+ end
4448
+
4449
+ # Update properties of this object
4450
+ def update!(**args)
4451
+ @key_events = args[:key_events] if args.key?(:key_events)
4452
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
4453
+ end
4454
+ end
4455
+
4329
4456
  # Response message for ListMeasurementProtocolSecret RPC
4330
4457
  class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
4331
4458
  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.71.0"
19
+ GEM_VERSION = "0.73.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.14.0"
22
+ GENERATOR_VERSION = "0.15.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240312"
25
+ REVISION = "20240517"
26
26
  end
27
27
  end
28
28
  end
@@ -658,6 +658,18 @@ module Google
658
658
  include Google::Apis::Core::JsonObjectSupport
659
659
  end
660
660
 
661
+ class GoogleAnalyticsAdminV1alphaKeyEvent
662
+ class Representation < Google::Apis::Core::JsonRepresentation; end
663
+
664
+ include Google::Apis::Core::JsonObjectSupport
665
+ end
666
+
667
+ class GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
668
+ class Representation < Google::Apis::Core::JsonRepresentation; end
669
+
670
+ include Google::Apis::Core::JsonObjectSupport
671
+ end
672
+
661
673
  class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
662
674
  class Representation < Google::Apis::Core::JsonRepresentation; end
663
675
 
@@ -784,6 +796,12 @@ module Google
784
796
  include Google::Apis::Core::JsonObjectSupport
785
797
  end
786
798
 
799
+ class GoogleAnalyticsAdminV1alphaListKeyEventsResponse
800
+ class Representation < Google::Apis::Core::JsonRepresentation; end
801
+
802
+ include Google::Apis::Core::JsonObjectSupport
803
+ end
804
+
787
805
  class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
788
806
  class Representation < Google::Apis::Core::JsonRepresentation; end
789
807
 
@@ -1174,6 +1192,7 @@ module Google
1174
1192
  property :create_time, as: 'createTime'
1175
1193
  property :deleted, as: 'deleted'
1176
1194
  property :display_name, as: 'displayName'
1195
+ property :gmp_organization, as: 'gmpOrganization'
1177
1196
  property :name, as: 'name'
1178
1197
  property :region_code, as: 'regionCode'
1179
1198
  property :update_time, as: 'updateTime'
@@ -1259,6 +1278,7 @@ module Google
1259
1278
  # @private
1260
1279
  class Representation < Google::Apis::Core::JsonRepresentation
1261
1280
  property :ads_personalization_enabled, as: 'adsPersonalizationEnabled'
1281
+ property :create_time, as: 'createTime'
1262
1282
  property :description, as: 'description'
1263
1283
  property :display_name, as: 'displayName'
1264
1284
  property :event_trigger, as: 'eventTrigger', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger::Representation
@@ -1727,7 +1747,6 @@ module Google
1727
1747
  class GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest
1728
1748
  # @private
1729
1749
  class Representation < Google::Apis::Core::JsonRepresentation
1730
- property :parent, as: 'parent'
1731
1750
  property :subproperty, as: 'subproperty', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
1732
1751
 
1733
1752
  property :subproperty_event_filter, as: 'subpropertyEventFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSubpropertyEventFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSubpropertyEventFilter::Representation
@@ -2057,6 +2076,28 @@ module Google
2057
2076
  end
2058
2077
  end
2059
2078
 
2079
+ class GoogleAnalyticsAdminV1alphaKeyEvent
2080
+ # @private
2081
+ class Representation < Google::Apis::Core::JsonRepresentation
2082
+ property :counting_method, as: 'countingMethod'
2083
+ property :create_time, as: 'createTime'
2084
+ property :custom, as: 'custom'
2085
+ property :default_value, as: 'defaultValue', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue::Representation
2086
+
2087
+ property :deletable, as: 'deletable'
2088
+ property :event_name, as: 'eventName'
2089
+ property :name, as: 'name'
2090
+ end
2091
+ end
2092
+
2093
+ class GoogleAnalyticsAdminV1alphaKeyEventDefaultValue
2094
+ # @private
2095
+ class Representation < Google::Apis::Core::JsonRepresentation
2096
+ property :currency_code, as: 'currencyCode'
2097
+ property :numeric_value, as: 'numericValue'
2098
+ end
2099
+ end
2100
+
2060
2101
  class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
2061
2102
  # @private
2062
2103
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2243,6 +2284,15 @@ module Google
2243
2284
  end
2244
2285
  end
2245
2286
 
2287
+ class GoogleAnalyticsAdminV1alphaListKeyEventsResponse
2288
+ # @private
2289
+ class Representation < Google::Apis::Core::JsonRepresentation
2290
+ collection :key_events, as: 'keyEvents', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
2291
+
2292
+ property :next_page_token, as: 'nextPageToken'
2293
+ end
2294
+ end
2295
+
2246
2296
  class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
2247
2297
  # @private
2248
2298
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4764,6 +4764,182 @@ module Google
4764
4764
  execute_or_queue_command(command, &block)
4765
4765
  end
4766
4766
 
4767
+ # Creates a Key Event.
4768
+ # @param [String] parent
4769
+ # Required. The resource name of the parent property where this Key Event will
4770
+ # be created. Format: properties/123
4771
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] google_analytics_admin_v1alpha_key_event_object
4772
+ # @param [String] fields
4773
+ # Selector specifying which fields to include in a partial response.
4774
+ # @param [String] quota_user
4775
+ # Available to use for quota purposes for server-side applications. Can be any
4776
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4777
+ # @param [Google::Apis::RequestOptions] options
4778
+ # Request-specific options
4779
+ #
4780
+ # @yield [result, err] Result & error if block supplied
4781
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] parsed result object
4782
+ # @yieldparam err [StandardError] error object if request failed
4783
+ #
4784
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent]
4785
+ #
4786
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4787
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4788
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4789
+ def create_property_key_event(parent, google_analytics_admin_v1alpha_key_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4790
+ command = make_simple_command(:post, 'v1alpha/{+parent}/keyEvents', options)
4791
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
4792
+ command.request_object = google_analytics_admin_v1alpha_key_event_object
4793
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
4794
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent
4795
+ command.params['parent'] = parent unless parent.nil?
4796
+ command.query['fields'] = fields unless fields.nil?
4797
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4798
+ execute_or_queue_command(command, &block)
4799
+ end
4800
+
4801
+ # Deletes a Key Event.
4802
+ # @param [String] name
4803
+ # Required. The resource name of the Key Event to delete. Format: properties/`
4804
+ # property`/keyEvents/`key_event` Example: "properties/123/keyEvents/456"
4805
+ # @param [String] fields
4806
+ # Selector specifying which fields to include in a partial response.
4807
+ # @param [String] quota_user
4808
+ # Available to use for quota purposes for server-side applications. Can be any
4809
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4810
+ # @param [Google::Apis::RequestOptions] options
4811
+ # Request-specific options
4812
+ #
4813
+ # @yield [result, err] Result & error if block supplied
4814
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
4815
+ # @yieldparam err [StandardError] error object if request failed
4816
+ #
4817
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
4818
+ #
4819
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4820
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4821
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4822
+ def delete_property_key_event(name, fields: nil, quota_user: nil, options: nil, &block)
4823
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
4824
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
4825
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
4826
+ command.params['name'] = name unless name.nil?
4827
+ command.query['fields'] = fields unless fields.nil?
4828
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4829
+ execute_or_queue_command(command, &block)
4830
+ end
4831
+
4832
+ # Retrieve a single Key Event.
4833
+ # @param [String] name
4834
+ # Required. The resource name of the Key Event to retrieve. Format: properties/`
4835
+ # property`/keyEvents/`key_event` Example: "properties/123/keyEvents/456"
4836
+ # @param [String] fields
4837
+ # Selector specifying which fields to include in a partial response.
4838
+ # @param [String] quota_user
4839
+ # Available to use for quota purposes for server-side applications. Can be any
4840
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4841
+ # @param [Google::Apis::RequestOptions] options
4842
+ # Request-specific options
4843
+ #
4844
+ # @yield [result, err] Result & error if block supplied
4845
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] parsed result object
4846
+ # @yieldparam err [StandardError] error object if request failed
4847
+ #
4848
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent]
4849
+ #
4850
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4851
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4852
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4853
+ def get_property_key_event(name, fields: nil, quota_user: nil, options: nil, &block)
4854
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4855
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
4856
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent
4857
+ command.params['name'] = name unless name.nil?
4858
+ command.query['fields'] = fields unless fields.nil?
4859
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4860
+ execute_or_queue_command(command, &block)
4861
+ end
4862
+
4863
+ # Returns a list of Key Events in the specified parent property. Returns an
4864
+ # empty list if no Key Events are found.
4865
+ # @param [String] parent
4866
+ # Required. The resource name of the parent property. Example: 'properties/123'
4867
+ # @param [Fixnum] page_size
4868
+ # The maximum number of resources to return. If unspecified, at most 50
4869
+ # resources will be returned. The maximum value is 200; (higher values will be
4870
+ # coerced to the maximum)
4871
+ # @param [String] page_token
4872
+ # A page token, received from a previous `ListKeyEvents` call. Provide this to
4873
+ # retrieve the subsequent page. When paginating, all other parameters provided
4874
+ # to `ListKeyEvents` must match the call that provided the page token.
4875
+ # @param [String] fields
4876
+ # Selector specifying which fields to include in a partial response.
4877
+ # @param [String] quota_user
4878
+ # Available to use for quota purposes for server-side applications. Can be any
4879
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4880
+ # @param [Google::Apis::RequestOptions] options
4881
+ # Request-specific options
4882
+ #
4883
+ # @yield [result, err] Result & error if block supplied
4884
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse] parsed result object
4885
+ # @yieldparam err [StandardError] error object if request failed
4886
+ #
4887
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse]
4888
+ #
4889
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4890
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4891
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4892
+ def list_property_key_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4893
+ command = make_simple_command(:get, 'v1alpha/{+parent}/keyEvents', options)
4894
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse::Representation
4895
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListKeyEventsResponse
4896
+ command.params['parent'] = parent unless parent.nil?
4897
+ command.query['pageSize'] = page_size unless page_size.nil?
4898
+ command.query['pageToken'] = page_token unless page_token.nil?
4899
+ command.query['fields'] = fields unless fields.nil?
4900
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4901
+ execute_or_queue_command(command, &block)
4902
+ end
4903
+
4904
+ # Updates a Key Event.
4905
+ # @param [String] name
4906
+ # Output only. Resource name of this key event. Format: properties/`property`/
4907
+ # keyEvents/`key_event`
4908
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] google_analytics_admin_v1alpha_key_event_object
4909
+ # @param [String] update_mask
4910
+ # Required. The list of fields to be updated. Field names must be in snake case (
4911
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
4912
+ # entire entity, use one path with the string "*" to match all fields.
4913
+ # @param [String] fields
4914
+ # Selector specifying which fields to include in a partial response.
4915
+ # @param [String] quota_user
4916
+ # Available to use for quota purposes for server-side applications. Can be any
4917
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4918
+ # @param [Google::Apis::RequestOptions] options
4919
+ # Request-specific options
4920
+ #
4921
+ # @yield [result, err] Result & error if block supplied
4922
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent] parsed result object
4923
+ # @yieldparam err [StandardError] error object if request failed
4924
+ #
4925
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent]
4926
+ #
4927
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4928
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4929
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4930
+ 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)
4931
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
4932
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
4933
+ command.request_object = google_analytics_admin_v1alpha_key_event_object
4934
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent::Representation
4935
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent
4936
+ command.params['name'] = name unless name.nil?
4937
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4938
+ command.query['fields'] = fields unless fields.nil?
4939
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4940
+ execute_or_queue_command(command, &block)
4941
+ end
4942
+
4767
4943
  # Creates a roll-up property source link. Only roll-up properties can have
4768
4944
  # source links, so this method will throw an error if used on other types of
4769
4945
  # properties.
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.71.0
4
+ version: 0.73.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: 2024-03-17 00:00:00.000000000 Z
11
+ date: 2024-05-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.14.0
19
+ version: 0.15.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.14.0
29
+ version: 0.15.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -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.71.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.73.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: []