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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/README.md +37 -33
  4. data/lib/google/analytics/data/v1beta/analytics_data/client.rb +60 -17
  5. data/lib/google/analytics/data/v1beta/analytics_data/credentials.rb +1 -1
  6. data/lib/google/analytics/data/v1beta/analytics_data/operations.rb +52 -11
  7. data/lib/google/analytics/data/v1beta/analytics_data/paths.rb +1 -1
  8. data/lib/google/analytics/data/v1beta/analytics_data/rest/client.rb +40 -14
  9. data/lib/google/analytics/data/v1beta/analytics_data/rest/operations.rb +66 -34
  10. data/lib/google/analytics/data/v1beta/analytics_data/rest/service_stub.rb +103 -69
  11. data/lib/google/analytics/data/v1beta/analytics_data/rest.rb +1 -1
  12. data/lib/google/analytics/data/v1beta/analytics_data.rb +1 -1
  13. data/lib/google/analytics/data/v1beta/analytics_data_api_pb.rb +3 -26
  14. data/lib/google/analytics/data/v1beta/analytics_data_api_services_pb.rb +1 -1
  15. data/lib/google/analytics/data/v1beta/data_pb.rb +6 -24
  16. data/lib/google/analytics/data/v1beta/rest.rb +1 -1
  17. data/lib/google/analytics/data/v1beta/version.rb +1 -1
  18. data/lib/google/analytics/data/v1beta.rb +1 -1
  19. data/lib/google-analytics-data-v1beta.rb +1 -1
  20. data/proto_docs/README.md +1 -1
  21. data/proto_docs/google/analytics/data/v1beta/analytics_data_api.rb +1 -1
  22. data/proto_docs/google/analytics/data/v1beta/data.rb +115 -1
  23. data/proto_docs/google/api/client.rb +179 -26
  24. data/proto_docs/google/api/field_behavior.rb +1 -1
  25. data/proto_docs/google/api/launch_stage.rb +1 -1
  26. data/proto_docs/google/api/resource.rb +1 -1
  27. data/proto_docs/google/longrunning/operations.rb +23 -1
  28. data/proto_docs/google/protobuf/any.rb +1 -1
  29. data/proto_docs/google/protobuf/duration.rb +1 -1
  30. data/proto_docs/google/protobuf/empty.rb +1 -1
  31. data/proto_docs/google/protobuf/timestamp.rb +8 -7
  32. data/proto_docs/google/rpc/status.rb +1 -1
  33. metadata +15 -21
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2023 Google LLC
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.
@@ -176,8 +176,19 @@ module Google
176
176
  endpoint: @config.endpoint,
177
177
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
178
  universe_domain: @config.universe_domain,
179
- credentials: credentials
179
+ credentials: credentials,
180
+ logger: @config.logger
180
181
  )
182
+
183
+ @analytics_data_stub.logger(stub: true)&.info do |entry|
184
+ entry.set_system_name
185
+ entry.set_service
186
+ entry.message = "Created client for #{entry.service}"
187
+ entry.set_credentials_fields credentials
188
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
189
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
190
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
191
+ end
181
192
  end
182
193
 
183
194
  ##
@@ -187,6 +198,15 @@ module Google
187
198
  #
188
199
  attr_reader :operations_client
189
200
 
201
+ ##
202
+ # The logger used for request/response debug logging.
203
+ #
204
+ # @return [Logger]
205
+ #
206
+ def logger
207
+ @analytics_data_stub.logger
208
+ end
209
+
190
210
  # Service calls
191
211
 
192
212
  ##
@@ -353,7 +373,6 @@ module Google
353
373
 
354
374
  @analytics_data_stub.run_report request, options do |result, operation|
355
375
  yield result, operation if block_given?
356
- return result
357
376
  end
358
377
  rescue ::Gapic::Rest::Error => e
359
378
  raise ::Google::Cloud::Error.from_error(e)
@@ -492,7 +511,6 @@ module Google
492
511
 
493
512
  @analytics_data_stub.run_pivot_report request, options do |result, operation|
494
513
  yield result, operation if block_given?
495
- return result
496
514
  end
497
515
  rescue ::Gapic::Rest::Error => e
498
516
  raise ::Google::Cloud::Error.from_error(e)
@@ -583,7 +601,6 @@ module Google
583
601
 
584
602
  @analytics_data_stub.batch_run_reports request, options do |result, operation|
585
603
  yield result, operation if block_given?
586
- return result
587
604
  end
