google-apis-analyticsadmin_v1alpha 0.68.0 → 0.69.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: e3d18eac1418217cd62462b9599a90a337384a7ae5bde30a5591cbb460e98ee9
4
- data.tar.gz: 7fcdf5ffb14934bb34231b75a64c00b7614be3928492d3eaefede4d40f0b3893
3
+ metadata.gz: e29aada664c2280ec6c4ef619c5b753d4df914dd18bc30bc55a6b9df97d6a67f
4
+ data.tar.gz: b0b4a385038c98981047f7450088219242b37abd9ff0f5ef5e6802135143ff38
5
5
  SHA512:
6
- metadata.gz: 94386be19849b19fb903c41f5f3093cfcb3daf14819b235db83f51d2af49037fe6d9323327d5e79fe1591a599cbca2b4f6f0ae750cb70290705014bfcd1df218
7
- data.tar.gz: d69ee809ea13d6f7ef2a01aff52a9f24c003d92d584551d28133e9ec477cbcbb8927001d8d7c62e0c377a0b1c81e59deff5b712fb29ca113d77997c84b9e29c4
6
+ metadata.gz: cf7d5917bd738a58b43acc43055681154685289bd59cc5ebd9eac190bf5b13a519db1c92400fae04f1ea73ea0f3507e6a5692e5a88a0a0db893f68e9734ca7ee
7
+ data.tar.gz: c20eea3eb7ca8abfb4901a4a5c90e9a762a5006e69b5dedfed9407c55dfcf047b051cf027ac0345ae9f99a4b1f2259e10ef5d06b41e7127e46e980c23c0b5302
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.69.0 (2024-01-23)
4
+
5
+ * Regenerated from discovery document revision 20240115
6
+ * Regenerated using generator version 0.13.0
7
+
3
8
  ### v0.68.0 (2023-12-17)
4
9
 
5
10
  * Regenerated from discovery document revision 20231212
@@ -1615,6 +1615,81 @@ module Google
1615
1615
  end
1616
1616
  end
1617
1617
 
1618
+ # A definition for a calculated metric.
1619
+ class GoogleAnalyticsAdminV1alphaCalculatedMetric
1620
+ include Google::Apis::Core::Hashable
1621
+
1622
+ # Output only. The ID to use for the calculated metric. In the UI, this is
1623
+ # referred to as the "API name." The calculated_metric_id is used when
1624
+ # referencing this calculated metric from external APIs. For example, "
1625
+ # calcMetric:`calculated_metric_id`".
1626
+ # Corresponds to the JSON property `calculatedMetricId`
1627
+ # @return [String]
1628
+ attr_accessor :calculated_metric_id
1629
+
1630
+ # Optional. Description for this calculated metric. Max length of 4096
1631
+ # characters.
1632
+ # Corresponds to the JSON property `description`
1633
+ # @return [String]
1634
+ attr_accessor :description
1635
+
1636
+ # Required. Display name for this calculated metric as shown in the Google
1637
+ # Analytics UI. Max length 82 characters.
1638
+ # Corresponds to the JSON property `displayName`
1639
+ # @return [String]
1640
+ attr_accessor :display_name
1641
+
1642
+ # Required. The calculated metric's definition. Maximum number of unique
1643
+ # referenced custom metrics is 5. Formulas supports the following operations: + (
1644
+ # addition), - (subtraction), - (negative), * (multiplication), / (division), ()
1645
+ # (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit
1646
+ # integer) or a Double (64 bit floating point number). Example formula: "(
1647
+ # customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"
1648
+ # Corresponds to the JSON property `formula`
1649
+ # @return [String]
1650
+ attr_accessor :formula
1651
+
1652
+ # Output only. If true, this calculated metric has a invalid metric reference.
1653
+ # Anything using a calculated metric with invalid_metric_reference set to true
1654
+ # may fail, produce warnings, or produce unexpected results.
1655
+ # Corresponds to the JSON property `invalidMetricReference`
1656
+ # @return [Boolean]
1657
+ attr_accessor :invalid_metric_reference
1658
+ alias_method :invalid_metric_reference?, :invalid_metric_reference
1659
+
1660
+ # Required. The type for the calculated metric's value.
1661
+ # Corresponds to the JSON property `metricUnit`
1662
+ # @return [String]
1663
+ attr_accessor :metric_unit
1664
+
1665
+ # Output only. Resource name for this CalculatedMetric. Format: 'properties/`
1666
+ # property_id`/calculatedMetrics/`calculated_metric_id`'
1667
+ # Corresponds to the JSON property `name`
1668
+ # @return [String]
1669
+ attr_accessor :name
1670
+
1671
+ # Output only. Types of restricted data that this metric contains.
1672
+ # Corresponds to the JSON property `restrictedMetricType`
1673
+ # @return [Array<String>]
1674
+ attr_accessor :restricted_metric_type
1675
+
1676
+ def initialize(**args)
1677
+ update!(**args)
1678
+ end
1679
+
1680
+ # Update properties of this object
1681
+ def update!(**args)
1682
+ @calculated_metric_id = args[:calculated_metric_id] if args.key?(:calculated_metric_id)
1683
+ @description = args[:description] if args.key?(:description)
1684
+ @display_name = args[:display_name] if args.key?(:display_name)
1685
+ @formula = args[:formula] if args.key?(:formula)
1686
+ @invalid_metric_reference = args[:invalid_metric_reference] if args.key?(:invalid_metric_reference)
1687
+ @metric_unit = args[:metric_unit] if args.key?(:metric_unit)
1688
+ @name = args[:name] if args.key?(:name)
1689
+ @restricted_metric_type = args[:restricted_metric_type] if args.key?(:restricted_metric_type)
1690
+ end
1691
+ end
1692
+
1618
1693
  # Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
