google-analytics-data-v1beta 0.14.0 → 0.25.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 +4 -4
- data/.yardopts +1 -1
- data/README.md +37 -33
- data/lib/google/analytics/data/v1beta/analytics_data/client.rb +60 -17
- data/lib/google/analytics/data/v1beta/analytics_data/credentials.rb +1 -1
- data/lib/google/analytics/data/v1beta/analytics_data/operations.rb +52 -11
- data/lib/google/analytics/data/v1beta/analytics_data/paths.rb +1 -1
- data/lib/google/analytics/data/v1beta/analytics_data/rest/client.rb +40 -14
- data/lib/google/analytics/data/v1beta/analytics_data/rest/operations.rb +66 -34
- data/lib/google/analytics/data/v1beta/analytics_data/rest/service_stub.rb +103 -69
- data/lib/google/analytics/data/v1beta/analytics_data/rest.rb +1 -1
- data/lib/google/analytics/data/v1beta/analytics_data.rb +1 -1
- data/lib/google/analytics/data/v1beta/analytics_data_api_pb.rb +3 -26
- data/lib/google/analytics/data/v1beta/analytics_data_api_services_pb.rb +1 -1
- data/lib/google/analytics/data/v1beta/data_pb.rb +6 -24
- data/lib/google/analytics/data/v1beta/rest.rb +1 -1
- data/lib/google/analytics/data/v1beta/version.rb +1 -1
- data/lib/google/analytics/data/v1beta.rb +1 -1
- data/lib/google-analytics-data-v1beta.rb +1 -1
- data/proto_docs/README.md +1 -1
- data/proto_docs/google/analytics/data/v1beta/analytics_data_api.rb +1 -1
- data/proto_docs/google/analytics/data/v1beta/data.rb +115 -1
- data/proto_docs/google/api/client.rb +179 -26
- data/proto_docs/google/api/field_behavior.rb +1 -1
- data/proto_docs/google/api/launch_stage.rb +1 -1
- data/proto_docs/google/api/resource.rb +1 -1
- data/proto_docs/google/longrunning/operations.rb +23 -1
- data/proto_docs/google/protobuf/any.rb +1 -1
- data/proto_docs/google/protobuf/duration.rb +1 -1
- data/proto_docs/google/protobuf/empty.rb +1 -1
- data/proto_docs/google/protobuf/timestamp.rb +8 -7
- data/proto_docs/google/rpc/status.rb +1 -1
- metadata +15 -21
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -123,13 +123,19 @@ module Google
|
|
|
123
123
|
# @!attribute [rw] lower_case
|
|
124
124
|
# @return [::Google::Analytics::Data::V1beta::DimensionExpression::CaseExpression]
|
|
125
125
|
# Used to convert a dimension value to lower case.
|
|
126
|
+
#
|
|
127
|
+
# Note: The following fields are mutually exclusive: `lower_case`, `upper_case`, `concatenate`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
126
128
|
# @!attribute [rw] upper_case
|
|
127
129
|
# @return [::Google::Analytics::Data::V1beta::DimensionExpression::CaseExpression]
|
|
128
130
|
# Used to convert a dimension value to upper case.
|
|
131
|
+
#
|
|
132
|
+
# Note: The following fields are mutually exclusive: `upper_case`, `lower_case`, `concatenate`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
129
133
|
# @!attribute [rw] concatenate
|
|
130
134
|
# @return [::Google::Analytics::Data::V1beta::DimensionExpression::ConcatenateExpression]
|
|
131
135
|
# Used to combine dimension values to a single dimension.
|
|
132
136
|
# For example, dimension "country, city": concatenate(country, ", ", city).
|
|
137
|
+
#
|
|
138
|
+
# Note: The following fields are mutually exclusive: `concatenate`, `lower_case`, `upper_case`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
133
139
|
class DimensionExpression
|
|
134
140
|
include ::Google::Protobuf::MessageExts
|
|
135
141
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -214,10 +220,14 @@ module Google
|
|
|
214
220
|
# @!attribute [rw] dimension_filter
|
|
215
221
|
# @return [::Google::Analytics::Data::V1beta::FilterExpression]
|
|
216
222
|
# A basic comparison.
|
|
223
|
+
#
|
|
224
|
+
# Note: The following fields are mutually exclusive: `dimension_filter`, `comparison`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
217
225
|
# @!attribute [rw] comparison
|
|
218
226
|
# @return [::String]
|
|
219
227
|
# A saved comparison identified by the comparison's resource name.
|
|
220
228
|
# For example, 'comparisons/1234'.
|
|
229
|
+
#
|
|
230
|
+
# Note: The following fields are mutually exclusive: `comparison`, `dimension_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
221
231
|
class Comparison
|
|
222
232
|
include ::Google::Protobuf::MessageExts
|
|
223
233
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -228,16 +238,24 @@ module Google
|
|
|
228
238
|
# @!attribute [rw] and_group
|
|
229
239
|
# @return [::Google::Analytics::Data::V1beta::FilterExpressionList]
|
|
230
240
|
# The FilterExpressions in and_group have an AND relationship.
|
|
241
|
+
#
|
|
242
|
+
# Note: The following fields are mutually exclusive: `and_group`, `or_group`, `not_expression`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
231
243
|
# @!attribute [rw] or_group
|
|
232
244
|
# @return [::Google::Analytics::Data::V1beta::FilterExpressionList]
|
|
233
245
|
# The FilterExpressions in or_group have an OR relationship.
|
|
246
|
+
#
|
|
247
|
+
# Note: The following fields are mutually exclusive: `or_group`, `and_group`, `not_expression`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
234
248
|
# @!attribute [rw] not_expression
|
|
235
249
|
# @return [::Google::Analytics::Data::V1beta::FilterExpression]
|
|
236
250
|
# The FilterExpression is NOT of not_expression.
|
|
251
|
+
#
|
|
252
|
+
# Note: The following fields are mutually exclusive: `not_expression`, `and_group`, `or_group`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
237
253
|
# @!attribute [rw] filter
|
|
238
254
|
# @return [::Google::Analytics::Data::V1beta::Filter]
|
|
239
255
|
# A primitive filter. In the same FilterExpression, all of the filter's
|
|
240
256
|
# field names need to be either all dimensions or all metrics.
|
|
257
|
+
#
|
|
258
|
+
# Note: The following fields are mutually exclusive: `filter`, `and_group`, `or_group`, `not_expression`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
241
259
|
class FilterExpression
|
|
242
260
|
include ::Google::Protobuf::MessageExts
|
|
243
261
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -264,18 +282,28 @@ module Google
|
|
|
264
282
|
# @!attribute [rw] string_filter
|
|
265
283
|
# @return [::Google::Analytics::Data::V1beta::Filter::StringFilter]
|
|
266
284
|
# Strings related filter.
|
|
285
|
+
#
|
|
286
|
+
# Note: The following fields are mutually exclusive: `string_filter`, `in_list_filter`, `numeric_filter`, `between_filter`, `empty_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
267
287
|
# @!attribute [rw] in_list_filter
|
|
268
288
|
# @return [::Google::Analytics::Data::V1beta::Filter::InListFilter]
|
|
269
289
|
# A filter for in list values.
|
|
290
|
+
#
|
|
291
|
+
# Note: The following fields are mutually exclusive: `in_list_filter`, `string_filter`, `numeric_filter`, `between_filter`, `empty_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
270
292
|
# @!attribute [rw] numeric_filter
|
|
271
293
|
# @return [::Google::Analytics::Data::V1beta::Filter::NumericFilter]
|
|
272
294
|
# A filter for numeric or date values.
|
|
295
|
+
#
|
|
296
|
+
# Note: The following fields are mutually exclusive: `numeric_filter`, `string_filter`, `in_list_filter`, `between_filter`, `empty_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
273
297
|
# @!attribute [rw] between_filter
|
|
274
298
|
# @return [::Google::Analytics::Data::V1beta::Filter::BetweenFilter]
|
|
275
299
|
# A filter for two values.
|
|
300
|
+
#
|
|
301
|
+
# Note: The following fields are mutually exclusive: `between_filter`, `string_filter`, `in_list_filter`, `numeric_filter`, `empty_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
276
302
|
# @!attribute [rw] empty_filter
|
|
277
303
|
# @return [::Google::Analytics::Data::V1beta::Filter::EmptyFilter]
|
|
278
304
|
# A filter for empty values such as "(not set)" and "" values.
|
|
305
|
+
#
|
|
306
|
+
# Note: The following fields are mutually exclusive: `empty_filter`, `string_filter`, `in_list_filter`, `numeric_filter`, `between_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
279
307
|
class Filter
|
|
280
308
|
include ::Google::Protobuf::MessageExts
|
|
281
309
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -390,12 +418,18 @@ module Google
|
|
|
390
418
|
# @!attribute [rw] metric
|
|
391
419
|
# @return [::Google::Analytics::Data::V1beta::OrderBy::MetricOrderBy]
|
|
392
420
|
# Sorts results by a metric's values.
|
|
421
|
+
#
|
|
422
|
+
# Note: The following fields are mutually exclusive: `metric`, `dimension`, `pivot`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
393
423
|
# @!attribute [rw] dimension
|
|
394
424
|
# @return [::Google::Analytics::Data::V1beta::OrderBy::DimensionOrderBy]
|
|
395
425
|
# Sorts results by a dimension's values.
|
|
426
|
+
#
|
|
427
|
+
# Note: The following fields are mutually exclusive: `dimension`, `metric`, `pivot`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
396
428
|
# @!attribute [rw] pivot
|
|
397
429
|
# @return [::Google::Analytics::Data::V1beta::OrderBy::PivotOrderBy]
|
|
398
430
|
# Sorts results by a metric's values within a pivot column group.
|
|
431
|
+
#
|
|
432
|
+
# Note: The following fields are mutually exclusive: `pivot`, `metric`, `dimension`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
399
433
|
# @!attribute [rw] desc
|
|
400
434
|
# @return [::Boolean]
|
|
401
435
|
# If true, sorts by descending order.
|
|
@@ -724,6 +758,9 @@ module Google
|
|
|
724
758
|
# were specified in the request.
|
|
725
759
|
#
|
|
726
760
|
# However if the results are not sampled, this field will not be defined.
|
|
761
|
+
# @!attribute [rw] data_truncation_reasons
|
|
762
|
+
# @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::DataTruncationReason>]
|
|
763
|
+
# If set, indicate there is data truncation in the report.
|
|
727
764
|
class ResponseMetaData
|
|
728
765
|
include ::Google::Protobuf::MessageExts
|
|
729
766
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -753,6 +790,79 @@ module Google
|
|
|
753
790
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
754
791
|
end
|
|
755
792
|
end
|
|
793
|
+
|
|
794
|
+
# Describes a reason for data truncation in the report.
|
|
795
|
+
# @!attribute [rw] data_truncation_type
|
|
796
|
+
# @return [::Google::Analytics::Data::V1beta::ResponseMetaData::DataTruncationReason::DataTruncationType]
|
|
797
|
+
# The type of data truncation.
|
|
798
|
+
# @!attribute [rw] data_truncation_message
|
|
799
|
+
# @return [::String]
|
|
800
|
+
# A descriptive message explaining the data truncation.
|
|
801
|
+
# @!attribute [rw] data_truncation_date
|
|
802
|
+
# @return [::String]
|
|
803
|
+
# The data truncation date in the format YYYY-MM-DD.
|
|
804
|
+
# Indicates data before this date is truncated.
|
|
805
|
+
# @!attribute [rw] data_truncation_date_ranges
|
|
806
|
+
# @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::DataTruncationReason::DataTruncationDateRange>]
|
|
807
|
+
# The truncated date ranges.
|
|
808
|
+
class DataTruncationReason
|
|
809
|
+
include ::Google::Protobuf::MessageExts
|
|
810
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
811
|
+
|
|
812
|
+
# Define the truncated date range from start_date to end_date.
|
|
813
|
+
# @!attribute [rw] start_date
|
|
814
|
+
# @return [::String]
|
|
815
|
+
# The start date in the format YYYY-MM-DD (inclusive).
|
|
816
|
+
# @!attribute [rw] end_date
|
|
817
|
+
# @return [::String]
|
|
818
|
+
# The end date in the format YYYY-MM-DD (inclusive).
|
|
819
|
+
class DataTruncationDateRange
|
|
820
|
+
include ::Google::Protobuf::MessageExts
|
|
821
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
822
|
+
end
|
|
823
|
+
|
|
824
|
+
# The type of data truncation.
|
|
825
|
+
module DataTruncationType
|
|
826
|
+
# Unspecified type.
|
|
827
|
+
DATA_TRUNCATION_TYPE_UNSPECIFIED = 0
|
|
828
|
+
|
|
829
|
+
# Data is truncated in attribution report for rules-based models golden
|
|
830
|
+
# date.
|
|
831
|
+
DATA_TRUNCATION_TYPE_RULES_BASED_MODELS = 1
|
|
832
|
+
|
|
833
|
+
# Data is truncated in attribution report for data driven attribution
|
|
834
|
+
# golden date.
|
|
835
|
+
DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION = 2
|
|
836
|
+
|
|
837
|
+
# Data is truncated because DV360 policy does not permit data older than
|
|
838
|
+
# 2 years from being returned.
|
|
839
|
+
DATA_TRUNCATION_TYPE_DV360 = 3
|
|
840
|
+
|
|
841
|
+
# Data is truncated because CM360 policy does not permit data older than
|
|
842
|
+
# 2 years from being returned.
|
|
843
|
+
DATA_TRUNCATION_TYPE_CM360 = 4
|
|
844
|
+
|
|
845
|
+
# New item-scoped ecommerce metrics only have data after a specific date.
|
|
846
|
+
DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS = 5
|
|
847
|
+
|
|
848
|
+
# New event-scoped ecommerce metrics only have data after a specific
|
|
849
|
+
# date.
|
|
850
|
+
DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS = 6
|
|
851
|
+
|
|
852
|
+
# Query date range may not be fully served.
|
|
853
|
+
DATA_TRUNCATION_TYPE_DATE_RANGE = 7
|
|
854
|
+
|
|
855
|
+
# Data truncated because the query attempts to read event data prior
|
|
856
|
+
# to its retention date.
|
|
857
|
+
DATA_TRUNCATION_TYPE_PROPERTY = 8
|
|
858
|
+
|
|
859
|
+
# Data is truncated in conversions report.
|
|
860
|
+
DATA_TRUNCATION_TYPE_CONVERSIONS = 9
|
|
861
|
+
|
|
862
|
+
# Data is truncated due to Google Ads 36 month retention policy.
|
|
863
|
+
DATA_TRUNCATION_TYPE_GOOGLE_ADS = 10
|
|
864
|
+
end
|
|
865
|
+
end
|
|
756
866
|
end
|
|
757
867
|
|
|
758
868
|
# If this report results is
|
|
@@ -901,9 +1011,13 @@ module Google
|
|
|
901
1011
|
# @!attribute [rw] int64_value
|
|
902
1012
|
# @return [::Integer]
|
|
903
1013
|
# Integer value
|
|
1014
|
+
#
|
|
1015
|
+
# Note: The following fields are mutually exclusive: `int64_value`, `double_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
904
1016
|
# @!attribute [rw] double_value
|
|
905
1017
|
# @return [::Float]
|
|
906
1018
|
# Double value
|
|
1019
|
+
#
|
|
1020
|
+
# Note: The following fields are mutually exclusive: `double_value`, `int64_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
907
1021
|
class NumericValue
|
|
908
1022
|
include ::Google::Protobuf::MessageExts
|
|
909
1023
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -31,6 +31,8 @@ module Google
|
|
|
31
31
|
# @!attribute [rw] selective_gapic_generation
|
|
32
32
|
# @return [::Google::Api::SelectiveGapicGeneration]
|
|
33
33
|
# Configuration for which RPCs should be generated in the GAPIC client.
|
|
34
|
+
#
|
|
35
|
+
# Note: This field should not be used in most cases.
|
|
34
36
|
class CommonLanguageSettings
|
|
35
37
|
include ::Google::Protobuf::MessageExts
|
|
36
38
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -141,9 +143,10 @@ module Google
|
|
|
141
143
|
#
|
|
142
144
|
# Example of a YAML configuration::
|
|
143
145
|
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
146
|
+
# publishing:
|
|
147
|
+
# library_settings:
|
|
148
|
+
# java_settings:
|
|
149
|
+
# library_package: com.google.cloud.pubsub.v1
|
|
147
150
|
# @!attribute [rw] service_class_names
|
|
148
151
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
149
152
|
# Configure the Java class name to use instead of the service's for its
|
|
@@ -155,11 +158,11 @@ module Google
|
|
|
155
158
|
#
|
|
156
159
|
# Example of a YAML configuration::
|
|
157
160
|
#
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
162
|
-
#
|
|
161
|
+
# publishing:
|
|
162
|
+
# java_settings:
|
|
163
|
+
# service_class_names:
|
|
164
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
|
165
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
163
166
|
# @!attribute [rw] common
|
|
164
167
|
# @return [::Google::Api::CommonLanguageSettings]
|
|
165
168
|
# Some settings.
|
|
@@ -190,6 +193,20 @@ module Google
|
|
|
190
193
|
# @!attribute [rw] common
|
|
191
194
|
# @return [::Google::Api::CommonLanguageSettings]
|
|
192
195
|
# Some settings.
|
|
196
|
+
# @!attribute [rw] library_package
|
|
197
|
+
# @return [::String]
|
|
198
|
+
# The package name to use in Php. Clobbers the php_namespace option
|
|
199
|
+
# set in the protobuf. This should be used **only** by APIs
|
|
200
|
+
# who have already set the language_settings.php.package_name" field
|
|
201
|
+
# in gapic.yaml. API teams should use the protobuf php_namespace option
|
|
202
|
+
# where possible.
|
|
203
|
+
#
|
|
204
|
+
# Example of a YAML configuration::
|
|
205
|
+
#
|
|
206
|
+
# publishing:
|
|
207
|
+
# library_settings:
|
|
208
|
+
# php_settings:
|
|
209
|
+
# library_package: Google\Cloud\PubSub\V1
|
|
193
210
|
class PhpSettings
|
|
194
211
|
include ::Google::Protobuf::MessageExts
|
|
195
212
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -221,6 +238,12 @@ module Google
|
|
|
221
238
|
# Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
|
222
239
|
# enabled by default 1 month after launching the feature in preview
|
|
223
240
|
# packages.
|
|
241
|
+
# @!attribute [rw] unversioned_package_disabled
|
|
242
|
+
# @return [::Boolean]
|
|
243
|
+
# Disables generation of an unversioned Python package for this client
|
|
244
|
+
# library. This means that the module names will need to be versioned in
|
|
245
|
+
# import statements. For example `import google.cloud.library_v2` instead
|
|
246
|
+
# of `import google.cloud.library`.
|
|
224
247
|
class ExperimentalFeatures
|
|
225
248
|
include ::Google::Protobuf::MessageExts
|
|
226
249
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -306,9 +329,30 @@ module Google
|
|
|
306
329
|
# @!attribute [rw] common
|
|
307
330
|
# @return [::Google::Api::CommonLanguageSettings]
|
|
308
331
|
# Some settings.
|
|
332
|
+
# @!attribute [rw] renamed_services
|
|
333
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
334
|
+
# Map of service names to renamed services. Keys are the package relative
|
|
335
|
+
# service names and values are the name to be used for the service client
|
|
336
|
+
# and call options.
|
|
337
|
+
#
|
|
338
|
+
# Example:
|
|
339
|
+
#
|
|
340
|
+
# publishing:
|
|
341
|
+
# go_settings:
|
|
342
|
+
# renamed_services:
|
|
343
|
+
# Publisher: TopicAdmin
|
|
309
344
|
class GoSettings
|
|
310
345
|
include ::Google::Protobuf::MessageExts
|
|
311
346
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
347
|
+
|
|
348
|
+
# @!attribute [rw] key
|
|
349
|
+
# @return [::String]
|
|
350
|
+
# @!attribute [rw] value
|
|
351
|
+
# @return [::String]
|
|
352
|
+
class RenamedServicesEntry
|
|
353
|
+
include ::Google::Protobuf::MessageExts
|
|
354
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
355
|
+
end
|
|
312
356
|
end
|
|
313
357
|
|
|
314
358
|
# Describes the generator configuration for a method.
|
|
@@ -319,10 +363,10 @@ module Google
|
|
|
319
363
|
#
|
|
320
364
|
# Example:
|
|
321
365
|
#
|
|
322
|
-
#
|
|
323
|
-
#
|
|
324
|
-
#
|
|
325
|
-
#
|
|
366
|
+
# publishing:
|
|
367
|
+
# method_settings:
|
|
368
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
|
369
|
+
# # method settings for CreateFolder...
|
|
326
370
|
# @!attribute [rw] long_running
|
|
327
371
|
# @return [::Google::Api::MethodSettings::LongRunning]
|
|
328
372
|
# Describes settings to use for long-running operations when generating
|
|
@@ -331,14 +375,14 @@ module Google
|
|
|
331
375
|
#
|
|
332
376
|
# Example of a YAML configuration::
|
|
333
377
|
#
|
|
334
|
-
#
|
|
335
|
-
#
|
|
336
|
-
#
|
|
337
|
-
#
|
|
338
|
-
#
|
|
339
|
-
#
|
|
340
|
-
#
|
|
341
|
-
#
|
|
378
|
+
# publishing:
|
|
379
|
+
# method_settings:
|
|
380
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
381
|
+
# long_running:
|
|
382
|
+
# initial_poll_delay: 60s # 1 minute
|
|
383
|
+
# poll_delay_multiplier: 1.5
|
|
384
|
+
# max_poll_delay: 360s # 6 minutes
|
|
385
|
+
# total_poll_timeout: 54000s # 90 minutes
|
|
342
386
|
# @!attribute [rw] auto_populated_fields
|
|
343
387
|
# @return [::Array<::String>]
|
|
344
388
|
# List of top-level fields of the request message, that should be
|
|
@@ -347,11 +391,24 @@ module Google
|
|
|
347
391
|
#
|
|
348
392
|
# Example of a YAML configuration:
|
|
349
393
|
#
|
|
350
|
-
#
|
|
351
|
-
#
|
|
352
|
-
#
|
|
353
|
-
#
|
|
354
|
-
#
|
|
394
|
+
# publishing:
|
|
395
|
+
# method_settings:
|
|
396
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
397
|
+
# auto_populated_fields:
|
|
398
|
+
# - request_id
|
|
399
|
+
# @!attribute [rw] batching
|
|
400
|
+
# @return [::Google::Api::BatchingConfigProto]
|
|
401
|
+
# Batching configuration for an API method in client libraries.
|
|
402
|
+
#
|
|
403
|
+
# Example of a YAML configuration:
|
|
404
|
+
#
|
|
405
|
+
# publishing:
|
|
406
|
+
# method_settings:
|
|
407
|
+
# - selector: google.example.v1.ExampleService.BatchCreateExample
|
|
408
|
+
# batching:
|
|
409
|
+
# element_count_threshold: 1000
|
|
410
|
+
# request_byte_threshold: 100000000
|
|
411
|
+
# delay_threshold_millis: 10
|
|
355
412
|
class MethodSettings
|
|
356
413
|
include ::Google::Protobuf::MessageExts
|
|
357
414
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -386,15 +443,96 @@ module Google
|
|
|
386
443
|
|
|
387
444
|
# This message is used to configure the generation of a subset of the RPCs in
|
|
388
445
|
# a service for client libraries.
|
|
446
|
+
#
|
|
447
|
+
# Note: This feature should not be used in most cases.
|
|
389
448
|
# @!attribute [rw] methods
|
|
390
449
|
# @return [::Array<::String>]
|
|
391
450
|
# An allowlist of the fully qualified names of RPCs that should be included
|
|
392
451
|
# on public client surfaces.
|
|
452
|
+
# @!attribute [rw] generate_omitted_as_internal
|
|
453
|
+
# @return [::Boolean]
|
|
454
|
+
# Setting this to true indicates to the client generators that methods
|
|
455
|
+
# that would be excluded from the generation should instead be generated
|
|
456
|
+
# in a way that indicates these methods should not be consumed by
|
|
457
|
+
# end users. How this is expressed is up to individual language
|
|
458
|
+
# implementations to decide. Some examples may be: added annotations,
|
|
459
|
+
# obfuscated identifiers, or other language idiomatic patterns.
|
|
393
460
|
class SelectiveGapicGeneration
|
|
394
461
|
include ::Google::Protobuf::MessageExts
|
|
395
462
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
396
463
|
end
|
|
397
464
|
|
|
465
|
+
# `BatchingConfigProto` defines the batching configuration for an API method.
|
|
466
|
+
# @!attribute [rw] thresholds
|
|
467
|
+
# @return [::Google::Api::BatchingSettingsProto]
|
|
468
|
+
# The thresholds which trigger a batched request to be sent.
|
|
469
|
+
# @!attribute [rw] batch_descriptor
|
|
470
|
+
# @return [::Google::Api::BatchingDescriptorProto]
|
|
471
|
+
# The request and response fields used in batching.
|
|
472
|
+
class BatchingConfigProto
|
|
473
|
+
include ::Google::Protobuf::MessageExts
|
|
474
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
475
|
+
end
|
|
476
|
+
|
|
477
|
+
# `BatchingSettingsProto` specifies a set of batching thresholds, each of
|
|
478
|
+
# which acts as a trigger to send a batch of messages as a request. At least
|
|
479
|
+
# one threshold must be positive nonzero.
|
|
480
|
+
# @!attribute [rw] element_count_threshold
|
|
481
|
+
# @return [::Integer]
|
|
482
|
+
# The number of elements of a field collected into a batch which, if
|
|
483
|
+
# exceeded, causes the batch to be sent.
|
|
484
|
+
# @!attribute [rw] request_byte_threshold
|
|
485
|
+
# @return [::Integer]
|
|
486
|
+
# The aggregated size of the batched field which, if exceeded, causes the
|
|
487
|
+
# batch to be sent. This size is computed by aggregating the sizes of the
|
|
488
|
+
# request field to be batched, not of the entire request message.
|
|
489
|
+
# @!attribute [rw] delay_threshold
|
|
490
|
+
# @return [::Google::Protobuf::Duration]
|
|
491
|
+
# The duration after which a batch should be sent, starting from the addition
|
|
492
|
+
# of the first message to that batch.
|
|
493
|
+
# @!attribute [rw] element_count_limit
|
|
494
|
+
# @return [::Integer]
|
|
495
|
+
# The maximum number of elements collected in a batch that could be accepted
|
|
496
|
+
# by server.
|
|
497
|
+
# @!attribute [rw] request_byte_limit
|
|
498
|
+
# @return [::Integer]
|
|
499
|
+
# The maximum size of the request that could be accepted by server.
|
|
500
|
+
# @!attribute [rw] flow_control_element_limit
|
|
501
|
+
# @return [::Integer]
|
|
502
|
+
# The maximum number of elements allowed by flow control.
|
|
503
|
+
# @!attribute [rw] flow_control_byte_limit
|
|
504
|
+
# @return [::Integer]
|
|
505
|
+
# The maximum size of data allowed by flow control.
|
|
506
|
+
# @!attribute [rw] flow_control_limit_exceeded_behavior
|
|
507
|
+
# @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
|
|
508
|
+
# The behavior to take when the flow control limit is exceeded.
|
|
509
|
+
class BatchingSettingsProto
|
|
510
|
+
include ::Google::Protobuf::MessageExts
|
|
511
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
512
|
+
end
|
|
513
|
+
|
|
514
|
+
# `BatchingDescriptorProto` specifies the fields of the request message to be
|
|
515
|
+
# used for batching, and, optionally, the fields of the response message to be
|
|
516
|
+
# used for demultiplexing.
|
|
517
|
+
# @!attribute [rw] batched_field
|
|
518
|
+
# @return [::String]
|
|
519
|
+
# The repeated field in the request message to be aggregated by batching.
|
|
520
|
+
# @!attribute [rw] discriminator_fields
|
|
521
|
+
# @return [::Array<::String>]
|
|
522
|
+
# A list of the fields in the request message. Two requests will be batched
|
|
523
|
+
# together only if the values of every field specified in
|
|
524
|
+
# `request_discriminator_fields` is equal between the two requests.
|
|
525
|
+
# @!attribute [rw] subresponse_field
|
|
526
|
+
# @return [::String]
|
|
527
|
+
# Optional. When present, indicates the field in the response message to be
|
|
528
|
+
# used to demultiplex the response into multiple response messages, in
|
|
529
|
+
# correspondence with the multiple request messages originally batched
|
|
530
|
+
# together.
|
|
531
|
+
class BatchingDescriptorProto
|
|
532
|
+
include ::Google::Protobuf::MessageExts
|
|
533
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
534
|
+
end
|
|
535
|
+
|
|
398
536
|
# The organization for which the client libraries are being published.
|
|
399
537
|
# Affects the url where generated docs are published, etc.
|
|
400
538
|
module ClientLibraryOrganization
|
|
@@ -436,5 +574,20 @@ module Google
|
|
|
436
574
|
# Publish the library to package managers like nuget.org and npmjs.com.
|
|
437
575
|
PACKAGE_MANAGER = 20
|
|
438
576
|
end
|
|
577
|
+
|
|
578
|
+
# The behavior to take when the flow control limit is exceeded.
|
|
579
|
+
module FlowControlLimitExceededBehaviorProto
|
|
580
|
+
# Default behavior, system-defined.
|
|
581
|
+
UNSET_BEHAVIOR = 0
|
|
582
|
+
|
|
583
|
+
# Stop operation, raise error.
|
|
584
|
+
THROW_EXCEPTION = 1
|
|
585
|
+
|
|
586
|
+
# Pause operation until limit clears.
|
|
587
|
+
BLOCK = 2
|
|
588
|
+
|
|
589
|
+
# Continue operation, disregard limit.
|
|
590
|
+
IGNORE = 3
|
|
591
|
+
end
|
|
439
592
|
end
|
|
440
593
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -40,6 +40,8 @@ module Google
|
|
|
40
40
|
# @!attribute [rw] error
|
|
41
41
|
# @return [::Google::Rpc::Status]
|
|
42
42
|
# The error result of the operation in case of failure or cancellation.
|
|
43
|
+
#
|
|
44
|
+
# Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
43
45
|
# @!attribute [rw] response
|
|
44
46
|
# @return [::Google::Protobuf::Any]
|
|
45
47
|
# The normal, successful response of the operation. If the original
|
|
@@ -50,6 +52,8 @@ module Google
|
|
|
50
52
|
# is the original method name. For example, if the original method name
|
|
51
53
|
# is `TakeSnapshot()`, the inferred response type is
|
|
52
54
|
# `TakeSnapshotResponse`.
|
|
55
|
+
#
|
|
56
|
+
# Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
53
57
|
class Operation
|
|
54
58
|
include ::Google::Protobuf::MessageExts
|
|
55
59
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -79,6 +83,18 @@ module Google
|
|
|
79
83
|
# @!attribute [rw] page_token
|
|
80
84
|
# @return [::String]
|
|
81
85
|
# The standard list page token.
|
|
86
|
+
# @!attribute [rw] return_partial_success
|
|
87
|
+
# @return [::Boolean]
|
|
88
|
+
# When set to `true`, operations that are reachable are returned as normal,
|
|
89
|
+
# and those that are unreachable are returned in the
|
|
90
|
+
# [ListOperationsResponse.unreachable] field.
|
|
91
|
+
#
|
|
92
|
+
# This can only be `true` when reading across collections e.g. when `parent`
|
|
93
|
+
# is set to `"projects/example/locations/-"`.
|
|
94
|
+
#
|
|
95
|
+
# This field is not by default supported and will result in an
|
|
96
|
+
# `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
|
|
97
|
+
# service or product specific documentation.
|
|
82
98
|
class ListOperationsRequest
|
|
83
99
|
include ::Google::Protobuf::MessageExts
|
|
84
100
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -92,6 +108,12 @@ module Google
|
|
|
92
108
|
# @!attribute [rw] next_page_token
|
|
93
109
|
# @return [::String]
|
|
94
110
|
# The standard List next-page token.
|
|
111
|
+
# @!attribute [rw] unreachable
|
|
112
|
+
# @return [::Array<::String>]
|
|
113
|
+
# Unordered list. Unreachable resources. Populated when the request sets
|
|
114
|
+
# `ListOperationsRequest.return_partial_success` and reads across
|
|
115
|
+
# collections e.g. when attempting to list all resources across all supported
|
|
116
|
+
# locations.
|
|
95
117
|
class ListOperationsResponse
|
|
96
118
|
include ::Google::Protobuf::MessageExts
|
|
97
119
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -110,14 +110,15 @@ module Google
|
|
|
110
110
|
# ) to obtain a formatter capable of generating timestamps in this format.
|
|
111
111
|
# @!attribute [rw] seconds
|
|
112
112
|
# @return [::Integer]
|
|
113
|
-
# Represents seconds of UTC time since Unix epoch
|
|
114
|
-
#
|
|
115
|
-
# 9999-12-31T23:59:59Z
|
|
113
|
+
# Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must
|
|
114
|
+
# be between -315576000000 and 315576000000 inclusive (which corresponds to
|
|
115
|
+
# 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
|
|
116
116
|
# @!attribute [rw] nanos
|
|
117
117
|
# @return [::Integer]
|
|
118
|
-
# Non-negative fractions of a second at nanosecond resolution.
|
|
119
|
-
#
|
|
120
|
-
#
|
|
118
|
+
# Non-negative fractions of a second at nanosecond resolution. This field is
|
|
119
|
+
# the nanosecond portion of the duration, not an alternative to seconds.
|
|
120
|
+
# Negative second values with fractions must still have non-negative nanos
|
|
121
|
+
# values that count forward in time. Must be between 0 and 999,999,999
|
|
121
122
|
# inclusive.
|
|
122
123
|
class Timestamp
|
|
123
124
|
include ::Google::Protobuf::MessageExts
|