google-apis-analyticsadmin_v1alpha 0.80.0 → 0.81.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: 1fb55e4f1f0349bf8b386aebb2e87e79f20f8d897ccdc74d044a1ac933a4b94b
4
- data.tar.gz: bcea440db1c27cab7c1a5a1c6575a9dd10c5bafce74803100fd92484fec32da7
3
+ metadata.gz: 17590a1fee3255d2d0a2f902ccb23881e0bf2e090e03db577fe797f133599e87
4
+ data.tar.gz: 58e12eb2b888684b0fd43be2547f74850d001e90180690628f5209aa89ec1536
5
5
  SHA512:
6
- metadata.gz: 797b1773180ab84b7d9d6e9fd57c7a82bd4a809df674375ebe9a268207db6225d89e78a043963ed33bfd012928d1eabbd478dcf8f787959ec5f5736e9f59c349
7
- data.tar.gz: f48d95669761337fb10c5c3ea5846675a0e193edaf11c10c3fcabb58ce103c5cf6b73cde79076aae9cd53f1597554169bbfc00bc7fc5cf7c8c74a4f39a772e5c
6
+ metadata.gz: f634a914133df56ffb5158a67a97943daac04c7844abaa807fc861d6238b362ce76190f1ac8821aaf4c70b9daed68d08467d9370e2c58173616abe847eda036e
7
+ data.tar.gz: 60daa303a4b6cdd400823bf02f3f5f887e3307e597815e617c3e7912c16852069abd1300664a3e7f745d47b9a322616dd47aa6f2036b1ff8e23ac77cdaf245c5
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.81.0 (2025-04-06)
4
+
5
+ * Regenerated from discovery document revision 20250329
6
+
3
7
  ### v0.80.0 (2025-03-16)
4
8
 
5
9
  * Regenerated from discovery document revision 20250307
@@ -1903,6 +1903,12 @@ module Google
1903
1903
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
1904
1904
  attr_accessor :property
1905
1905
 
1906
+ # A Reporting Data Annotation is a comment connected to certain dates for
1907
+ # reporting data.
1908
+ # Corresponds to the JSON property `reportingDataAnnotation`
1909
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation]
1910
+ attr_accessor :reporting_data_annotation
1911
+
1906
1912
  # A link between a Google Analytics property and a Search Ads 360 entity.
1907
1913
  # Corresponds to the JSON property `searchAds360Link`
1908
1914
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link]
@@ -1943,6 +1949,7 @@ module Google
1943
1949
  @key_event = args[:key_event] if args.key?(:key_event)
1944
1950
  @measurement_protocol_secret = args[:measurement_protocol_secret] if args.key?(:measurement_protocol_secret)
1945
1951
  @property = args[:property] if args.key?(:property)
1952
+ @reporting_data_annotation = args[:reporting_data_annotation] if args.key?(:reporting_data_annotation)
1946
1953
  @search_ads360_link = args[:search_ads360_link] if args.key?(:search_ads360_link)
1947
1954
  @skadnetwork_conversion_value_schema = args[:skadnetwork_conversion_value_schema] if args.key?(:skadnetwork_conversion_value_schema)
1948
1955
  end
@@ -4574,6 +4581,32 @@ module Google
4574
4581
  end
4575
4582
  end
4576
4583
 
4584
+ # Response message for ListReportingDataAnnotation RPC.
4585
+ class GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse
4586
+ include Google::Apis::Core::Hashable
4587
+
4588
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
4589
+ # field is omitted, there are no subsequent pages.
4590
+ # Corresponds to the JSON property `nextPageToken`
4591
+ # @return [String]
4592
+ attr_accessor :next_page_token
4593
+
4594
+ # List of Reporting Data Annotations.
4595
+ # Corresponds to the JSON property `reportingDataAnnotations`
4596
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation>]
4597
+ attr_accessor :reporting_data_annotations
4598
+
4599
+ def initialize(**args)
4600
+ update!(**args)
4601
+ end
4602
+
4603
+ # Update properties of this object
4604
+ def update!(**args)
4605
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
4606
+ @reporting_data_annotations = args[:reporting_data_annotations] if args.key?(:reporting_data_annotations)
4607
+ end
4608
+ end
4609
+
4577
4610
  # Response message for ListRollupPropertySourceLinks RPC.
4578
4611
  class GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse
4579
4612
  include Google::Apis::Core::Hashable
@@ -5113,6 +5146,114 @@ module Google
5113
5146
  end
5114
5147
  end
5115
5148
 
5149
+ # A Reporting Data Annotation is a comment connected to certain dates for
5150
+ # reporting data.
5151
+ class GoogleAnalyticsAdminV1alphaReportingDataAnnotation
5152
+ include Google::Apis::Core::Hashable
5153
+
5154
+ # Represents a whole or partial calendar date, such as a birthday. The time of
5155
+ # day and time zone are either specified elsewhere or are insignificant. The
5156
+ # date is relative to the Gregorian Calendar. This can represent one of the
5157
+ # following: * A full date, with non-zero year, month, and day values. * A month
5158
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
5159
+ # with a zero month and a zero day. * A year and month, with a zero day (for
5160
+ # example, a credit card expiration date). Related types: * google.type.
5161
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
5162
+ # Corresponds to the JSON property `annotationDate`
5163
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate]
5164
+ attr_accessor :annotation_date
5165
+
5166
+ # Represents a Reporting Data Annotation's date range, both start and end dates
5167
+ # are inclusive. Time zones are based on the parent property.
5168
+ # Corresponds to the JSON property `annotationDateRange`
5169
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange]
5170
+ attr_accessor :annotation_date_range
5171
+
5172
+ # Required. The color used for display of this Reporting Data Annotation.
5173
+ # Corresponds to the JSON property `color`
5174
+ # @return [String]
5175
+ attr_accessor :color
5176
+
5177
+ # Optional. Description for this Reporting Data Annotation.
5178
+ # Corresponds to the JSON property `description`
5179
+ # @return [String]
5180
+ attr_accessor :description
5181
+
5182
+ # Required. Identifier. Resource name of this Reporting Data Annotation. Format:
5183
+ # 'properties/`property_id`/reportingDataAnnotations/`reporting_data_annotation`'
5184
+ # Format: 'properties/123/reportingDataAnnotations/456'
5185
+ # Corresponds to the JSON property `name`
5186
+ # @return [String]
5187
+ attr_accessor :name
5188
+
5189
+ # Output only. If true, this annotation was generated by the Google Analytics
5190
+ # system. System-generated annotations cannot be updated or deleted.
5191
+ # Corresponds to the JSON property `systemGenerated`
5192
+ # @return [Boolean]
5193
+ attr_accessor :system_generated
5194
+ alias_method :system_generated?, :system_generated
5195
+
5196
+ # Required. Human-readable title for this Reporting Data Annotation.
5197
+ # Corresponds to the JSON property `title`
5198
+ # @return [String]
5199
+ attr_accessor :title
5200
+
5201
+ def initialize(**args)
5202
+ update!(**args)
5203
+ end
5204
+
5205
+ # Update properties of this object
5206
+ def update!(**args)
5207
+ @annotation_date = args[:annotation_date] if args.key?(:annotation_date)
5208
+ @annotation_date_range = args[:annotation_date_range] if args.key?(:annotation_date_range)
5209
+ @color = args[:color] if args.key?(:color)
5210
+ @description = args[:description] if args.key?(:description)
5211
+ @name = args[:name] if args.key?(:name)
5212
+ @system_generated = args[:system_generated] if args.key?(:system_generated)
5213
+ @title = args[:title] if args.key?(:title)
5214
+ end
5215
+ end
5216
+
5217
+ # Represents a Reporting Data Annotation's date range, both start and end dates
5218
+ # are inclusive. Time zones are based on the parent property.
5219
+ class GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange
5220
+ include Google::Apis::Core::Hashable
5221
+
5222
+ # Represents a whole or partial calendar date, such as a birthday. The time of
5223
+ # day and time zone are either specified elsewhere or are insignificant. The
5224
+ # date is relative to the Gregorian Calendar. This can represent one of the
5225
+ # following: * A full date, with non-zero year, month, and day values. * A month
5226
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
5227
+ # with a zero month and a zero day. * A year and month, with a zero day (for
5228
+ # example, a credit card expiration date). Related types: * google.type.
5229
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
5230
+ # Corresponds to the JSON property `endDate`
5231
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate]
5232
+ attr_accessor :end_date
5233
+
5234
+ # Represents a whole or partial calendar date, such as a birthday. The time of
5235
+ # day and time zone are either specified elsewhere or are insignificant. The
5236
+ # date is relative to the Gregorian Calendar. This can represent one of the
5237
+ # following: * A full date, with non-zero year, month, and day values. * A month
5238
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
5239
+ # with a zero month and a zero day. * A year and month, with a zero day (for
5240
+ # example, a credit card expiration date). Related types: * google.type.
5241
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
5242
+ # Corresponds to the JSON property `startDate`
5243
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate]
5244
+ attr_accessor :start_date
5245
+
5246
+ def initialize(**args)
5247
+ update!(**args)
5248
+ end
5249
+
5250
+ # Update properties of this object
5251
+ def update!(**args)
5252
+ @end_date = args[:end_date] if args.key?(:end_date)
5253
+ @start_date = args[:start_date] if args.key?(:start_date)
5254
+ end
5255
+ end
5256
+
5116
5257
  # A link that references a source property under the parent rollup property.