1619
1694
  class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
1620
1695
  include Google::Apis::Core::Hashable
@@ -1698,6 +1773,11 @@ module Google
1698
1773
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink]
1699
1774
  attr_accessor :bigquery_link
1700
1775
 
1776
+ # A definition for a calculated metric.
1777
+ # Corresponds to the JSON property `calculatedMetric`
1778
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric]
1779
+ attr_accessor :calculated_metric
1780
+
1701
1781
  # A resource message representing a Channel Group.
1702
1782
  # Corresponds to the JSON property `channelGroup`
1703
1783
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChannelGroup]
@@ -1813,6 +1893,7 @@ module Google
1813
1893
  @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
1814
1894
  @audience = args[:audience] if args.key?(:audience)
1815
1895
  @bigquery_link = args[:bigquery_link] if args.key?(:bigquery_link)
1896
+ @calculated_metric = args[:calculated_metric] if args.key?(:calculated_metric)
1816
1897
  @channel_group = args[:channel_group] if args.key?(:channel_group)
1817
1898
  @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
1818
1899
  @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
@@ -2175,7 +2256,7 @@ module Google
2175
2256
 
2176
2257
  # When a conversion event for this event_name has no set currency, this currency
2177
2258
  # will be applied as the default. Must be in ISO 4217 currency code format. See
2178
- # https://en.wikipedia.org/wiki/ISO_4217 for more.
2259
+ # https://en.wikipedia.org/wiki/ISO_4217 for more information.
2179
2260
  # Corresponds to the JSON property `currencyCode`
2180
2261
  # @return [String]
2181
2262
  attr_accessor :currency_code
@@ -3878,6 +3959,32 @@ module Google
3878
3959
  end
3879
3960
  end
3880
3961
 
3962
+ # Response message for ListCalculatedMetrics RPC.
3963
+ class GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse
3964
+ include Google::Apis::Core::Hashable
3965
+
3966
+ # List of CalculatedMetrics.
3967
+ # Corresponds to the JSON property `calculatedMetrics`
3968
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric>]
3969
+ attr_accessor :calculated_metrics
3970
+
3971
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
3972
+ # field is omitted, there are no subsequent pages.
3973
+ # Corresponds to the JSON property `nextPageToken`
3974
+ # @return [String]
3975
+ attr_accessor :next_page_token
3976
+
3977
+ def initialize(**args)
3978
+ update!(**args)
3979
+ end
3980
+
3981
+ # Update properties of this object
3982
+ def update!(**args)
3983
+ @calculated_metrics = args[:calculated_metrics] if args.key?(:calculated_metrics)
3984
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3985
+ end
3986
+ end
3987
+
3881
3988
  # Response message for ListChannelGroups RPC.
3882
3989
  class GoogleAnalyticsAdminV1alphaListChannelGroupsResponse
3883
3990
  include Google::Apis::Core::Hashable
@@ -5095,7 +5202,8 @@ module Google
5095
5202
  attr_accessor :page_token
5096
5203
 