588
605
  rescue ::Gapic::Rest::Error => e
589
606
  raise ::Google::Cloud::Error.from_error(e)
@@ -674,7 +691,6 @@ module Google
674
691
 
675
692
  @analytics_data_stub.batch_run_pivot_reports request, options do |result, operation|
676
693
  yield result, operation if block_given?
677
- return result
678
694
  end
679
695
  rescue ::Gapic::Rest::Error => e
680
696
  raise ::Google::Cloud::Error.from_error(e)
@@ -772,7 +788,6 @@ module Google
772
788
 
773
789
  @analytics_data_stub.get_metadata request, options do |result, operation|
774
790
  yield result, operation if block_given?
775
- return result
776
791
  end
777
792
  rescue ::Gapic::Rest::Error => e
778
793
  raise ::Google::Cloud::Error.from_error(e)
@@ -898,7 +913,6 @@ module Google
898
913
 
899
914
  @analytics_data_stub.run_realtime_report request, options do |result, operation|
900
915
  yield result, operation if block_given?
901
- return result
902
916
  end
903
917
  rescue ::Gapic::Rest::Error => e
904
918
  raise ::Google::Cloud::Error.from_error(e)
@@ -1007,7 +1021,6 @@ module Google
1007
1021
 
1008
1022
  @analytics_data_stub.check_compatibility request, options do |result, operation|
1009
1023
  yield result, operation if block_given?
1010
- return result
1011
1024
  end
1012
1025
  rescue ::Gapic::Rest::Error => e
1013
1026
  raise ::Google::Cloud::Error.from_error(e)
@@ -1121,7 +1134,7 @@ module Google
1121
1134
  @analytics_data_stub.create_audience_export request, options do |result, operation|
1122
1135
  result = ::Gapic::Operation.new result, @operations_client, options: options
1123
1136
  yield result, operation if block_given?
1124
- return result
1137
+ throw :response, result
1125
1138
  end
1126
1139
  rescue ::Gapic::Rest::Error => e
1127
1140
  raise ::Google::Cloud::Error.from_error(e)
@@ -1240,7 +1253,6 @@ module Google
1240
1253
 
1241
1254
  @analytics_data_stub.query_audience_export request, options do |result, operation|
1242
1255
  yield result, operation if block_given?
1243
- return result
1244
1256
  end
1245
1257
  rescue ::Gapic::Rest::Error => e
1246
1258
  raise ::Google::Cloud::Error.from_error(e)
@@ -1331,7 +1343,6 @@ module Google
1331
1343
 
1332
1344
  @analytics_data_stub.get_audience_export request, options do |result, operation|
1333
1345
  yield result, operation if block_given?
1334
- return result
1335
1346
  end
1336
1347
  rescue ::Gapic::Rest::Error => e
1337
1348
  raise ::Google::Cloud::Error.from_error(e)
@@ -1441,7 +1452,7 @@ module Google
1441
1452
  @analytics_data_stub.list_audience_exports request, options do |result, operation|
1442
1453
  result = ::Gapic::Rest::PagedEnumerable.new @analytics_data_stub, :list_audience_exports, "audience_exports", request, result, options
1443
1454
  yield result, operation if block_given?
1444
- return result
1455
+ throw :response, result
1445
1456
  end
1446
1457
  rescue ::Gapic::Rest::Error => e
1447
1458
  raise ::Google::Cloud::Error.from_error(e)
@@ -1489,6 +1500,13 @@ module Google
1489
1500
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1490
1501
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1491
1502
  # * (`nil`) indicating no credentials
1503
+ #
1504
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1505
+ # external source for authentication to Google Cloud, you must validate it before
1506
+ # providing it to a Google API client library. Providing an unvalidated credential
1507
+ # configuration to Google APIs can compromise the security of your systems and data.
1508
+ # For more information, refer to [Validate credential configurations from external
1509
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1492
1510
  # @return [::Object]
1493
1511
  # @!attribute [rw] scope
1494
1512
  # The OAuth scopes
@@ -1510,6 +1528,7 @@ module Google
1510
1528
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1511
1529
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1512
1530
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1531
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
1513
1532
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1514
1533
  # trigger a retry.
1515
1534
  # @return [::Hash]
@@ -1521,6 +1540,11 @@ module Google
1521
1540
  # default endpoint URL. The default value of nil uses the environment
1522
1541
  # universe (usually the default "googleapis.com" universe).
1523
1542
  # @return [::String,nil]
1543
+ # @!attribute [rw] logger
1544
+ # A custom logger to use for request/response debug logging, or the value
1545
+ # `:default` (the default) to construct a default logger, or `nil` to
1546
+ # explicitly disable logging.
1547
+ # @return [::Logger,:default,nil]
1524
1548
  #
1525
1549
  class Configuration
1526
1550
  extend ::Gapic::Config
@@ -1531,7 +1555,7 @@ module Google
1531
1555
 
1532
1556
  config_attr :endpoint, nil, ::String, nil
1533
1557
  config_attr :credentials, nil do |value|
1534
- allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1558
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
1535
1559
  allowed.any? { |klass| klass === value }
1536
1560
  end
1537
1561
  config_attr :scope, nil, ::String, ::Array, nil
@@ -1542,6 +1566,7 @@ module Google
1542
1566
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1543
1567
  config_attr :quota_project, nil, ::String, nil
1544
1568
  config_attr :universe_domain, nil, ::String, nil
1569
+ config_attr :logger, :default, ::Logger, nil, :default
1545
1570
 
1546
1571
  # @private
1547
1572
  def initialize parent_config = nil
@@ -1576,6 +1601,7 @@ module Google
1576
1601
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1577
1602
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1578
1603
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1604
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
1579
1605
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1580
1606
  # trigger a retry.
1581
1607
  #
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2023 Google LLC
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.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -196,7 +207,7 @@ module Google
196
207
  @operations_stub.list_operations request, options do |result, operation|
197
208
  result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
198
209
  yield result, operation if block_given?
199
- return result
210
+ throw :response, result
200
211
  end
201
212
  rescue ::Gapic::Rest::Error => e
202
213
  raise ::Google::Cloud::Error.from_error(e)
@@ -285,7 +296,7 @@ module Google
285
296
  @operations_stub.get_operation request, options do |result, operation|
286
297
  result = ::Gapic::Operation.new result, @operations_client, options: options
287
298
  yield result, operation if block_given?
288
- return result
299
+ throw :response, result
289
300
  end
290
301
  rescue ::Gapic::Rest::Error => e
291
302
  raise ::Google::Cloud::Error.from_error(e)
@@ -367,7 +378,6 @@ module Google
367
378
 
368
379
  @operations_stub.delete_operation request, options do |result, operation|
369
380
  yield result, operation if block_given?
370
- return result
371
381
  end
372
382
  rescue ::Gapic::Rest::Error => e
373
383
  raise ::Google::Cloud::Error.from_error(e)
@@ -456,7 +466,6 @@ module Google
456
466
 
457
467
  @operations_stub.cancel_operation request, options do |result, operation|
458
468
  yield result, operation if block_given?
459
- return result
460
469
  end
461
470
  rescue ::Gapic::Rest::Error => e
462
471
  raise ::Google::Cloud::Error.from_error(e)
@@ -504,6 +513,13 @@ module Google
504
513
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
505
514
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
506
515
  # * (`nil`) indicating no credentials
516
+ #
517
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
518
+ # external source for authentication to Google Cloud, you must validate it before
519
+ # providing it to a Google API client library. Providing an unvalidated credential
520
+ # configuration to Google APIs can compromise the security of your systems and data.
521
+ # For more information, refer to [Validate credential configurations from external
522
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
507
523
  # @return [::Object]
508
524
  # @!attribute [rw] scope
509
525
  # The OAuth scopes
@@ -525,6 +541,7 @@ module Google
525
541
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
526
542
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
527
543
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
544
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
528
545
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
529
546
  # trigger a retry.
530
547
  # @return [::Hash]
@@ -536,6 +553,11 @@ module Google
536
553
  # default endpoint URL. The default value of nil uses the environment
537
554
  # universe (usually the default "googleapis.com" universe).
538
555
  # @return [::String,nil]
556
+ # @!attribute [rw] logger
557
+ # A custom logger to use for request/response debug logging, or the value
558
+ # `:default` (the default) to construct a default logger, or `nil` to
559
+ # explicitly disable logging.
560
+ # @return [::Logger,:default,nil]
539
561
  #
540
562
  class Configuration
541
563
  extend ::Gapic::Config
@@ -546,7 +568,7 @@ module Google
546
568
 
547
569
  config_attr :endpoint, nil, ::String, nil
548
570
  config_attr :credentials, nil do |value|
549
- allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
571
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
550
572
  allowed.any? { |klass| klass === value }
551
573
  end
552
574
  config_attr :scope, nil, ::String, ::Array, nil