5117
5258
  class GoogleAnalyticsAdminV1alphaRollupPropertySourceLink
5118
5259
  include Google::Apis::Core::Hashable
@@ -5791,6 +5932,47 @@ module Google
5791
5932
  def update!(**args)
5792
5933
  end
5793
5934
  end
5935
+
5936
+ # Represents a whole or partial calendar date, such as a birthday. The time of
5937
+ # day and time zone are either specified elsewhere or are insignificant. The
5938
+ # date is relative to the Gregorian Calendar. This can represent one of the
5939
+ # following: * A full date, with non-zero year, month, and day values. * A month
5940
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
5941
+ # with a zero month and a zero day. * A year and month, with a zero day (for
5942
+ # example, a credit card expiration date). Related types: * google.type.
5943
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
5944
+ class GoogleTypeDate
5945
+ include Google::Apis::Core::Hashable
5946
+
5947
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
5948
+ # specify a year by itself or a year and month where the day isn't significant.
5949
+ # Corresponds to the JSON property `day`
5950
+ # @return [Fixnum]
5951
+ attr_accessor :day
5952
+
5953
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
5954
+ # and day.
5955
+ # Corresponds to the JSON property `month`
5956
+ # @return [Fixnum]
5957
+ attr_accessor :month
5958
+
5959
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
5960
+ # year.
5961
+ # Corresponds to the JSON property `year`
5962
+ # @return [Fixnum]
5963
+ attr_accessor :year
5964
+
5965
+ def initialize(**args)
5966
+ update!(**args)
5967
+ end
5968
+
5969
+ # Update properties of this object
5970
+ def update!(**args)
5971
+ @day = args[:day] if args.key?(:day)
5972
+ @month = args[:month] if args.key?(:month)
5973
+ @year = args[:year] if args.key?(:year)
5974
+ end
5975
+ end
5794
5976
  end
5795
5977
  end
5796
5978
  end
@@ -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.80.0"
19
+ GEM_VERSION = "0.81.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.16.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250307"
25
+ REVISION = "20250329"
26
26
  end
27
27
  end
28
28
  end
@@ -814,6 +814,12 @@ module Google
814
814
  include Google::Apis::Core::JsonObjectSupport
815
815
  end
816
816
 
817
+ class GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse
818
+ class Representation < Google::Apis::Core::JsonRepresentation; end
819
+
820
+ include Google::Apis::Core::JsonObjectSupport
821
+ end
822
+
817
823
  class GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse
818
824
  class Representation < Google::Apis::Core::JsonRepresentation; end
819
825
 
@@ -910,6 +916,18 @@ module Google
910
916
  include Google::Apis::Core::JsonObjectSupport
911
917
  end
912
918
 
919
+ class GoogleAnalyticsAdminV1alphaReportingDataAnnotation
920
+ class Representation < Google::Apis::Core::JsonRepresentation; end
921
+
922
+ include Google::Apis::Core::JsonObjectSupport
923
+ end
924
+
925
+ class GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange
926
+ class Representation < Google::Apis::Core::JsonRepresentation; end
927
+
928
+ include Google::Apis::Core::JsonObjectSupport
929
+ end
930
+
913
931
  class GoogleAnalyticsAdminV1alphaRollupPropertySourceLink
914
932
  class Representation < Google::Apis::Core::JsonRepresentation; end
915
933
 
@@ -1012,6 +1030,12 @@ module Google
1012
1030
  include Google::Apis::Core::JsonObjectSupport