5097
5204
  # Optional. Resource name for a child property. If set, only return changes made
5098
- # to this property or its child resources.
5205
+ # to this property or its child resources. Format: properties/`propertyId`
5206
+ # Example: "properties/100"
5099
5207
  # Corresponds to the JSON property `property`
5100
5208
  # @return [String]
5101
5209
  attr_accessor :property
@@ -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.68.0"
19
+ GEM_VERSION = "0.69.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.12.0"
22
+ GENERATOR_VERSION = "0.13.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20231212"
25
+ REVISION = "20240115"
26
26
  end
27
27
  end
28
28
  end
@@ -346,6 +346,12 @@ module Google
346
346
  include Google::Apis::Core::JsonObjectSupport
347
347
  end
348
348
 
349
+ class GoogleAnalyticsAdminV1alphaCalculatedMetric
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
349
355
  class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
350
356
  class Representation < Google::Apis::Core::JsonRepresentation; end
351
357
 
@@ -694,6 +700,12 @@ module Google
694
700
  include Google::Apis::Core::JsonObjectSupport
695
701
  end
696
702
 
703
+ class GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse
704
+ class Representation < Google::Apis::Core::JsonRepresentation; end
705
+
706
+ include Google::Apis::Core::JsonObjectSupport
707
+ end
708
+
697
709
  class GoogleAnalyticsAdminV1alphaListChannelGroupsResponse
698
710
  class Representation < Google::Apis::Core::JsonRepresentation; end
699
711
 
@@ -1465,6 +1477,20 @@ module Google
1465
1477
  end
1466
1478
  end
1467
1479
 
1480
+ class GoogleAnalyticsAdminV1alphaCalculatedMetric
1481
+ # @private
1482
+ class Representation < Google::Apis::Core::JsonRepresentation
1483
+ property :calculated_metric_id, as: 'calculatedMetricId'
1484
+ property :description, as: 'description'
1485
+ property :display_name, as: 'displayName'
1486
+ property :formula, as: 'formula'
1487
+ property :invalid_metric_reference, as: 'invalidMetricReference'
1488
+ property :metric_unit, as: 'metricUnit'
1489
+ property :name, as: 'name'
1490
+ collection :restricted_metric_type, as: 'restrictedMetricType'
1491
+ end
1492
+ end
1493
+
1468
1494
  class GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
1469
1495
  # @private
1470
1496
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1496,6 +1522,8 @@ module Google
1496
1522
 
1497
1523
  property :bigquery_link, as: 'bigqueryLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBigQueryLink::Representation
1498
1524
 
1525
+ property :calculated_metric, as: 'calculatedMetric', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
1526
+
1499
1527
  property :channel_group, as: 'channelGroup', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChannelGroup, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChannelGroup::Representation
1500
1528
 
1501
1529
  property :conversion_event, as: 'conversionEvent', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
@@ -2091,6 +2119,15 @@ module Google
2091
2119
  end
2092
2120
  end
2093
2121
 
2122
+ class GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse
2123
+ # @private
2124
+ class Representation < Google::Apis::Core::JsonRepresentation
2125
+ collection :calculated_metrics, as: 'calculatedMetrics', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
2126
+
2127
+ property :next_page_token, as: 'nextPageToken'
2128
+ end
2129
+ end
2130
+
2094
2131
  class GoogleAnalyticsAdminV1alphaListChannelGroupsResponse
2095
2132
  # @private
2096
2133
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -37,6 +37,8 @@ module Google
37
37
  #
38
38
  # @see http://code.google.com/apis/analytics/docs/mgmt/home.html
39
39
  class GoogleAnalyticsAdminService < Google::Apis::Core::BaseService
40
+ DEFAULT_ENDPOINT_TEMPLATE = "https://analyticsadmin.$UNIVERSE_DOMAIN$/"
41
+
40
42
  # @return [String]
41
43
  # API key. Your API key identifies your project and provides you with API access,
42
44
  # quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -48,7 +50,7 @@ module Google
48
50
  attr_accessor :quota_user
49
51
 
50
52
  def initialize
51
- super('https://analyticsadmin.googleapis.com/', '',
53
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
52
54
  client_name: 'google-apis-analyticsadmin_v1alpha',
53
55
  client_version: Google::Apis::AnalyticsadminV1alpha::GEM_VERSION)
54
56
  @batch_path = 'batch'
@@ -360,6 +362,7 @@ module Google
360
362
  # set of filters.
361
363
  # @param [String] account
362
364
  # Required. The account resource for which to return change history resources.
365
+ # Format: accounts/`account` Example: "accounts/100"
363
366
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest] google_analytics_admin_v1alpha_search_change_history_events_request_object
364
367
  # @param [String] fields
365
368
  # Selector specifying which fields to include in a partial response.
@@ -2159,6 +2162,191 @@ module Google
2159
2162
  execute_or_queue_command(command, &block)
2160
2163
  end
2161
2164
 
2165
+ # Creates a CalculatedMetric.
2166
+ # @param [String] parent
2167
+ # Required. Format: properties/`property_id` Example: properties/1234
2168
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric] google_analytics_admin_v1alpha_calculated_metric_object
2169
+ # @param [String] calculated_metric_id
2170
+ # Required. The ID to use for the calculated metric which will become the final
2171
+ # component of the calculated metric's resource name. This value should be 1-80
2172
+ # characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed.
2173
+ # calculated_metric_id must be unique between all calculated metrics under a
2174
+ # property. The calculated_metric_id is used when referencing this calculated
2175
+ # metric from external APIs, for example, "calcMetric:`calculated_metric_id`".
2176
+ # @param [String] fields
2177
+ # Selector specifying which fields to include in a partial response.
2178
+ # @param [String] quota_user
2179
+ # Available to use for quota purposes for server-side applications. Can be any
2180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2181
+ # @param [Google::Apis::RequestOptions] options
2182
+ # Request-specific options
2183
+ #
2184
+ # @yield [result, err] Result & error if block supplied
2185
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric] parsed result object
2186
+ # @yieldparam err [StandardError] error object if request failed
2187
+ #
2188
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric]
2189
+ #
2190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2193
+ def create_property_calculated_metric(parent, google_analytics_admin_v1alpha_calculated_metric_object = nil, calculated_metric_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2194
+ command = make_simple_command(:post, 'v1alpha/{+parent}/calculatedMetrics', options)
2195
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
2196
+ command.request_object = google_analytics_admin_v1alpha_calculated_metric_object
2197
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
2198
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric
2199
+ command.params['parent'] = parent unless parent.nil?
2200
+ command.query['calculatedMetricId'] = calculated_metric_id unless calculated_metric_id.nil?
2201
+ command.query['fields'] = fields unless fields.nil?
2202
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2203
+ execute_or_queue_command(command, &block)
2204
+ end
2205
+
2206
+ # Deletes a CalculatedMetric on a property.
2207
+ # @param [String] name
2208
+ # Required. The name of the CalculatedMetric to delete. Format: properties/`
2209
+ # property_id`/calculatedMetrics/`calculated_metric_id` Example: properties/1234/
2210
+ # calculatedMetrics/Metric01
2211
+ # @param [String] fields
2212
+ # Selector specifying which fields to include in a partial response.
2213
+ # @param [String] quota_user
2214
+ # Available to use for quota purposes for server-side applications. Can be any
2215
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2216
+ # @param [Google::Apis::RequestOptions] options
2217
+ # Request-specific options
2218
+ #
2219
+ # @yield [result, err] Result & error if block supplied
2220
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
2221
+ # @yieldparam err [StandardError] error object if request failed
2222
+ #
2223
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
2224
+ #
2225
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2226
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2227
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2228
+ def delete_property_calculated_metric(name, fields: nil, quota_user: nil, options: nil, &block)
2229
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2230
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
2231
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
2232
+ command.params['name'] = name unless name.nil?
2233
+ command.query['fields'] = fields unless fields.nil?
2234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2235
+ execute_or_queue_command(command, &block)
2236
+ end
2237
+
2238
+ # Lookup for a single CalculatedMetric.
2239
+ # @param [String] name
2240
+ # Required. The name of the CalculatedMetric to get. Format: properties/`
2241
+ # property_id`/calculatedMetrics/`calculated_metric_id` Example: properties/1234/
2242
+ # calculatedMetrics/Metric01
2243
+ # @param [String] fields
2244
+ # Selector specifying which fields to include in a partial response.
2245
+ # @param [String] quota_user
2246
+ # Available to use for quota purposes for server-side applications. Can be any
2247
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2248
+ # @param [Google::Apis::RequestOptions] options
2249
+ # Request-specific options
2250
+ #
2251
+ # @yield [result, err] Result & error if block supplied
2252
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric] parsed result object
2253
+ # @yieldparam err [StandardError] error object if request failed
2254
+ #
2255
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric]
2256
+ #
2257
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2258
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2259
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2260
+ def get_property_calculated_metric(name, fields: nil, quota_user: nil, options: nil, &block)
2261
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2262
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
2263
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric
2264
+ command.params['name'] = name unless name.nil?
2265
+ command.query['fields'] = fields unless fields.nil?
2266
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2267
+ execute_or_queue_command(command, &block)
2268
+ end
2269
+
2270
+ # Lists CalculatedMetrics on a property.
2271
+ # @param [String] parent
2272
+ # Required. Example format: properties/1234
2273
+ # @param [Fixnum] page_size
2274
+ # Optional. The maximum number of resources to return. If unspecified, at most
2275
+ # 50 resources will be returned. The maximum value is 200 (higher values will be
2276
+ # coerced to the maximum).
2277
+ # @param [String] page_token
2278
+ # Optional. A page token, received from a previous `ListCalculatedMetrics` call.
2279
+ # Provide this to retrieve the subsequent page. When paginating, all other
2280
+ # parameters provided to `ListCalculatedMetrics` must match the call that
2281
+ # provided the page token.
2282
+ # @param [String] fields
2283
+ # Selector specifying which fields to include in a partial response.
2284
+ # @param [String] quota_user
2285
+ # Available to use for quota purposes for server-side applications. Can be any
2286
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2287
+ # @param [Google::Apis::RequestOptions] options
2288
+ # Request-specific options
2289
+ #
2290
+ # @yield [result, err] Result & error if block supplied
2291
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse] parsed result object
2292
+ # @yieldparam err [StandardError] error object if request failed
2293
+ #
2294
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse]
2295
+ #
2296
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2297
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2298
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2299
+ def list_property_calculated_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2300
+ command = make_simple_command(:get, 'v1alpha/{+parent}/calculatedMetrics', options)
2301
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse::Representation
2302
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse
2303
+ command.params['parent'] = parent unless parent.nil?
2304
+ command.query['pageSize'] = page_size unless page_size.nil?
2305
+ command.query['pageToken'] = page_token unless page_token.nil?
2306
+ command.query['fields'] = fields unless fields.nil?
2307
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2308
+ execute_or_queue_command(command, &block)
2309
+ end
2310
+
2311
+ # Updates a CalculatedMetric on a property.
2312
+ # @param [String] name
2313
+ # Output only. Resource name for this CalculatedMetric. Format: 'properties/`
2314
+ # property_id`/calculatedMetrics/`calculated_metric_id`'
2315
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric] google_analytics_admin_v1alpha_calculated_metric_object
2316
+ # @param [String] update_mask
2317
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
2318
+ # To replace the entire entity, use one path with the string "*" to match all
2319
+ # fields.
2320
+ # @param [String] fields
2321
+ # Selector specifying which fields to include in a partial response.
2322
+ # @param [String] quota_user
2323
+ # Available to use for quota purposes for server-side applications. Can be any
2324
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2325
+ # @param [Google::Apis::RequestOptions] options
2326
+ # Request-specific options
2327
+ #
2328
+ # @yield [result, err] Result & error if block supplied
2329
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric] parsed result object
2330
+ # @yieldparam err [StandardError] error object if request failed
2331
+ #
2332
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric]
2333
+ #
2334
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2335
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2336
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2337
+ def patch_property_calculated_metric(name, google_analytics_admin_v1alpha_calculated_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2338
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2339
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
2340
+ command.request_object = google_analytics_admin_v1alpha_calculated_metric_object
2341
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric::Representation
2342
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCalculatedMetric
2343
+ command.params['name'] = name unless name.nil?
2344
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2345
+ command.query['fields'] = fields unless fields.nil?
2346
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2347
+ execute_or_queue_command(command, &block)
2348
+ end
2349
+
2162
2350
  # Creates a ChannelGroup.
2163
2351
  # @param [String] parent
2164
2352
  # Required. The property for which to create a ChannelGroup. Example 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.68.0
4
+ version: 0.69.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: 2023-12-17 00:00:00.000000000 Z
11
+ date: 2024-01-23 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.11.0
19
+ version: 0.12.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.11.0
29
+ version: 0.12.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.68.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.69.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.4.19
78
+ rubygems_version: 3.5.3
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Google Analytics Admin API V1alpha