google-analytics-data-v1beta 0.8.0 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/analytics/data/v1beta/analytics_data/client.rb +27 -8
- data/lib/google/analytics/data/v1beta/analytics_data/rest/client.rb +129 -7
- data/lib/google/analytics/data/v1beta/version.rb +1 -1
- data/proto_docs/google/analytics/data/v1beta/analytics_data_api.rb +17 -7
- data/proto_docs/google/analytics/data/v1beta/data.rb +24 -12
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +11 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 570cf1cbf5187f15600fadcb2223c1721999a87a3b809334ef73960b397524a3
|
4
|
+
data.tar.gz: 74e0f13e61efdc3bbcefaaeafb8181d073a6825d320e4e48f356a9fd0a17bc9f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7f562f68b967149514eeac075a7f6053eedb13e92548768df99b066d790b7680f5341030a76905f409580da5562de4c2b7d08dc552607a4e06be6a937b2492bf
|
7
|
+
data.tar.gz: 9419b73ea878e80922a2b0d695d2848b8692497ea2b1997d48d242787c341e1c40ce6db142272f70b946dd3058186ea2affac574d088bd93d19be3684c11b891
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Ruby Client for the Google Analytics Data V1beta API
|
2
2
|
|
3
|
-
Accesses report data in Google Analytics.
|
3
|
+
Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.
|
4
4
|
|
5
5
|
The Google Analytics Data API provides programmatic methods to access report data in Google Analytics 4 (GA4) properties. Google Analytics 4 helps you understand how people use your web, iOS, or Android app.
|
6
6
|
|
@@ -157,7 +157,8 @@ module Google
|
|
157
157
|
credentials: credentials,
|
158
158
|
endpoint: @config.endpoint,
|
159
159
|
channel_args: @config.channel_args,
|
160
|
-
interceptors: @config.interceptors
|
160
|
+
interceptors: @config.interceptors,
|
161
|
+
channel_pool_config: @config.channel_pool
|
161
162
|
)
|
162
163
|
end
|
163
164
|
|
@@ -211,7 +212,7 @@ module Google
|
|
211
212
|
# response rows for both date ranges. In a cohort request, this `dateRanges`
|
212
213
|
# must be unspecified.
|
213
214
|
# @param dimension_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
|
214
|
-
# Dimension filters
|
215
|
+
# Dimension filters let you ask for only specific dimension values in
|
215
216
|
# the report. To learn more, see [Fundamentals of Dimension
|
216
217
|
# Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
|
217
218
|
# for examples. Metrics cannot be used in this filter.
|
@@ -230,7 +231,7 @@ module Google
|
|
230
231
|
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
231
232
|
# @param limit [::Integer]
|
232
233
|
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
233
|
-
# API returns a maximum of
|
234
|
+
# API returns a maximum of 250,000 rows per request, no matter how many you
|
234
235
|
# ask for. `limit` must be positive.
|
235
236
|
#
|
236
237
|
# The API can also return fewer rows than the requested `limit`, if there
|
@@ -256,6 +257,13 @@ module Google
|
|
256
257
|
# If false or unspecified, each row with all metrics equal to 0 will not be
|
257
258
|
# returned. If true, these rows will be returned if they are not separately
|
258
259
|
# removed by a filter.
|
260
|
+
#
|
261
|
+
# Regardless of this `keep_empty_rows` setting, only data recorded by the
|
262
|
+
# Google Analytics (GA4) property can be displayed in a report.
|
263
|
+
#
|
264
|
+
# For example if a property never logs a `purchase` event, then a query for
|
265
|
+
# the `eventName` dimension and `eventCount` metric will not have a row
|
266
|
+
# eventName: "purchase" and eventCount: 0.
|
259
267
|
# @param return_property_quota [::Boolean]
|
260
268
|
# Toggles whether to return the current state of this Analytics Property's
|
261
269
|
# quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
@@ -390,6 +398,13 @@ module Google
|
|
390
398
|
# If false or unspecified, each row with all metrics equal to 0 will not be
|
391
399
|
# returned. If true, these rows will be returned if they are not separately
|
392
400
|
# removed by a filter.
|
401
|
+
#
|
402
|
+
# Regardless of this `keep_empty_rows` setting, only data recorded by the
|
403
|
+
# Google Analytics (GA4) property can be displayed in a report.
|
404
|
+
#
|
405
|
+
# For example if a property never logs a `purchase` event, then a query for
|
406
|
+
# the `eventName` dimension and `eventCount` metric will not have a row
|
407
|
+
# eventName: "purchase" and eventCount: 0.
|
393
408
|
# @param return_property_quota [::Boolean]
|
394
409
|
# Toggles whether to return the current state of this Analytics Property's
|
395
410
|
# quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
@@ -800,7 +815,7 @@ module Google
|
|
800
815
|
# SQL having-clause. Dimensions cannot be used in this filter.
|
801
816
|
# @param limit [::Integer]
|
802
817
|
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
803
|
-
# API returns a maximum of
|
818
|
+
# API returns a maximum of 250,000 rows per request, no matter how many you
|
804
819
|
# ask for. `limit` must be positive.
|
805
820
|
#
|
806
821
|
# The API can also return fewer rows than the requested `limit`, if there
|
@@ -921,10 +936,6 @@ module Google
|
|
921
936
|
# `property` should be the same value as in your `runReport` request.
|
922
937
|
#
|
923
938
|
# Example: properties/1234
|
924
|
-
#
|
925
|
-
# Set the Property ID to 0 for compatibility checking on dimensions and
|
926
|
-
# metrics common to all properties. In this special mode, this method will
|
927
|
-
# not return custom dimensions and metrics.
|
928
939
|
# @param dimensions [::Array<::Google::Analytics::Data::V1beta::Dimension, ::Hash>]
|
929
940
|
# The dimensions in this report. `dimensions` should be the same value as in
|
930
941
|
# your `runReport` request.
|
@@ -1125,6 +1136,14 @@ module Google
|
|
1125
1136
|
end
|
1126
1137
|
end
|
1127
1138
|
|
1139
|
+
##
|
1140
|
+
# Configuration for the channel pool
|
1141
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1142
|
+
#
|
1143
|
+
def channel_pool
|
1144
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1145
|
+
end
|
1146
|
+
|
1128
1147
|
##
|
1129
1148
|
# Configuration RPC class for the AnalyticsData API.
|
1130
1149
|
#
|
@@ -202,7 +202,7 @@ module Google
|
|
202
202
|
# response rows for both date ranges. In a cohort request, this `dateRanges`
|
203
203
|
# must be unspecified.
|
204
204
|
# @param dimension_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
|
205
|
-
# Dimension filters
|
205
|
+
# Dimension filters let you ask for only specific dimension values in
|
206
206
|
# the report. To learn more, see [Fundamentals of Dimension
|
207
207
|
# Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
|
208
208
|
# for examples. Metrics cannot be used in this filter.
|
@@ -221,7 +221,7 @@ module Google
|
|
221
221
|
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
222
222
|
# @param limit [::Integer]
|
223
223
|
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
224
|
-
# API returns a maximum of
|
224
|
+
# API returns a maximum of 250,000 rows per request, no matter how many you
|
225
225
|
# ask for. `limit` must be positive.
|
226
226
|
#
|
227
227
|
# The API can also return fewer rows than the requested `limit`, if there
|
@@ -247,6 +247,13 @@ module Google
|
|
247
247
|
# If false or unspecified, each row with all metrics equal to 0 will not be
|
248
248
|
# returned. If true, these rows will be returned if they are not separately
|
249
249
|
# removed by a filter.
|
250
|
+
#
|
251
|
+
# Regardless of this `keep_empty_rows` setting, only data recorded by the
|
252
|
+
# Google Analytics (GA4) property can be displayed in a report.
|
253
|
+
#
|
254
|
+
# For example if a property never logs a `purchase` event, then a query for
|
255
|
+
# the `eventName` dimension and `eventCount` metric will not have a row
|
256
|
+
# eventName: "purchase" and eventCount: 0.
|
250
257
|
# @param return_property_quota [::Boolean]
|
251
258
|
# Toggles whether to return the current state of this Analytics Property's
|
252
259
|
# quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
@@ -257,6 +264,22 @@ module Google
|
|
257
264
|
# @return [::Google::Analytics::Data::V1beta::RunReportResponse]
|
258
265
|
#
|
259
266
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
267
|
+
#
|
268
|
+
# @example Basic example
|
269
|
+
# require "google/analytics/data/v1beta"
|
270
|
+
#
|
271
|
+
# # Create a client object. The client can be reused for multiple calls.
|
272
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
273
|
+
#
|
274
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
275
|
+
# request = Google::Analytics::Data::V1beta::RunReportRequest.new
|
276
|
+
#
|
277
|
+
# # Call the run_report method.
|
278
|
+
# result = client.run_report request
|
279
|
+
#
|
280
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::RunReportResponse.
|
281
|
+
# p result
|
282
|
+
#
|
260
283
|
def run_report request, options = nil
|
261
284
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
262
285
|
|
@@ -358,6 +381,13 @@ module Google
|
|
358
381
|
# If false or unspecified, each row with all metrics equal to 0 will not be
|
359
382
|
# returned. If true, these rows will be returned if they are not separately
|
360
383
|
# removed by a filter.
|
384
|
+
#
|
385
|
+
# Regardless of this `keep_empty_rows` setting, only data recorded by the
|
386
|
+
# Google Analytics (GA4) property can be displayed in a report.
|
387
|
+
#
|
388
|
+
# For example if a property never logs a `purchase` event, then a query for
|
389
|
+
# the `eventName` dimension and `eventCount` metric will not have a row
|
390
|
+
# eventName: "purchase" and eventCount: 0.
|
361
391
|
# @param return_property_quota [::Boolean]
|
362
392
|
# Toggles whether to return the current state of this Analytics Property's
|
363
393
|
# quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
@@ -368,6 +398,22 @@ module Google
|
|
368
398
|
# @return [::Google::Analytics::Data::V1beta::RunPivotReportResponse]
|
369
399
|
#
|
370
400
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
401
|
+
#
|
402
|
+
# @example Basic example
|
403
|
+
# require "google/analytics/data/v1beta"
|
404
|
+
#
|
405
|
+
# # Create a client object. The client can be reused for multiple calls.
|
406
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
407
|
+
#
|
408
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
409
|
+
# request = Google::Analytics::Data::V1beta::RunPivotReportRequest.new
|
410
|
+
#
|
411
|
+
# # Call the run_pivot_report method.
|
412
|
+
# result = client.run_pivot_report request
|
413
|
+
#
|
414
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::RunPivotReportResponse.
|
415
|
+
# p result
|
416
|
+
#
|
371
417
|
def run_pivot_report request, options = nil
|
372
418
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
373
419
|
|
@@ -442,6 +488,22 @@ module Google
|
|
442
488
|
# @return [::Google::Analytics::Data::V1beta::BatchRunReportsResponse]
|
443
489
|
#
|
444
490
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
491
|
+
#
|
492
|
+
# @example Basic example
|
493
|
+
# require "google/analytics/data/v1beta"
|
494
|
+
#
|
495
|
+
# # Create a client object. The client can be reused for multiple calls.
|
496
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
497
|
+
#
|
498
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
499
|
+
# request = Google::Analytics::Data::V1beta::BatchRunReportsRequest.new
|
500
|
+
#
|
501
|
+
# # Call the batch_run_reports method.
|
502
|
+
# result = client.batch_run_reports request
|
503
|
+
#
|
504
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::BatchRunReportsResponse.
|
505
|
+
# p result
|
506
|
+
#
|
445
507
|
def batch_run_reports request, options = nil
|
446
508
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
447
509
|
|
@@ -516,6 +578,22 @@ module Google
|
|
516
578
|
# @return [::Google::Analytics::Data::V1beta::BatchRunPivotReportsResponse]
|
517
579
|
#
|
518
580
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
581
|
+
#
|
582
|
+
# @example Basic example
|
583
|
+
# require "google/analytics/data/v1beta"
|
584
|
+
#
|
585
|
+
# # Create a client object. The client can be reused for multiple calls.
|
586
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
587
|
+
#
|
588
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
589
|
+
# request = Google::Analytics::Data::V1beta::BatchRunPivotReportsRequest.new
|
590
|
+
#
|
591
|
+
# # Call the batch_run_pivot_reports method.
|
592
|
+
# result = client.batch_run_pivot_reports request
|
593
|
+
#
|
594
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::BatchRunPivotReportsResponse.
|
595
|
+
# p result
|
596
|
+
#
|
519
597
|
def batch_run_pivot_reports request, options = nil
|
520
598
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
521
599
|
|
@@ -597,6 +675,22 @@ module Google
|
|
597
675
|
# @return [::Google::Analytics::Data::V1beta::Metadata]
|
598
676
|
#
|
599
677
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
678
|
+
#
|
679
|
+
# @example Basic example
|
680
|
+
# require "google/analytics/data/v1beta"
|
681
|
+
#
|
682
|
+
# # Create a client object. The client can be reused for multiple calls.
|
683
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
684
|
+
#
|
685
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
686
|
+
# request = Google::Analytics::Data::V1beta::GetMetadataRequest.new
|
687
|
+
#
|
688
|
+
# # Call the get_metadata method.
|
689
|
+
# result = client.get_metadata request
|
690
|
+
#
|
691
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::Metadata.
|
692
|
+
# p result
|
693
|
+
#
|
600
694
|
def get_metadata request, options = nil
|
601
695
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
602
696
|
|
@@ -676,7 +770,7 @@ module Google
|
|
676
770
|
# SQL having-clause. Dimensions cannot be used in this filter.
|
677
771
|
# @param limit [::Integer]
|
678
772
|
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
679
|
-
# API returns a maximum of
|
773
|
+
# API returns a maximum of 250,000 rows per request, no matter how many you
|
680
774
|
# ask for. `limit` must be positive.
|
681
775
|
#
|
682
776
|
# The API can also return fewer rows than the requested `limit`, if there
|
@@ -705,6 +799,22 @@ module Google
|
|
705
799
|
# @return [::Google::Analytics::Data::V1beta::RunRealtimeReportResponse]
|
706
800
|
#
|
707
801
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
802
|
+
#
|
803
|
+
# @example Basic example
|
804
|
+
# require "google/analytics/data/v1beta"
|
805
|
+
#
|
806
|
+
# # Create a client object. The client can be reused for multiple calls.
|
807
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
808
|
+
#
|
809
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
810
|
+
# request = Google::Analytics::Data::V1beta::RunRealtimeReportRequest.new
|
811
|
+
#
|
812
|
+
# # Call the run_realtime_report method.
|
813
|
+
# result = client.run_realtime_report request
|
814
|
+
#
|
815
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::RunRealtimeReportResponse.
|
816
|
+
# p result
|
817
|
+
#
|
708
818
|
def run_realtime_report request, options = nil
|
709
819
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
710
820
|
|
@@ -774,10 +884,6 @@ module Google
|
|
774
884
|
# `property` should be the same value as in your `runReport` request.
|
775
885
|
#
|
776
886
|
# Example: properties/1234
|
777
|
-
#
|
778
|
-
# Set the Property ID to 0 for compatibility checking on dimensions and
|
779
|
-
# metrics common to all properties. In this special mode, this method will
|
780
|
-
# not return custom dimensions and metrics.
|
781
887
|
# @param dimensions [::Array<::Google::Analytics::Data::V1beta::Dimension, ::Hash>]
|
782
888
|
# The dimensions in this report. `dimensions` should be the same value as in
|
783
889
|
# your `runReport` request.
|
@@ -801,6 +907,22 @@ module Google
|
|
801
907
|
# @return [::Google::Analytics::Data::V1beta::CheckCompatibilityResponse]
|
802
908
|
#
|
803
909
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
910
|
+
#
|
911
|
+
# @example Basic example
|
912
|
+
# require "google/analytics/data/v1beta"
|
913
|
+
#
|
914
|
+
# # Create a client object. The client can be reused for multiple calls.
|
915
|
+
# client = Google::Analytics::Data::V1beta::AnalyticsData::Rest::Client.new
|
916
|
+
#
|
917
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
918
|
+
# request = Google::Analytics::Data::V1beta::CheckCompatibilityRequest.new
|
919
|
+
#
|
920
|
+
# # Call the check_compatibility method.
|
921
|
+
# result = client.check_compatibility request
|
922
|
+
#
|
923
|
+
# # The returned object is of type Google::Analytics::Data::V1beta::CheckCompatibilityResponse.
|
924
|
+
# p result
|
925
|
+
#
|
804
926
|
def check_compatibility request, options = nil
|
805
927
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
806
928
|
|
@@ -33,10 +33,6 @@ module Google
|
|
33
33
|
# `property` should be the same value as in your `runReport` request.
|
34
34
|
#
|
35
35
|
# Example: properties/1234
|
36
|
-
#
|
37
|
-
# Set the Property ID to 0 for compatibility checking on dimensions and
|
38
|
-
# metrics common to all properties. In this special mode, this method will
|
39
|
-
# not return custom dimensions and metrics.
|
40
36
|
# @!attribute [rw] dimensions
|
41
37
|
# @return [::Array<::Google::Analytics::Data::V1beta::Dimension>]
|
42
38
|
# The dimensions in this report. `dimensions` should be the same value as in
|
@@ -116,7 +112,7 @@ module Google
|
|
116
112
|
# must be unspecified.
|
117
113
|
# @!attribute [rw] dimension_filter
|
118
114
|
# @return [::Google::Analytics::Data::V1beta::FilterExpression]
|
119
|
-
# Dimension filters
|
115
|
+
# Dimension filters let you ask for only specific dimension values in
|
120
116
|
# the report. To learn more, see [Fundamentals of Dimension
|
121
117
|
# Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
|
122
118
|
# for examples. Metrics cannot be used in this filter.
|
@@ -138,7 +134,7 @@ module Google
|
|
138
134
|
# @!attribute [rw] limit
|
139
135
|
# @return [::Integer]
|
140
136
|
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
141
|
-
# API returns a maximum of
|
137
|
+
# API returns a maximum of 250,000 rows per request, no matter how many you
|
142
138
|
# ask for. `limit` must be positive.
|
143
139
|
#
|
144
140
|
# The API can also return fewer rows than the requested `limit`, if there
|
@@ -169,6 +165,13 @@ module Google
|
|
169
165
|
# If false or unspecified, each row with all metrics equal to 0 will not be
|
170
166
|
# returned. If true, these rows will be returned if they are not separately
|
171
167
|
# removed by a filter.
|
168
|
+
#
|
169
|
+
# Regardless of this `keep_empty_rows` setting, only data recorded by the
|
170
|
+
# Google Analytics (GA4) property can be displayed in a report.
|
171
|
+
#
|
172
|
+
# For example if a property never logs a `purchase` event, then a query for
|
173
|
+
# the `eventName` dimension and `eventCount` metric will not have a row
|
174
|
+
# eventName: "purchase" and eventCount: 0.
|
172
175
|
# @!attribute [rw] return_property_quota
|
173
176
|
# @return [::Boolean]
|
174
177
|
# Toggles whether to return the current state of this Analytics Property's
|
@@ -280,6 +283,13 @@ module Google
|
|
280
283
|
# If false or unspecified, each row with all metrics equal to 0 will not be
|
281
284
|
# returned. If true, these rows will be returned if they are not separately
|
282
285
|
# removed by a filter.
|
286
|
+
#
|
287
|
+
# Regardless of this `keep_empty_rows` setting, only data recorded by the
|
288
|
+
# Google Analytics (GA4) property can be displayed in a report.
|
289
|
+
#
|
290
|
+
# For example if a property never logs a `purchase` event, then a query for
|
291
|
+
# the `eventName` dimension and `eventCount` metric will not have a row
|
292
|
+
# eventName: "purchase" and eventCount: 0.
|
283
293
|
# @!attribute [rw] return_property_quota
|
284
294
|
# @return [::Boolean]
|
285
295
|
# Toggles whether to return the current state of this Analytics Property's
|
@@ -475,7 +485,7 @@ module Google
|
|
475
485
|
# @!attribute [rw] limit
|
476
486
|
# @return [::Integer]
|
477
487
|
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
478
|
-
# API returns a maximum of
|
488
|
+
# API returns a maximum of 250,000 rows per request, no matter how many you
|
479
489
|
# ask for. `limit` must be positive.
|
480
490
|
#
|
481
491
|
# The API can also return fewer rows than the requested `limit`, if there
|
@@ -21,8 +21,8 @@ module Google
|
|
21
21
|
module Analytics
|
22
22
|
module Data
|
23
23
|
module V1beta
|
24
|
-
# A contiguous set of days: startDate
|
25
|
-
# are allowed up to 4 date ranges.
|
24
|
+
# A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
|
25
|
+
# Requests are allowed up to 4 date ranges.
|
26
26
|
# @!attribute [rw] start_date
|
27
27
|
# @return [::String]
|
28
28
|
# The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
|
@@ -46,8 +46,8 @@ module Google
|
|
46
46
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
47
47
|
end
|
48
48
|
|
49
|
-
# A contiguous set of minutes: startMinutesAgo
|
50
|
-
# endMinutesAgo
|
49
|
+
# A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
|
50
|
+
# `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
|
51
51
|
# @!attribute [rw] start_minutes_ago
|
52
52
|
# @return [::Integer]
|
53
53
|
# The inclusive start minute for the query as a number of minutes before now.
|
@@ -466,7 +466,7 @@ module Google
|
|
466
466
|
# single pivot requests.
|
467
467
|
#
|
468
468
|
# The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
|
469
|
-
# must not exceed
|
469
|
+
# must not exceed 250,000. For example, a two pivot request with `limit:
|
470
470
|
# 1000` in each pivot will fail because the product is `1,000,000`.
|
471
471
|
# @!attribute [rw] metric_aggregations
|
472
472
|
# @return [::Array<::Google::Analytics::Data::V1beta::MetricAggregation>]
|
@@ -622,6 +622,18 @@ module Google
|
|
622
622
|
# @return [::Boolean]
|
623
623
|
# If true, indicates some buckets of dimension combinations are rolled into
|
624
624
|
# "(other)" row. This can happen for high cardinality reports.
|
625
|
+
#
|
626
|
+
# The metadata parameter dataLossFromOtherRow is populated based on the
|
627
|
+
# aggregated data table used in the report. The parameter will be accurately
|
628
|
+
# populated regardless of the filters and limits in the report.
|
629
|
+
#
|
630
|
+
# For example, the (other) row could be dropped from the report because the
|
631
|
+
# request contains a filter on sessionSource = google. This parameter will
|
632
|
+
# still be populated if data loss from other row was present in the input
|
633
|
+
# aggregate data used to generate this report.
|
634
|
+
#
|
635
|
+
# To learn more, see [About the (other) row and data
|
636
|
+
# sampling](https://support.google.com/analytics/answer/13208658#reports).
|
625
637
|
# @!attribute [rw] schema_restriction_response
|
626
638
|
# @return [::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse]
|
627
639
|
# Describes the schema restrictions actively enforced in creating this
|
@@ -824,13 +836,13 @@ module Google
|
|
824
836
|
# Exhausted errors.
|
825
837
|
# @!attribute [rw] tokens_per_day
|
826
838
|
# @return [::Google::Analytics::Data::V1beta::QuotaStatus]
|
827
|
-
# Standard Analytics Properties can use up to
|
828
|
-
# Analytics 360 Properties can use
|
839
|
+
# Standard Analytics Properties can use up to 200,000 tokens per day;
|
840
|
+
# Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
|
829
841
|
# consume fewer than 10 tokens.
|
830
842
|
# @!attribute [rw] tokens_per_hour
|
831
843
|
# @return [::Google::Analytics::Data::V1beta::QuotaStatus]
|
832
|
-
# Standard Analytics Properties can use up to
|
833
|
-
# Analytics 360 Properties can use
|
844
|
+
# Standard Analytics Properties can use up to 40,000 tokens per hour;
|
845
|
+
# Analytics 360 Properties can use 400,000 tokens per hour. An API request
|
834
846
|
# consumes a single number of tokens, and that number is deducted from all of
|
835
847
|
# the hourly, daily, and per project hourly quotas.
|
836
848
|
# @!attribute [rw] concurrent_requests
|
@@ -850,9 +862,9 @@ module Google
|
|
850
862
|
# thresholded dimensions.
|
851
863
|
# @!attribute [rw] tokens_per_project_per_hour
|
852
864
|
# @return [::Google::Analytics::Data::V1beta::QuotaStatus]
|
853
|
-
# Analytics Properties can use up to
|
854
|
-
# hour. This amounts to standard Analytics Properties can use up to
|
855
|
-
# tokens per project per hour, and Analytics 360 Properties can use
|
865
|
+
# Analytics Properties can use up to 35% of their tokens per project per
|
866
|
+
# hour. This amounts to standard Analytics Properties can use up to 14,000
|
867
|
+
# tokens per project per hour, and Analytics 360 Properties can use 140,000
|
856
868
|
# tokens per project per hour. An API request consumes a single number of
|
857
869
|
# tokens, and that number is deducted from all of the hourly, daily, and per
|
858
870
|
# project hourly quotas.
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-analytics-data-v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.9.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-
|
11
|
+
date: 2023-09-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.20.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.
|
29
|
+
version: 0.20.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -211,8 +211,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
211
211
|
- !ruby/object:Gem::Version
|
212
212
|
version: '0'
|
213
213
|
requirements: []
|
214
|
-
rubygems_version: 3.4.
|
214
|
+
rubygems_version: 3.4.19
|
215
215
|
signing_key:
|
216
216
|
specification_version: 4
|
217
|
-
summary: Accesses report data in Google Analytics.
|
217
|
+
summary: 'Accesses report data in Google Analytics. Warning: Creating multiple Customer
|
218
|
+
Applications, Accounts, or Projects to simulate or act as a single Customer Application,
|
219
|
+
Account, or Project (respectively) or to circumvent Service-specific usage limits
|
220
|
+
or quotas is a direct violation of Google Cloud Platform Terms of Service as well
|
221
|
+
as Google APIs Terms of Service. These actions can result in immediate termination
|
222
|
+
of your GCP project(s) without any warning.'
|
218
223
|
test_files: []
|