1013
1031
  end
1014
1032
 
1033
+ class GoogleTypeDate
1034
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1035
+
1036
+ include Google::Apis::Core::JsonObjectSupport
1037
+ end
1038
+
1015
1039
  class GoogleAnalyticsAdminV1alphaAccessBetweenFilter
1016
1040
  # @private
1017
1041
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1599,6 +1623,8 @@ module Google
1599
1623
 
1600
1624
  property :property, as: 'property', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
1601
1625
 
1626
+ property :reporting_data_annotation, as: 'reportingDataAnnotation', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
1627
+
1602
1628
  property :search_ads360_link, as: 'searchAds360Link', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
1603
1629
 
1604
1630
  property :skadnetwork_conversion_value_schema, as: 'skadnetworkConversionValueSchema', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSkAdNetworkConversionValueSchema, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSkAdNetworkConversionValueSchema::Representation
@@ -2335,6 +2361,15 @@ module Google
2335
2361
  end
2336
2362
  end
2337
2363
 
2364
+ class GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse
2365
+ # @private
2366
+ class Representation < Google::Apis::Core::JsonRepresentation
2367
+ property :next_page_token, as: 'nextPageToken'
2368
+ collection :reporting_data_annotations, as: 'reportingDataAnnotations', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
2369
+
2370
+ end
2371
+ end
2372
+
2338
2373
  class GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse
2339
2374
  # @private
2340
2375
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2487,6 +2522,31 @@ module Google
2487
2522
  end
2488
2523
  end
2489
2524
 
2525
+ class GoogleAnalyticsAdminV1alphaReportingDataAnnotation
2526
+ # @private
2527
+ class Representation < Google::Apis::Core::JsonRepresentation
2528
+ property :annotation_date, as: 'annotationDate', class: Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate::Representation
2529
+
2530
+ property :annotation_date_range, as: 'annotationDateRange', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange::Representation
2531
+
2532
+ property :color, as: 'color'
2533
+ property :description, as: 'description'
2534
+ property :name, as: 'name'
2535
+ property :system_generated, as: 'systemGenerated'
2536
+ property :title, as: 'title'
2537
+ end
2538
+ end
2539
+
2540
+ class GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange
2541
+ # @private
2542
+ class Representation < Google::Apis::Core::JsonRepresentation
2543
+ property :end_date, as: 'endDate', class: Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate::Representation
2544
+
2545
+ property :start_date, as: 'startDate', class: Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleTypeDate::Representation
2546
+
2547
+ end
2548
+ end
2549
+
2490
2550
  class GoogleAnalyticsAdminV1alphaRollupPropertySourceLink
2491
2551
  # @private
2492
2552
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2669,6 +2729,15 @@ module Google
2669
2729
  class Representation < Google::Apis::Core::JsonRepresentation
2670
2730
  end
2671
2731
  end
2732
+
2733
+ class GoogleTypeDate
2734
+ # @private
2735
+ class Representation < Google::Apis::Core::JsonRepresentation
2736
+ property :day, as: 'day'
2737
+ property :month, as: 'month'
2738
+ property :year, as: 'year'
2739
+ end
2740
+ end
2672
2741
  end
2673
2742
  end
2674
2743
  end
@@ -5259,6 +5259,207 @@ module Google
5259
5259
  execute_or_queue_command(command, &block)
5260
5260
  end
5261
5261
 