@@ -557,6 +579,7 @@ module Google
557
579
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
558
580
  config_attr :quota_project, nil, ::String, nil
559
581
  config_attr :universe_domain, nil, ::String, nil
582
+ config_attr :logger, :default, ::Logger, nil, :default
560
583
 
561
584
  # @private
562
585
  def initialize parent_config = nil
@@ -591,6 +614,7 @@ module Google
591
614
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
592
615
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
593
616
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
617
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
594
618
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
595
619
  # trigger a retry.
596
620
  #
@@ -676,16 +700,18 @@ module Google
676
700
 
677
701
  response = @client_stub.make_http_request(
678
702
  verb,
679
- uri: uri,
680
- body: body || "",
681
- params: query_string_params,
703
+ uri: uri,
704
+ body: body || "",
705
+ params: query_string_params,
706
+ method_name: "list_operations",
682
707
  options: options
683
708
  )
684
709
  operation = ::Gapic::Rest::TransportOperation.new response
685
710
  result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
686
-
687
- yield result, operation if block_given?
688
- result
711
+ catch :response do
712
+ yield result, operation if block_given?
713
+ result
714
+ end
689
715
  end
690
716
 
691
717
  ##
@@ -714,16 +740,18 @@ module Google
714
740
 
715
741
  response = @client_stub.make_http_request(
716
742
  verb,
717
- uri: uri,
718
- body: body || "",
719
- params: query_string_params,
743
+ uri: uri,
744
+ body: body || "",
745
+ params: query_string_params,
746
+ method_name: "get_operation",
720
747
  options: options
721
748
  )
722
749
  operation = ::Gapic::Rest::TransportOperation.new response
723
750
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
724
-
725
- yield result, operation if block_given?
726
- result
751
+ catch :response do
752
+ yield result, operation if block_given?
753
+ result
754
+ end
727
755
  end
728
756
 
729
757
  ##
@@ -752,16 +780,18 @@ module Google
752
780
 
753
781
  response = @client_stub.make_http_request(
754
782
  verb,
755
- uri: uri,
756
- body: body || "",
757
- params: query_string_params,
783
+ uri: uri,
784
+ body: body || "",
785
+ params: query_string_params,
786
+ method_name: "delete_operation",
758
787
  options: options
759
788
  )
760
789
  operation = ::Gapic::Rest::TransportOperation.new response
761
790
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
762
-
763
- yield result, operation if block_given?
764
- result
791
+ catch :response do
792
+ yield result, operation if block_given?
793
+ result
794
+ end
765
795
  end
766
796
 
767
797
  ##
@@ -790,16 +820,18 @@ module Google
790
820
 
791
821
  response = @client_stub.make_http_request(
792
822
  verb,
793
- uri: uri,
794
- body: body || "",
795
- params: query_string_params,
823
+ uri: uri,
824
+ body: body || "",
825
+ params: query_string_params,
826
+ method_name: "cancel_operation",
796
827
  options: options
797
828
  )
798
829
  operation = ::Gapic::Rest::TransportOperation.new response
799
830
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
800
-
801
- yield result, operation if block_given?
802
- result
831
+ catch :response do
832
+ yield result, operation if block_given?
833
+ result
834
+ end
803
835
  end
804
836
 
805
837
  ##
@@ -838,7 +870,7 @@ module Google
838
870
  uri_method: :get,
839
871
  uri_template: "/v1/{name}",
840
872
  matches: [
841
- ["name", %r{^operations(?:/.*)?$}, true]
873
+ ["name", %r{^operations(?:/(?<__wildcard__>.*))?$}, true]
842
874
  ]
843
875
  )
844
876
  transcoder.transcode request_pb
@@ -859,7 +891,7 @@ module Google
859
891
  uri_method: :delete,
860
892
  uri_template: "/v1/{name}",
861
893
  matches: [
862
- ["name", %r{^operations(?:/.*)?$}, true]
894
+ ["name", %r{^operations(?:/(?<__wildcard__>.*))?$}, true]
863
895
  ]
864
896
  )
865
897
  transcoder.transcode request_pb
@@ -881,7 +913,7 @@ module Google
881
913
  uri_template: "/v1/{name}:cancel",
882
914
  body: "*",
883
915
  matches: [
884
- ["name", %r{^operations(?:/.*)?$}, true]
916
+ ["name", %r{^operations(?:/(?<__wildcard__>.*))?$}, true]
885
917
  ]
886
918
  )
887
919
  transcoder.transcode request_pb