google-analytics-admin-v1alpha 0.9.1 → 0.10.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/AUTHENTICATION.md +7 -25
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +37 -9
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +633 -244
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +15 -15
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +15 -8
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +39 -15
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +105 -27
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +127 -73
- data/proto_docs/google/api/resource.rb +10 -71
- metadata +3 -3
@@ -133,10 +133,6 @@ module Google
|
|
133
133
|
|
134
134
|
default_config.rpcs.list_android_app_data_streams.timeout = 60.0
|
135
135
|
|
136
|
-
default_config.rpcs.get_enhanced_measurement_settings.timeout = 60.0
|
137
|
-
|
138
|
-
default_config.rpcs.update_enhanced_measurement_settings.timeout = 60.0
|
139
|
-
|
140
136
|
default_config.rpcs.create_firebase_link.timeout = 60.0
|
141
137
|
|
142
138
|
default_config.rpcs.delete_firebase_link.timeout = 60.0
|
@@ -3380,188 +3376,6 @@ module Google
|
|
3380
3376
|
raise ::Google::Cloud::Error.from_error(e)
|
3381
3377
|
end
|
3382
3378
|
|
3383
|
-
##
|
3384
|
-
# Returns the singleton enhanced measurement settings for this web stream.
|
3385
|
-
# Note that the stream must enable enhanced measurement for these settings to
|
3386
|
-
# take effect.
|
3387
|
-
#
|
3388
|
-
# @overload get_enhanced_measurement_settings(request, options = nil)
|
3389
|
-
# Pass arguments to `get_enhanced_measurement_settings` via a request object, either of type
|
3390
|
-
# {::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest} or an equivalent Hash.
|
3391
|
-
#
|
3392
|
-
# @param request [::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Hash]
|
3393
|
-
# A request object representing the call parameters. Required. To specify no
|
3394
|
-
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3395
|
-
# @param options [::Gapic::CallOptions, ::Hash]
|
3396
|
-
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3397
|
-
#
|
3398
|
-
# @overload get_enhanced_measurement_settings(name: nil)
|
3399
|
-
# Pass arguments to `get_enhanced_measurement_settings` via keyword arguments. Note that at
|
3400
|
-
# least one keyword argument is required. To specify no parameters, or to keep all
|
3401
|
-
# the default parameter values, pass an empty Hash as a request object (see above).
|
3402
|
-
#
|
3403
|
-
# @param name [::String]
|
3404
|
-
# Required. The name of the settings to lookup.
|
3405
|
-
# Format:
|
3406
|
-
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
3407
|
-
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
3408
|
-
#
|
3409
|
-
# @yield [response, operation] Access the result along with the RPC operation
|
3410
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3411
|
-
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3412
|
-
#
|
3413
|
-
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3414
|
-
#
|
3415
|
-
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3416
|
-
#
|
3417
|
-
# @example Basic example
|
3418
|
-
# require "google/analytics/admin/v1alpha"
|
3419
|
-
#
|
3420
|
-
# # Create a client object. The client can be reused for multiple calls.
|
3421
|
-
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
3422
|
-
#
|
3423
|
-
# # Create a request. To set request fields, pass in keyword arguments.
|
3424
|
-
# request = Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest.new
|
3425
|
-
#
|
3426
|
-
# # Call the get_enhanced_measurement_settings method.
|
3427
|
-
# result = client.get_enhanced_measurement_settings request
|
3428
|
-
#
|
3429
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.
|
3430
|
-
# p result
|
3431
|
-
#
|
3432
|
-
def get_enhanced_measurement_settings request, options = nil
|
3433
|
-
raise ::ArgumentError, "request must be provided" if request.nil?
|
3434
|
-
|
3435
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest
|
3436
|
-
|
3437
|
-
# Converts hash and nil to an options object
|
3438
|
-
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3439
|
-
|
3440
|
-
# Customize the options with defaults
|
3441
|
-
metadata = @config.rpcs.get_enhanced_measurement_settings.metadata.to_h
|
3442
|
-
|
3443
|
-
# Set x-goog-api-client and x-goog-user-project headers
|
3444
|
-
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3445
|
-
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3446
|
-
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
3447
|
-
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3448
|
-
|
3449
|
-
header_params = {}
|
3450
|
-
if request.name
|
3451
|
-
header_params["name"] = request.name
|
3452
|
-
end
|
3453
|
-
|
3454
|
-
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3455
|
-
metadata[:"x-goog-request-params"] ||= request_params_header
|
3456
|
-
|
3457
|
-
options.apply_defaults timeout: @config.rpcs.get_enhanced_measurement_settings.timeout,
|
3458
|
-
metadata: metadata,
|
3459
|
-
retry_policy: @config.rpcs.get_enhanced_measurement_settings.retry_policy
|
3460
|
-
|
3461
|
-
options.apply_defaults timeout: @config.timeout,
|
3462
|
-
metadata: @config.metadata,
|
3463
|
-
retry_policy: @config.retry_policy
|
3464
|
-
|
3465
|
-
@analytics_admin_service_stub.call_rpc :get_enhanced_measurement_settings, request, options: options do |response, operation|
|
3466
|
-
yield response, operation if block_given?
|
3467
|
-
return response
|
3468
|
-
end
|
3469
|
-
rescue ::GRPC::BadStatus => e
|
3470
|
-
raise ::Google::Cloud::Error.from_error(e)
|
3471
|
-
end
|
3472
|
-
|
3473
|
-
##
|
3474
|
-
# Updates the singleton enhanced measurement settings for this web stream.
|
3475
|
-
# Note that the stream must enable enhanced measurement for these settings to
|
3476
|
-
# take effect.
|
3477
|
-
#
|
3478
|
-
# @overload update_enhanced_measurement_settings(request, options = nil)
|
3479
|
-
# Pass arguments to `update_enhanced_measurement_settings` via a request object, either of type
|
3480
|
-
# {::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest} or an equivalent Hash.
|
3481
|
-
#
|
3482
|
-
# @param request [::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Hash]
|
3483
|
-
# A request object representing the call parameters. Required. To specify no
|
3484
|
-
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3485
|
-
# @param options [::Gapic::CallOptions, ::Hash]
|
3486
|
-
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3487
|
-
#
|
3488
|
-
# @overload update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil)
|
3489
|
-
# Pass arguments to `update_enhanced_measurement_settings` via keyword arguments. Note that at
|
3490
|
-
# least one keyword argument is required. To specify no parameters, or to keep all
|
3491
|
-
# the default parameter values, pass an empty Hash as a request object (see above).
|
3492
|
-
#
|
3493
|
-
# @param enhanced_measurement_settings [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings, ::Hash]
|
3494
|
-
# Required. The settings to update.
|
3495
|
-
# The `name` field is used to identify the settings to be updated.
|
3496
|
-
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
3497
|
-
# Required. The list of fields to be updated. Field names must be in snake case
|
3498
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To replace
|
3499
|
-
# the entire entity, use one path with the string "*" to match all fields.
|
3500
|
-
#
|
3501
|
-
# @yield [response, operation] Access the result along with the RPC operation
|
3502
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3503
|
-
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3504
|
-
#
|
3505
|
-
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3506
|
-
#
|
3507
|
-
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3508
|
-
#
|
3509
|
-
# @example Basic example
|
3510
|
-
# require "google/analytics/admin/v1alpha"
|
3511
|
-
#
|
3512
|
-
# # Create a client object. The client can be reused for multiple calls.
|
3513
|
-
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
3514
|
-
#
|
3515
|
-
# # Create a request. To set request fields, pass in keyword arguments.
|
3516
|
-
# request = Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest.new
|
3517
|
-
#
|
3518
|
-
# # Call the update_enhanced_measurement_settings method.
|
3519
|
-
# result = client.update_enhanced_measurement_settings request
|
3520
|
-
#
|
3521
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.
|
3522
|
-
# p result
|
3523
|
-
#
|
3524
|
-
def update_enhanced_measurement_settings request, options = nil
|
3525
|
-
raise ::ArgumentError, "request must be provided" if request.nil?
|
3526
|
-
|
3527
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest
|
3528
|
-
|
3529
|
-
# Converts hash and nil to an options object
|
3530
|
-
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3531
|
-
|
3532
|
-
# Customize the options with defaults
|
3533
|
-
metadata = @config.rpcs.update_enhanced_measurement_settings.metadata.to_h
|
3534
|
-
|
3535
|
-
# Set x-goog-api-client and x-goog-user-project headers
|
3536
|
-
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3537
|
-
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3538
|
-
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
3539
|
-
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3540
|
-
|
3541
|
-
header_params = {}
|
3542
|
-
if request.enhanced_measurement_settings&.name
|
3543
|
-
header_params["enhanced_measurement_settings.name"] = request.enhanced_measurement_settings.name
|
3544
|
-
end
|
3545
|
-
|
3546
|
-
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3547
|
-
metadata[:"x-goog-request-params"] ||= request_params_header
|
3548
|
-
|
3549
|
-
options.apply_defaults timeout: @config.rpcs.update_enhanced_measurement_settings.timeout,
|
3550
|
-
metadata: metadata,
|
3551
|
-
retry_policy: @config.rpcs.update_enhanced_measurement_settings.retry_policy
|
3552
|
-
|
3553
|
-
options.apply_defaults timeout: @config.timeout,
|
3554
|
-
metadata: @config.metadata,
|
3555
|
-
retry_policy: @config.retry_policy
|
3556
|
-
|
3557
|
-
@analytics_admin_service_stub.call_rpc :update_enhanced_measurement_settings, request, options: options do |response, operation|
|
3558
|
-
yield response, operation if block_given?
|
3559
|
-
return response
|
3560
|
-
end
|
3561
|
-
rescue ::GRPC::BadStatus => e
|
3562
|
-
raise ::Google::Cloud::Error.from_error(e)
|
3563
|
-
end
|
3564
|
-
|
3565
3379
|
##
|
3566
3380
|
# Creates a FirebaseLink.
|
3567
3381
|
#
|
@@ -4843,6 +4657,103 @@ module Google
|
|
4843
4657
|
raise ::Google::Cloud::Error.from_error(e)
|
4844
4658
|
end
|
4845
4659
|
|
4660
|
+
##
|
4661
|
+
# Acknowledges the terms of user data collection for the specified property.
|
4662
|
+
#
|
4663
|
+
# This acknowledgement must be completed (either in the Google Analytics UI
|
4664
|
+
# or via this API) before MeasurementProtocolSecret resources may be created.
|
4665
|
+
#
|
4666
|
+
# @overload acknowledge_user_data_collection(request, options = nil)
|
4667
|
+
# Pass arguments to `acknowledge_user_data_collection` via a request object, either of type
|
4668
|
+
# {::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest} or an equivalent Hash.
|
4669
|
+
#
|
4670
|
+
# @param request [::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest, ::Hash]
|
4671
|
+
# A request object representing the call parameters. Required. To specify no
|
4672
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
4673
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
4674
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
4675
|
+
#
|
4676
|
+
# @overload acknowledge_user_data_collection(property: nil, acknowledgement: nil)
|
4677
|
+
# Pass arguments to `acknowledge_user_data_collection` via keyword arguments. Note that at
|
4678
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
4679
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
4680
|
+
#
|
4681
|
+
# @param property [::String]
|
4682
|
+
# Required. The property for which to acknowledge user data collection.
|
4683
|
+
# @param acknowledgement [::String]
|
4684
|
+
# Required. An acknowledgement that the caller of this method understands the terms
|
4685
|
+
# of user data collection.
|
4686
|
+
#
|
4687
|
+
# This field must contain the exact value:
|
4688
|
+
# "I acknowledge that I have the necessary privacy disclosures and rights
|
4689
|
+
# from my end users for the collection and processing of their data,
|
4690
|
+
# including the association of such data with the visitation information
|
4691
|
+
# Google Analytics collects from my site and/or app property."
|
4692
|
+
#
|
4693
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
4694
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse]
|
4695
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
4696
|
+
#
|
4697
|
+
# @return [::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse]
|
4698
|
+
#
|
4699
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
4700
|
+
#
|
4701
|
+
# @example Basic example
|
4702
|
+
# require "google/analytics/admin/v1alpha"
|
4703
|
+
#
|
4704
|
+
# # Create a client object. The client can be reused for multiple calls.
|
4705
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
4706
|
+
#
|
4707
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
4708
|
+
# request = Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest.new
|
4709
|
+
#
|
4710
|
+
# # Call the acknowledge_user_data_collection method.
|
4711
|
+
# result = client.acknowledge_user_data_collection request
|
4712
|
+
#
|
4713
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse.
|
4714
|
+
# p result
|
4715
|
+
#
|
4716
|
+
def acknowledge_user_data_collection request, options = nil
|
4717
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
4718
|
+
|
4719
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest
|
4720
|
+
|
4721
|
+
# Converts hash and nil to an options object
|
4722
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
4723
|
+
|
4724
|
+
# Customize the options with defaults
|
4725
|
+
metadata = @config.rpcs.acknowledge_user_data_collection.metadata.to_h
|
4726
|
+
|
4727
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
4728
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
4729
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
4730
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
4731
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
4732
|
+
|
4733
|
+
header_params = {}
|
4734
|
+
if request.property
|
4735
|
+
header_params["property"] = request.property
|
4736
|
+
end
|
4737
|
+
|
4738
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
4739
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
4740
|
+
|
4741
|
+
options.apply_defaults timeout: @config.rpcs.acknowledge_user_data_collection.timeout,
|
4742
|
+
metadata: metadata,
|
4743
|
+
retry_policy: @config.rpcs.acknowledge_user_data_collection.retry_policy
|
4744
|
+
|
4745
|
+
options.apply_defaults timeout: @config.timeout,
|
4746
|
+
metadata: @config.metadata,
|
4747
|
+
retry_policy: @config.retry_policy
|
4748
|
+
|
4749
|
+
@analytics_admin_service_stub.call_rpc :acknowledge_user_data_collection, request, options: options do |response, operation|
|
4750
|
+
yield response, operation if block_given?
|
4751
|
+
return response
|
4752
|
+
end
|
4753
|
+
rescue ::GRPC::BadStatus => e
|
4754
|
+
raise ::Google::Cloud::Error.from_error(e)
|
4755
|
+
end
|
4756
|
+
|
4846
4757
|
##
|
4847
4758
|
# Searches through all changes to an account or its children given the
|
4848
4759
|
# specified set of filters.
|
@@ -7579,56 +7490,506 @@ module Google
|
|
7579
7490
|
end
|
7580
7491
|
|
7581
7492
|
##
|
7582
|
-
#
|
7493
|
+
# Creates a DataStream.
|
7583
7494
|
#
|
7584
|
-
#
|
7585
|
-
#
|
7586
|
-
#
|
7587
|
-
# applied individually to specific RPCs. See
|
7588
|
-
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
7589
|
-
# for a list of RPCs that can be configured independently.
|
7495
|
+
# @overload create_data_stream(request, options = nil)
|
7496
|
+
# Pass arguments to `create_data_stream` via a request object, either of type
|
7497
|
+
# {::Google::Analytics::Admin::V1alpha::CreateDataStreamRequest} or an equivalent Hash.
|
7590
7498
|
#
|
7591
|
-
#
|
7592
|
-
#
|
7499
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateDataStreamRequest, ::Hash]
|
7500
|
+
# A request object representing the call parameters. Required. To specify no
|
7501
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7502
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7503
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7593
7504
|
#
|
7594
|
-
# @
|
7505
|
+
# @overload create_data_stream(parent: nil, data_stream: nil)
|
7506
|
+
# Pass arguments to `create_data_stream` via keyword arguments. Note that at
|
7507
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7508
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7595
7509
|
#
|
7596
|
-
#
|
7597
|
-
#
|
7598
|
-
#
|
7599
|
-
#
|
7600
|
-
# config.timeout = 10.0
|
7601
|
-
# config.rpcs.get_account.timeout = 20.0
|
7602
|
-
# end
|
7510
|
+
# @param parent [::String]
|
7511
|
+
# Required. Example format: properties/1234
|
7512
|
+
# @param data_stream [::Google::Analytics::Admin::V1alpha::DataStream, ::Hash]
|
7513
|
+
# Required. The DataStream to create.
|
7603
7514
|
#
|
7604
|
-
#
|
7605
|
-
#
|
7606
|
-
#
|
7607
|
-
# config.rpcs.get_account.timeout = 20.0
|
7608
|
-
# end
|
7515
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7516
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::DataStream]
|
7517
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7609
7518
|
#
|
7610
|
-
#
|
7611
|
-
#
|
7612
|
-
#
|
7613
|
-
#
|
7614
|
-
#
|
7615
|
-
#
|
7616
|
-
#
|
7617
|
-
#
|
7618
|
-
#
|
7619
|
-
#
|
7620
|
-
#
|
7621
|
-
#
|
7622
|
-
#
|
7623
|
-
#
|
7624
|
-
#
|
7625
|
-
#
|
7626
|
-
#
|
7627
|
-
#
|
7628
|
-
#
|
7629
|
-
|
7630
|
-
|
7631
|
-
|
7519
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
7520
|
+
#
|
7521
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7522
|
+
#
|
7523
|
+
# @example Basic example
|
7524
|
+
# require "google/analytics/admin/v1alpha"
|
7525
|
+
#
|
7526
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7527
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7528
|
+
#
|
7529
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7530
|
+
# request = Google::Analytics::Admin::V1alpha::CreateDataStreamRequest.new
|
7531
|
+
#
|
7532
|
+
# # Call the create_data_stream method.
|
7533
|
+
# result = client.create_data_stream request
|
7534
|
+
#
|
7535
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::DataStream.
|
7536
|
+
# p result
|
7537
|
+
#
|
7538
|
+
def create_data_stream request, options = nil
|
7539
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7540
|
+
|
7541
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateDataStreamRequest
|
7542
|
+
|
7543
|
+
# Converts hash and nil to an options object
|
7544
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7545
|
+
|
7546
|
+
# Customize the options with defaults
|
7547
|
+
metadata = @config.rpcs.create_data_stream.metadata.to_h
|
7548
|
+
|
7549
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7550
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7551
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7552
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7553
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7554
|
+
|
7555
|
+
header_params = {}
|
7556
|
+
if request.parent
|
7557
|
+
header_params["parent"] = request.parent
|
7558
|
+
end
|
7559
|
+
|
7560
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7561
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7562
|
+
|
7563
|
+
options.apply_defaults timeout: @config.rpcs.create_data_stream.timeout,
|
7564
|
+
metadata: metadata,
|
7565
|
+
retry_policy: @config.rpcs.create_data_stream.retry_policy
|
7566
|
+
|
7567
|
+
options.apply_defaults timeout: @config.timeout,
|
7568
|
+
metadata: @config.metadata,
|
7569
|
+
retry_policy: @config.retry_policy
|
7570
|
+
|
7571
|
+
@analytics_admin_service_stub.call_rpc :create_data_stream, request, options: options do |response, operation|
|
7572
|
+
yield response, operation if block_given?
|
7573
|
+
return response
|
7574
|
+
end
|
7575
|
+
rescue ::GRPC::BadStatus => e
|
7576
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7577
|
+
end
|
7578
|
+
|
7579
|
+
##
|
7580
|
+
# Deletes a DataStream on a property.
|
7581
|
+
#
|
7582
|
+
# @overload delete_data_stream(request, options = nil)
|
7583
|
+
# Pass arguments to `delete_data_stream` via a request object, either of type
|
7584
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteDataStreamRequest} or an equivalent Hash.
|
7585
|
+
#
|
7586
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteDataStreamRequest, ::Hash]
|
7587
|
+
# A request object representing the call parameters. Required. To specify no
|
7588
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7589
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7590
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7591
|
+
#
|
7592
|
+
# @overload delete_data_stream(name: nil)
|
7593
|
+
# Pass arguments to `delete_data_stream` via keyword arguments. Note that at
|
7594
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7595
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7596
|
+
#
|
7597
|
+
# @param name [::String]
|
7598
|
+
# Required. The name of the DataStream to delete.
|
7599
|
+
# Example format: properties/1234/dataStreams/5678
|
7600
|
+
#
|
7601
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7602
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
7603
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7604
|
+
#
|
7605
|
+
# @return [::Google::Protobuf::Empty]
|
7606
|
+
#
|
7607
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7608
|
+
#
|
7609
|
+
# @example Basic example
|
7610
|
+
# require "google/analytics/admin/v1alpha"
|
7611
|
+
#
|
7612
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7613
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7614
|
+
#
|
7615
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7616
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteDataStreamRequest.new
|
7617
|
+
#
|
7618
|
+
# # Call the delete_data_stream method.
|
7619
|
+
# result = client.delete_data_stream request
|
7620
|
+
#
|
7621
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
7622
|
+
# p result
|
7623
|
+
#
|
7624
|
+
def delete_data_stream request, options = nil
|
7625
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7626
|
+
|
7627
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteDataStreamRequest
|
7628
|
+
|
7629
|
+
# Converts hash and nil to an options object
|
7630
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7631
|
+
|
7632
|
+
# Customize the options with defaults
|
7633
|
+
metadata = @config.rpcs.delete_data_stream.metadata.to_h
|
7634
|
+
|
7635
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7636
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7637
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7638
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7639
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7640
|
+
|
7641
|
+
header_params = {}
|
7642
|
+
if request.name
|
7643
|
+
header_params["name"] = request.name
|
7644
|
+
end
|
7645
|
+
|
7646
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7647
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7648
|
+
|
7649
|
+
options.apply_defaults timeout: @config.rpcs.delete_data_stream.timeout,
|
7650
|
+
metadata: metadata,
|
7651
|
+
retry_policy: @config.rpcs.delete_data_stream.retry_policy
|
7652
|
+
|
7653
|
+
options.apply_defaults timeout: @config.timeout,
|
7654
|
+
metadata: @config.metadata,
|
7655
|
+
retry_policy: @config.retry_policy
|
7656
|
+
|
7657
|
+
@analytics_admin_service_stub.call_rpc :delete_data_stream, request, options: options do |response, operation|
|
7658
|
+
yield response, operation if block_given?
|
7659
|
+
return response
|
7660
|
+
end
|
7661
|
+
rescue ::GRPC::BadStatus => e
|
7662
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7663
|
+
end
|
7664
|
+
|
7665
|
+
##
|
7666
|
+
# Updates a DataStream on a property.
|
7667
|
+
#
|
7668
|
+
# @overload update_data_stream(request, options = nil)
|
7669
|
+
# Pass arguments to `update_data_stream` via a request object, either of type
|
7670
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateDataStreamRequest} or an equivalent Hash.
|
7671
|
+
#
|
7672
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateDataStreamRequest, ::Hash]
|
7673
|
+
# A request object representing the call parameters. Required. To specify no
|
7674
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7675
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7676
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7677
|
+
#
|
7678
|
+
# @overload update_data_stream(data_stream: nil, update_mask: nil)
|
7679
|
+
# Pass arguments to `update_data_stream` via keyword arguments. Note that at
|
7680
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7681
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7682
|
+
#
|
7683
|
+
# @param data_stream [::Google::Analytics::Admin::V1alpha::DataStream, ::Hash]
|
7684
|
+
# The DataStream to update
|
7685
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
7686
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
7687
|
+
# To replace the entire entity, use one path with the string "*" to match
|
7688
|
+
# all fields.
|
7689
|
+
#
|
7690
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7691
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::DataStream]
|
7692
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7693
|
+
#
|
7694
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
7695
|
+
#
|
7696
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7697
|
+
#
|
7698
|
+
# @example Basic example
|
7699
|
+
# require "google/analytics/admin/v1alpha"
|
7700
|
+
#
|
7701
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7702
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7703
|
+
#
|
7704
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7705
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateDataStreamRequest.new
|
7706
|
+
#
|
7707
|
+
# # Call the update_data_stream method.
|
7708
|
+
# result = client.update_data_stream request
|
7709
|
+
#
|
7710
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::DataStream.
|
7711
|
+
# p result
|
7712
|
+
#
|
7713
|
+
def update_data_stream request, options = nil
|
7714
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7715
|
+
|
7716
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateDataStreamRequest
|
7717
|
+
|
7718
|
+
# Converts hash and nil to an options object
|
7719
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7720
|
+
|
7721
|
+
# Customize the options with defaults
|
7722
|
+
metadata = @config.rpcs.update_data_stream.metadata.to_h
|
7723
|
+
|
7724
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7725
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7726
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7727
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7728
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7729
|
+
|
7730
|
+
header_params = {}
|
7731
|
+
if request.data_stream&.name
|
7732
|
+
header_params["data_stream.name"] = request.data_stream.name
|
7733
|
+
end
|
7734
|
+
|
7735
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7736
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7737
|
+
|
7738
|
+
options.apply_defaults timeout: @config.rpcs.update_data_stream.timeout,
|
7739
|
+
metadata: metadata,
|
7740
|
+
retry_policy: @config.rpcs.update_data_stream.retry_policy
|
7741
|
+
|
7742
|
+
options.apply_defaults timeout: @config.timeout,
|
7743
|
+
metadata: @config.metadata,
|
7744
|
+
retry_policy: @config.retry_policy
|
7745
|
+
|
7746
|
+
@analytics_admin_service_stub.call_rpc :update_data_stream, request, options: options do |response, operation|
|
7747
|
+
yield response, operation if block_given?
|
7748
|
+
return response
|
7749
|
+
end
|
7750
|
+
rescue ::GRPC::BadStatus => e
|
7751
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7752
|
+
end
|
7753
|
+
|
7754
|
+
##
|
7755
|
+
# Lists DataStreams on a property.
|
7756
|
+
#
|
7757
|
+
# @overload list_data_streams(request, options = nil)
|
7758
|
+
# Pass arguments to `list_data_streams` via a request object, either of type
|
7759
|
+
# {::Google::Analytics::Admin::V1alpha::ListDataStreamsRequest} or an equivalent Hash.
|
7760
|
+
#
|
7761
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListDataStreamsRequest, ::Hash]
|
7762
|
+
# A request object representing the call parameters. Required. To specify no
|
7763
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7764
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7765
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7766
|
+
#
|
7767
|
+
# @overload list_data_streams(parent: nil, page_size: nil, page_token: nil)
|
7768
|
+
# Pass arguments to `list_data_streams` via keyword arguments. Note that at
|
7769
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7770
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7771
|
+
#
|
7772
|
+
# @param parent [::String]
|
7773
|
+
# Required. Example format: properties/1234
|
7774
|
+
# @param page_size [::Integer]
|
7775
|
+
# The maximum number of resources to return.
|
7776
|
+
# If unspecified, at most 50 resources will be returned.
|
7777
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
7778
|
+
# @param page_token [::String]
|
7779
|
+
# A page token, received from a previous `ListDataStreams` call.
|
7780
|
+
# Provide this to retrieve the subsequent page.
|
7781
|
+
#
|
7782
|
+
# When paginating, all other parameters provided to `ListDataStreams` must
|
7783
|
+
# match the call that provided the page token.
|
7784
|
+
#
|
7785
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7786
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>]
|
7787
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7788
|
+
#
|
7789
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>]
|
7790
|
+
#
|
7791
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7792
|
+
#
|
7793
|
+
# @example Basic example
|
7794
|
+
# require "google/analytics/admin/v1alpha"
|
7795
|
+
#
|
7796
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7797
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7798
|
+
#
|
7799
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7800
|
+
# request = Google::Analytics::Admin::V1alpha::ListDataStreamsRequest.new
|
7801
|
+
#
|
7802
|
+
# # Call the list_data_streams method.
|
7803
|
+
# result = client.list_data_streams request
|
7804
|
+
#
|
7805
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
7806
|
+
# # iterate over all elements by calling #each, and the enumerable
|
7807
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
7808
|
+
# # methods are also available for managing paging directly.
|
7809
|
+
# result.each do |response|
|
7810
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::DataStream.
|
7811
|
+
# p response
|
7812
|
+
# end
|
7813
|
+
#
|
7814
|
+
def list_data_streams request, options = nil
|
7815
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7816
|
+
|
7817
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListDataStreamsRequest
|
7818
|
+
|
7819
|
+
# Converts hash and nil to an options object
|
7820
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7821
|
+
|
7822
|
+
# Customize the options with defaults
|
7823
|
+
metadata = @config.rpcs.list_data_streams.metadata.to_h
|
7824
|
+
|
7825
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7826
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7827
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7828
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7829
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7830
|
+
|
7831
|
+
header_params = {}
|
7832
|
+
if request.parent
|
7833
|
+
header_params["parent"] = request.parent
|
7834
|
+
end
|
7835
|
+
|
7836
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7837
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7838
|
+
|
7839
|
+
options.apply_defaults timeout: @config.rpcs.list_data_streams.timeout,
|
7840
|
+
metadata: metadata,
|
7841
|
+
retry_policy: @config.rpcs.list_data_streams.retry_policy
|
7842
|
+
|
7843
|
+
options.apply_defaults timeout: @config.timeout,
|
7844
|
+
metadata: @config.metadata,
|
7845
|
+
retry_policy: @config.retry_policy
|
7846
|
+
|
7847
|
+
@analytics_admin_service_stub.call_rpc :list_data_streams, request, options: options do |response, operation|
|
7848
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_data_streams, request, response, operation, options
|
7849
|
+
yield response, operation if block_given?
|
7850
|
+
return response
|
7851
|
+
end
|
7852
|
+
rescue ::GRPC::BadStatus => e
|
7853
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7854
|
+
end
|
7855
|
+
|
7856
|
+
##
|
7857
|
+
# Lookup for a single DataStream.
|
7858
|
+
#
|
7859
|
+
# @overload get_data_stream(request, options = nil)
|
7860
|
+
# Pass arguments to `get_data_stream` via a request object, either of type
|
7861
|
+
# {::Google::Analytics::Admin::V1alpha::GetDataStreamRequest} or an equivalent Hash.
|
7862
|
+
#
|
7863
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetDataStreamRequest, ::Hash]
|
7864
|
+
# A request object representing the call parameters. Required. To specify no
|
7865
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7866
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7867
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7868
|
+
#
|
7869
|
+
# @overload get_data_stream(name: nil)
|
7870
|
+
# Pass arguments to `get_data_stream` via keyword arguments. Note that at
|
7871
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7872
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7873
|
+
#
|
7874
|
+
# @param name [::String]
|
7875
|
+
# Required. The name of the DataStream to get.
|
7876
|
+
# Example format: properties/1234/dataStreams/5678
|
7877
|
+
#
|
7878
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7879
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::DataStream]
|
7880
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7881
|
+
#
|
7882
|
+
# @return [::Google::Analytics::Admin::V1alpha::DataStream]
|
7883
|
+
#
|
7884
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7885
|
+
#
|
7886
|
+
# @example Basic example
|
7887
|
+
# require "google/analytics/admin/v1alpha"
|
7888
|
+
#
|
7889
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7890
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7891
|
+
#
|
7892
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7893
|
+
# request = Google::Analytics::Admin::V1alpha::GetDataStreamRequest.new
|
7894
|
+
#
|
7895
|
+
# # Call the get_data_stream method.
|
7896
|
+
# result = client.get_data_stream request
|
7897
|
+
#
|
7898
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::DataStream.
|
7899
|
+
# p result
|
7900
|
+
#
|
7901
|
+
def get_data_stream request, options = nil
|
7902
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7903
|
+
|
7904
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDataStreamRequest
|
7905
|
+
|
7906
|
+
# Converts hash and nil to an options object
|
7907
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7908
|
+
|
7909
|
+
# Customize the options with defaults
|
7910
|
+
metadata = @config.rpcs.get_data_stream.metadata.to_h
|
7911
|
+
|
7912
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7913
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7914
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7915
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7916
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7917
|
+
|
7918
|
+
header_params = {}
|
7919
|
+
if request.name
|
7920
|
+
header_params["name"] = request.name
|
7921
|
+
end
|
7922
|
+
|
7923
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7924
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7925
|
+
|
7926
|
+
options.apply_defaults timeout: @config.rpcs.get_data_stream.timeout,
|
7927
|
+
metadata: metadata,
|
7928
|
+
retry_policy: @config.rpcs.get_data_stream.retry_policy
|
7929
|
+
|
7930
|
+
options.apply_defaults timeout: @config.timeout,
|
7931
|
+
metadata: @config.metadata,
|
7932
|
+
retry_policy: @config.retry_policy
|
7933
|
+
|
7934
|
+
@analytics_admin_service_stub.call_rpc :get_data_stream, request, options: options do |response, operation|
|
7935
|
+
yield response, operation if block_given?
|
7936
|
+
return response
|
7937
|
+
end
|
7938
|
+
rescue ::GRPC::BadStatus => e
|
7939
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7940
|
+
end
|
7941
|
+
|
7942
|
+
##
|
7943
|
+
# Configuration class for the AnalyticsAdminService API.
|
7944
|
+
#
|
7945
|
+
# This class represents the configuration for AnalyticsAdminService,
|
7946
|
+
# providing control over timeouts, retry behavior, logging, transport
|
7947
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
7948
|
+
# applied individually to specific RPCs. See
|
7949
|
+
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
7950
|
+
# for a list of RPCs that can be configured independently.
|
7951
|
+
#
|
7952
|
+
# Configuration can be applied globally to all clients, or to a single client
|
7953
|
+
# on construction.
|
7954
|
+
#
|
7955
|
+
# @example
|
7956
|
+
#
|
7957
|
+
# # Modify the global config, setting the timeout for
|
7958
|
+
# # get_account to 20 seconds,
|
7959
|
+
# # and all remaining timeouts to 10 seconds.
|
7960
|
+
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
7961
|
+
# config.timeout = 10.0
|
7962
|
+
# config.rpcs.get_account.timeout = 20.0
|
7963
|
+
# end
|
7964
|
+
#
|
7965
|
+
# # Apply the above configuration only to a new client.
|
7966
|
+
# client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
|
7967
|
+
# config.timeout = 10.0
|
7968
|
+
# config.rpcs.get_account.timeout = 20.0
|
7969
|
+
# end
|
7970
|
+
#
|
7971
|
+
# @!attribute [rw] endpoint
|
7972
|
+
# The hostname or hostname:port of the service endpoint.
|
7973
|
+
# Defaults to `"analyticsadmin.googleapis.com"`.
|
7974
|
+
# @return [::String]
|
7975
|
+
# @!attribute [rw] credentials
|
7976
|
+
# Credentials to send with calls. You may provide any of the following types:
|
7977
|
+
# * (`String`) The path to a service account key file in JSON format
|
7978
|
+
# * (`Hash`) A service account key as a Hash
|
7979
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
7980
|
+
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
7981
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
7982
|
+
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
7983
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
7984
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
7985
|
+
# * (`nil`) indicating no credentials
|
7986
|
+
# @return [::Object]
|
7987
|
+
# @!attribute [rw] scope
|
7988
|
+
# The OAuth scopes
|
7989
|
+
# @return [::Array<::String>]
|
7990
|
+
# @!attribute [rw] lib_name
|
7991
|
+
# The library name as recorded in instrumentation and logging
|
7992
|
+
# @return [::String]
|
7632
7993
|
# @!attribute [rw] lib_version
|
7633
7994
|
# The library version as recorded in instrumentation and logging
|
7634
7995
|
# @return [::String]
|
@@ -7884,16 +8245,6 @@ module Google
|
|
7884
8245
|
#
|
7885
8246
|
attr_reader :list_android_app_data_streams
|
7886
8247
|
##
|
7887
|
-
# RPC-specific configuration for `get_enhanced_measurement_settings`
|
7888
|
-
# @return [::Gapic::Config::Method]
|
7889
|
-
#
|
7890
|
-
attr_reader :get_enhanced_measurement_settings
|
7891
|
-
##
|
7892
|
-
# RPC-specific configuration for `update_enhanced_measurement_settings`
|
7893
|
-
# @return [::Gapic::Config::Method]
|
7894
|
-
#
|
7895
|
-
attr_reader :update_enhanced_measurement_settings
|
7896
|
-
##
|
7897
8248
|
# RPC-specific configuration for `create_firebase_link`
|
7898
8249
|
# @return [::Gapic::Config::Method]
|
7899
8250
|
#
|
@@ -7964,6 +8315,11 @@ module Google
|
|
7964
8315
|
#
|
7965
8316
|
attr_reader :update_measurement_protocol_secret
|
7966
8317
|
##
|
8318
|
+
# RPC-specific configuration for `acknowledge_user_data_collection`
|
8319
|
+
# @return [::Gapic::Config::Method]
|
8320
|
+
#
|
8321
|
+
attr_reader :acknowledge_user_data_collection
|
8322
|
+
##
|
7967
8323
|
# RPC-specific configuration for `search_change_history_events`
|
7968
8324
|
# @return [::Gapic::Config::Method]
|
7969
8325
|
#
|
@@ -8113,6 +8469,31 @@ module Google
|
|
8113
8469
|
# @return [::Gapic::Config::Method]
|
8114
8470
|
#
|
8115
8471
|
attr_reader :update_data_retention_settings
|
8472
|
+
##
|
8473
|
+
# RPC-specific configuration for `create_data_stream`
|
8474
|
+
# @return [::Gapic::Config::Method]
|
8475
|
+
#
|
8476
|
+
attr_reader :create_data_stream
|
8477
|
+
##
|
8478
|
+
# RPC-specific configuration for `delete_data_stream`
|
8479
|
+
# @return [::Gapic::Config::Method]
|
8480
|
+
#
|
8481
|
+
attr_reader :delete_data_stream
|
8482
|
+
##
|
8483
|
+
# RPC-specific configuration for `update_data_stream`
|
8484
|
+
# @return [::Gapic::Config::Method]
|
8485
|
+
#
|
8486
|
+
attr_reader :update_data_stream
|
8487
|
+
##
|
8488
|
+
# RPC-specific configuration for `list_data_streams`
|
8489
|
+
# @return [::Gapic::Config::Method]
|
8490
|
+
#
|
8491
|
+
attr_reader :list_data_streams
|
8492
|
+
##
|
8493
|
+
# RPC-specific configuration for `get_data_stream`
|
8494
|
+
# @return [::Gapic::Config::Method]
|
8495
|
+
#
|
8496
|
+
attr_reader :get_data_stream
|
8116
8497
|
|
8117
8498
|
# @private
|
8118
8499
|
def initialize parent_rpcs = nil
|
@@ -8184,10 +8565,6 @@ module Google
|
|
8184
8565
|
@update_android_app_data_stream = ::Gapic::Config::Method.new update_android_app_data_stream_config
|
8185
8566
|
list_android_app_data_streams_config = parent_rpcs.list_android_app_data_streams if parent_rpcs.respond_to? :list_android_app_data_streams
|
8186
8567
|
@list_android_app_data_streams = ::Gapic::Config::Method.new list_android_app_data_streams_config
|
8187
|
-
get_enhanced_measurement_settings_config = parent_rpcs.get_enhanced_measurement_settings if parent_rpcs.respond_to? :get_enhanced_measurement_settings
|
8188
|
-
@get_enhanced_measurement_settings = ::Gapic::Config::Method.new get_enhanced_measurement_settings_config
|
8189
|
-
update_enhanced_measurement_settings_config = parent_rpcs.update_enhanced_measurement_settings if parent_rpcs.respond_to? :update_enhanced_measurement_settings
|
8190
|
-
@update_enhanced_measurement_settings = ::Gapic::Config::Method.new update_enhanced_measurement_settings_config
|
8191
8568
|
create_firebase_link_config = parent_rpcs.create_firebase_link if parent_rpcs.respond_to? :create_firebase_link
|
8192
8569
|
@create_firebase_link = ::Gapic::Config::Method.new create_firebase_link_config
|
8193
8570
|
delete_firebase_link_config = parent_rpcs.delete_firebase_link if parent_rpcs.respond_to? :delete_firebase_link
|
@@ -8216,6 +8593,8 @@ module Google
|
|
8216
8593
|
@delete_measurement_protocol_secret = ::Gapic::Config::Method.new delete_measurement_protocol_secret_config
|
8217
8594
|
update_measurement_protocol_secret_config = parent_rpcs.update_measurement_protocol_secret if parent_rpcs.respond_to? :update_measurement_protocol_secret
|
8218
8595
|
@update_measurement_protocol_secret = ::Gapic::Config::Method.new update_measurement_protocol_secret_config
|
8596
|
+
acknowledge_user_data_collection_config = parent_rpcs.acknowledge_user_data_collection if parent_rpcs.respond_to? :acknowledge_user_data_collection
|
8597
|
+
@acknowledge_user_data_collection = ::Gapic::Config::Method.new acknowledge_user_data_collection_config
|
8219
8598
|
search_change_history_events_config = parent_rpcs.search_change_history_events if parent_rpcs.respond_to? :search_change_history_events
|
8220
8599
|
@search_change_history_events = ::Gapic::Config::Method.new search_change_history_events_config
|
8221
8600
|
get_google_signals_settings_config = parent_rpcs.get_google_signals_settings if parent_rpcs.respond_to? :get_google_signals_settings
|
@@ -8276,6 +8655,16 @@ module Google
|
|
8276
8655
|
@get_data_retention_settings = ::Gapic::Config::Method.new get_data_retention_settings_config
|
8277
8656
|
update_data_retention_settings_config = parent_rpcs.update_data_retention_settings if parent_rpcs.respond_to? :update_data_retention_settings
|
8278
8657
|
@update_data_retention_settings = ::Gapic::Config::Method.new update_data_retention_settings_config
|
8658
|
+
create_data_stream_config = parent_rpcs.create_data_stream if parent_rpcs.respond_to? :create_data_stream
|
8659
|
+
@create_data_stream = ::Gapic::Config::Method.new create_data_stream_config
|
8660
|
+
delete_data_stream_config = parent_rpcs.delete_data_stream if parent_rpcs.respond_to? :delete_data_stream
|
8661
|
+
@delete_data_stream = ::Gapic::Config::Method.new delete_data_stream_config
|
8662
|
+
update_data_stream_config = parent_rpcs.update_data_stream if parent_rpcs.respond_to? :update_data_stream
|
8663
|
+
@update_data_stream = ::Gapic::Config::Method.new update_data_stream_config
|
8664
|
+
list_data_streams_config = parent_rpcs.list_data_streams if parent_rpcs.respond_to? :list_data_streams
|
8665
|
+
@list_data_streams = ::Gapic::Config::Method.new list_data_streams_config
|
8666
|
+
get_data_stream_config = parent_rpcs.get_data_stream if parent_rpcs.respond_to? :get_data_stream
|
8667
|
+
@get_data_stream = ::Gapic::Config::Method.new get_data_stream_config
|
8279
8668
|
|
8280
8669
|
yield self if block_given?
|
8281
8670
|
end
|