5262
+ # Creates a Reporting Data Annotation.
5263
+ # @param [String] parent
5264
+ # Required. The property for which to create a Reporting Data Annotation. Format:
5265
+ # properties/property_id Example: properties/123
5266
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation] google_analytics_admin_v1alpha_reporting_data_annotation_object
5267
+ # @param [String] fields
5268
+ # Selector specifying which fields to include in a partial response.
5269
+ # @param [String] quota_user
5270
+ # Available to use for quota purposes for server-side applications. Can be any
5271
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5272
+ # @param [Google::Apis::RequestOptions] options
5273
+ # Request-specific options
5274
+ #
5275
+ # @yield [result, err] Result & error if block supplied
5276
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation] parsed result object
5277
+ # @yieldparam err [StandardError] error object if request failed
5278
+ #
5279
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation]
5280
+ #
5281
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5282
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5283
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5284
+ def create_property_reporting_data_annotation(parent, google_analytics_admin_v1alpha_reporting_data_annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5285
+ command = make_simple_command(:post, 'v1alpha/{+parent}/reportingDataAnnotations', options)
5286
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
5287
+ command.request_object = google_analytics_admin_v1alpha_reporting_data_annotation_object
5288
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
5289
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation
5290
+ command.params['parent'] = parent unless parent.nil?
5291
+ command.query['fields'] = fields unless fields.nil?
5292
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5293
+ execute_or_queue_command(command, &block)
5294
+ end
5295
+
5296
+ # Deletes a Reporting Data Annotation.
5297
+ # @param [String] name
5298
+ # Required. Resource name of the Reporting Data Annotation to delete. Format:
5299
+ # properties/property_id/reportingDataAnnotations/reporting_data_annotation
5300
+ # Example: properties/123/reportingDataAnnotations/456
5301
+ # @param [String] fields
5302
+ # Selector specifying which fields to include in a partial response.
5303
+ # @param [String] quota_user
5304
+ # Available to use for quota purposes for server-side applications. Can be any
5305
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5306
+ # @param [Google::Apis::RequestOptions] options
5307
+ # Request-specific options
5308
+ #
5309
+ # @yield [result, err] Result & error if block supplied
5310
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
5311
+ # @yieldparam err [StandardError] error object if request failed
5312
+ #
5313
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
5314
+ #
5315
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5316
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5317
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5318
+ def delete_property_reporting_data_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
5319
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
5320
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
5321
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
5322
+ command.params['name'] = name unless name.nil?
5323
+ command.query['fields'] = fields unless fields.nil?
5324
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5325
+ execute_or_queue_command(command, &block)
5326
+ end
5327
+
5328
+ # Lookup a single Reporting Data Annotation.
5329
+ # @param [String] name
5330
+ # Required. Resource name of the Reporting Data Annotation to lookup. Format:
5331
+ # properties/property_id/reportingDataAnnotations/reportingDataAnnotation
5332
+ # Example: properties/123/reportingDataAnnotations/456
5333
+ # @param [String] fields
5334
+ # Selector specifying which fields to include in a partial response.
5335
+ # @param [String] quota_user
5336
+ # Available to use for quota purposes for server-side applications. Can be any
5337
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5338
+ # @param [Google::Apis::RequestOptions] options
5339
+ # Request-specific options
5340
+ #
5341
+ # @yield [result, err] Result & error if block supplied
5342
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation] parsed result object
5343
+ # @yieldparam err [StandardError] error object if request failed
5344
+ #
5345
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation]
5346
+ #
5347
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5348
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5349
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5350
+ def get_property_reporting_data_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
5351
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5352
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
5353
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation
5354
+ command.params['name'] = name unless name.nil?
5355
+ command.query['fields'] = fields unless fields.nil?
5356
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5357
+ execute_or_queue_command(command, &block)
5358
+ end
5359
+
5360
+ # List all Reporting Data Annotations on a property.
5361
+ # @param [String] parent
5362
+ # Required. Resource name of the property. Format: properties/property_id
5363
+ # Example: properties/123
5364
+ # @param [String] filter
5365
+ # Optional. Filter that restricts which reporting data annotations under the
5366
+ # parent property are listed. Supported fields are: * 'name' * `title` * `
5367
+ # description` * `annotation_date` * `annotation_date_range` * `color`
5368
+ # Additionally, this API provides the following helper functions: *
5369
+ # annotation_duration() : the duration that this annotation marks, [durations](
5370
+ # https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/
5371
+ # duration.proto). expect a numeric representation of seconds followed by an `s`
5372
+ # suffix. * is_annotation_in_range(start_date, end_date) : if the annotation is
5373
+ # in the range specified by the `start_date` and `end_date`. The dates are in
5374
+ # ISO-8601 format, for example `2031-06-28`. Supported operations: * `=` :
5375
+ # equals * `!=` : not equals * `<` : less than * `>` : greater than * `<=` :
5376
+ # less than or equals * `>=` : greater than or equals * `:` : has operator * `=~`
5377
+ # : [regular expression](https://github.com/google/re2/wiki/Syntax) match * `!~`
5378
+ # : [regular expression](https://github.com/google/re2/wiki/Syntax) does not
5379
+ # match * `NOT` : Logical not * `AND` : Logical and * `OR` : Logical or Examples:
5380
+ # 1. `title="Holiday Sale"` 2. `description=~"[Bb]ig [Gg]ame.*[Ss]ale"` 3. `
5381
+ # is_annotation_in_range("2025-12-25", "2026-01-16") = true` 4. `
5382
+ # annotation_duration() >= 172800s AND title:BOGO`
5383
+ # @param [Fixnum] page_size
5384
+ # Optional. The maximum number of resources to return. The service may return
5385
+ # fewer than this value, even if there are additional pages. If unspecified, at
5386
+ # most 50 resources will be returned. The maximum value is 200; (higher values
5387
+ # will be coerced to the maximum)
5388
+ # @param [String] page_token
5389
+ # Optional. A page token, received from a previous `ListReportingDataAnnotations`
5390
+ # call. Provide this to retrieve the subsequent page. When paginating, all
5391
+ # other parameters provided to `ListReportingDataAnnotations` must match the
5392
+ # call that provided the page token.
5393
+ # @param [String] fields
5394
+ # Selector specifying which fields to include in a partial response.
5395
+ # @param [String] quota_user
5396
+ # Available to use for quota purposes for server-side applications. Can be any
5397
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5398
+ # @param [Google::Apis::RequestOptions] options
5399
+ # Request-specific options
5400
+ #
5401
+ # @yield [result, err] Result & error if block supplied
5402
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse] parsed result object
5403
+ # @yieldparam err [StandardError] error object if request failed
5404
+ #
5405
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse]
5406
+ #
5407
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5408
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5409
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5410
+ def list_property_reporting_data_annotations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5411
+ command = make_simple_command(:get, 'v1alpha/{+parent}/reportingDataAnnotations', options)
5412
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse::Representation
5413
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse
5414
+ command.params['parent'] = parent unless parent.nil?
5415
+ command.query['filter'] = filter unless filter.nil?
5416
+ command.query['pageSize'] = page_size unless page_size.nil?
5417
+ command.query['pageToken'] = page_token unless page_token.nil?
5418
+ command.query['fields'] = fields unless fields.nil?
5419
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5420
+ execute_or_queue_command(command, &block)
5421
+ end
5422
+
5423
+ # Updates a Reporting Data Annotation.
5424
+ # @param [String] name
5425
+ # Required. Identifier. Resource name of this Reporting Data Annotation. Format:
5426
+ # 'properties/`property_id`/reportingDataAnnotations/`reporting_data_annotation`'
5427
+ # Format: 'properties/123/reportingDataAnnotations/456'
5428
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation] google_analytics_admin_v1alpha_reporting_data_annotation_object
5429
+ # @param [String] update_mask
5430
+ # Optional. The list of fields to update. Field names must be in snake case (for
5431
+ # example, "field_to_update"). Omitted fields will not be updated. To replace
5432
+ # the entire entity, use one path with the string "*" to match all fields.
5433
+ # @param [String] fields
5434
+ # Selector specifying which fields to include in a partial response.
5435
+ # @param [String] quota_user
5436
+ # Available to use for quota purposes for server-side applications. Can be any
5437
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5438
+ # @param [Google::Apis::RequestOptions] options
5439
+ # Request-specific options
5440
+ #
5441
+ # @yield [result, err] Result & error if block supplied
5442
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation] parsed result object
5443
+ # @yieldparam err [StandardError] error object if request failed
5444
+ #
5445
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation]
5446
+ #
5447
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5448
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5449
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5450
+ def patch_property_reporting_data_annotation(name, google_analytics_admin_v1alpha_reporting_data_annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5451
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
5452
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
5453
+ command.request_object = google_analytics_admin_v1alpha_reporting_data_annotation_object
5454
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation::Representation
5455
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaReportingDataAnnotation
5456
+ command.params['name'] = name unless name.nil?
5457
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5458
+ command.query['fields'] = fields unless fields.nil?
5459
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5460
+ execute_or_queue_command(command, &block)
5461
+ end
5462
+
5262
5463
  # Creates a roll-up property source link. Only roll-up properties can have
5263
5464
  # source links, so this method will throw an error if used on other types of
5264
5465
  # properties.
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsadmin_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.80.0
4
+ version: 0.81.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-16 00:00:00.000000000 Z
10
+ date: 2025-04-16 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.80.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.81.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
62
62
  rdoc_options: []
63
63
  require_paths: