google-analytics-admin-v1alpha 0.7.0 → 0.8.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/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +120 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1667 -40
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +78 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +46 -1
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +84 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +344 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +256 -4
- metadata +13 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f454a26125ec5a255269bc70c0c6f2ed294fdb962811931181f94597a62da066
|
|
4
|
+
data.tar.gz: 6c863712ac2edf796da9ea1573700607d7fb6fadfa031479dcd3aedafb491ff8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ec394c98f4b86f24565f9b1c92c1597b3167a3232323b47d674eac0ce41ef5d4dedd78c96824fccd80117982db6b8e168478e8e0cf3e6d483b36765d45f07b9e
|
|
7
|
+
data.tar.gz: 5470fa450975a71c08917dafb4ff80b85dace758ea2230bc70ae4d885e474793d96e99d48531ac5bbaa0f8c6615af39ee4223b520de07f7d68962671de3b44ca
|
|
@@ -257,6 +257,101 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
257
257
|
repeated :change_history_events, :message, 1, "google.analytics.admin.v1alpha.ChangeHistoryEvent"
|
|
258
258
|
optional :next_page_token, :string, 2
|
|
259
259
|
end
|
|
260
|
+
add_message "google.analytics.admin.v1alpha.GetMeasurementProtocolSecretRequest" do
|
|
261
|
+
optional :name, :string, 1
|
|
262
|
+
end
|
|
263
|
+
add_message "google.analytics.admin.v1alpha.CreateMeasurementProtocolSecretRequest" do
|
|
264
|
+
optional :parent, :string, 1
|
|
265
|
+
optional :measurement_protocol_secret, :message, 2, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
|
266
|
+
end
|
|
267
|
+
add_message "google.analytics.admin.v1alpha.DeleteMeasurementProtocolSecretRequest" do
|
|
268
|
+
optional :name, :string, 1
|
|
269
|
+
end
|
|
270
|
+
add_message "google.analytics.admin.v1alpha.UpdateMeasurementProtocolSecretRequest" do
|
|
271
|
+
optional :measurement_protocol_secret, :message, 1, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
|
272
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
273
|
+
end
|
|
274
|
+
add_message "google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsRequest" do
|
|
275
|
+
optional :parent, :string, 1
|
|
276
|
+
optional :page_size, :int32, 2
|
|
277
|
+
optional :page_token, :string, 3
|
|
278
|
+
end
|
|
279
|
+
add_message "google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsResponse" do
|
|
280
|
+
repeated :measurement_protocol_secrets, :message, 1, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
|
281
|
+
optional :next_page_token, :string, 2
|
|
282
|
+
end
|
|
283
|
+
add_message "google.analytics.admin.v1alpha.GetGoogleSignalsSettingsRequest" do
|
|
284
|
+
optional :name, :string, 1
|
|
285
|
+
end
|
|
286
|
+
add_message "google.analytics.admin.v1alpha.UpdateGoogleSignalsSettingsRequest" do
|
|
287
|
+
optional :google_signals_settings, :message, 1, "google.analytics.admin.v1alpha.GoogleSignalsSettings"
|
|
288
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
289
|
+
end
|
|
290
|
+
add_message "google.analytics.admin.v1alpha.CreateConversionEventRequest" do
|
|
291
|
+
optional :conversion_event, :message, 1, "google.analytics.admin.v1alpha.ConversionEvent"
|
|
292
|
+
optional :parent, :string, 2
|
|
293
|
+
end
|
|
294
|
+
add_message "google.analytics.admin.v1alpha.GetConversionEventRequest" do
|
|
295
|
+
optional :name, :string, 1
|
|
296
|
+
end
|
|
297
|
+
add_message "google.analytics.admin.v1alpha.DeleteConversionEventRequest" do
|
|
298
|
+
optional :name, :string, 1
|
|
299
|
+
end
|
|
300
|
+
add_message "google.analytics.admin.v1alpha.ListConversionEventsRequest" do
|
|
301
|
+
optional :parent, :string, 1
|
|
302
|
+
optional :page_size, :int32, 2
|
|
303
|
+
optional :page_token, :string, 3
|
|
304
|
+
end
|
|
305
|
+
add_message "google.analytics.admin.v1alpha.ListConversionEventsResponse" do
|
|
306
|
+
repeated :conversion_events, :message, 1, "google.analytics.admin.v1alpha.ConversionEvent"
|
|
307
|
+
optional :next_page_token, :string, 2
|
|
308
|
+
end
|
|
309
|
+
add_message "google.analytics.admin.v1alpha.CreateCustomDimensionRequest" do
|
|
310
|
+
optional :parent, :string, 1
|
|
311
|
+
optional :custom_dimension, :message, 2, "google.analytics.admin.v1alpha.CustomDimension"
|
|
312
|
+
end
|
|
313
|
+
add_message "google.analytics.admin.v1alpha.UpdateCustomDimensionRequest" do
|
|
314
|
+
optional :custom_dimension, :message, 1, "google.analytics.admin.v1alpha.CustomDimension"
|
|
315
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
316
|
+
end
|
|
317
|
+
add_message "google.analytics.admin.v1alpha.ListCustomDimensionsRequest" do
|
|
318
|
+
optional :parent, :string, 1
|
|
319
|
+
optional :page_size, :int32, 2
|
|
320
|
+
optional :page_token, :string, 3
|
|
321
|
+
end
|
|
322
|
+
add_message "google.analytics.admin.v1alpha.ListCustomDimensionsResponse" do
|
|
323
|
+
repeated :custom_dimensions, :message, 1, "google.analytics.admin.v1alpha.CustomDimension"
|
|
324
|
+
optional :next_page_token, :string, 2
|
|
325
|
+
end
|
|
326
|
+
add_message "google.analytics.admin.v1alpha.ArchiveCustomDimensionRequest" do
|
|
327
|
+
optional :name, :string, 1
|
|
328
|
+
end
|
|
329
|
+
add_message "google.analytics.admin.v1alpha.GetCustomDimensionRequest" do
|
|
330
|
+
optional :name, :string, 1
|
|
331
|
+
end
|
|
332
|
+
add_message "google.analytics.admin.v1alpha.CreateCustomMetricRequest" do
|
|
333
|
+
optional :parent, :string, 1
|
|
334
|
+
optional :custom_metric, :message, 2, "google.analytics.admin.v1alpha.CustomMetric"
|
|
335
|
+
end
|
|
336
|
+
add_message "google.analytics.admin.v1alpha.UpdateCustomMetricRequest" do
|
|
337
|
+
optional :custom_metric, :message, 1, "google.analytics.admin.v1alpha.CustomMetric"
|
|
338
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
339
|
+
end
|
|
340
|
+
add_message "google.analytics.admin.v1alpha.ListCustomMetricsRequest" do
|
|
341
|
+
optional :parent, :string, 1
|
|
342
|
+
optional :page_size, :int32, 2
|
|
343
|
+
optional :page_token, :string, 3
|
|
344
|
+
end
|
|
345
|
+
add_message "google.analytics.admin.v1alpha.ListCustomMetricsResponse" do
|
|
346
|
+
repeated :custom_metrics, :message, 1, "google.analytics.admin.v1alpha.CustomMetric"
|
|
347
|
+
optional :next_page_token, :string, 2
|
|
348
|
+
end
|
|
349
|
+
add_message "google.analytics.admin.v1alpha.ArchiveCustomMetricRequest" do
|
|
350
|
+
optional :name, :string, 1
|
|
351
|
+
end
|
|
352
|
+
add_message "google.analytics.admin.v1alpha.GetCustomMetricRequest" do
|
|
353
|
+
optional :name, :string, 1
|
|
354
|
+
end
|
|
260
355
|
end
|
|
261
356
|
end
|
|
262
357
|
|
|
@@ -326,6 +421,31 @@ module Google
|
|
|
326
421
|
ListAccountSummariesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAccountSummariesResponse").msgclass
|
|
327
422
|
SearchChangeHistoryEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest").msgclass
|
|
328
423
|
SearchChangeHistoryEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse").msgclass
|
|
424
|
+
GetMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetMeasurementProtocolSecretRequest").msgclass
|
|
425
|
+
CreateMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateMeasurementProtocolSecretRequest").msgclass
|
|
426
|
+
DeleteMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteMeasurementProtocolSecretRequest").msgclass
|
|
427
|
+
UpdateMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateMeasurementProtocolSecretRequest").msgclass
|
|
428
|
+
ListMeasurementProtocolSecretsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsRequest").msgclass
|
|
429
|
+
ListMeasurementProtocolSecretsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsResponse").msgclass
|
|
430
|
+
GetGoogleSignalsSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetGoogleSignalsSettingsRequest").msgclass
|
|
431
|
+
UpdateGoogleSignalsSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateGoogleSignalsSettingsRequest").msgclass
|
|
432
|
+
CreateConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateConversionEventRequest").msgclass
|
|
433
|
+
GetConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetConversionEventRequest").msgclass
|
|
434
|
+
DeleteConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteConversionEventRequest").msgclass
|
|
435
|
+
ListConversionEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListConversionEventsRequest").msgclass
|
|
436
|
+
ListConversionEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListConversionEventsResponse").msgclass
|
|
437
|
+
CreateCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateCustomDimensionRequest").msgclass
|
|
438
|
+
UpdateCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateCustomDimensionRequest").msgclass
|
|
439
|
+
ListCustomDimensionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomDimensionsRequest").msgclass
|
|
440
|
+
ListCustomDimensionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomDimensionsResponse").msgclass
|
|
441
|
+
ArchiveCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ArchiveCustomDimensionRequest").msgclass
|
|
442
|
+
GetCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetCustomDimensionRequest").msgclass
|
|
443
|
+
CreateCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateCustomMetricRequest").msgclass
|
|
444
|
+
UpdateCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateCustomMetricRequest").msgclass
|
|
445
|
+
ListCustomMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomMetricsRequest").msgclass
|
|
446
|
+
ListCustomMetricsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomMetricsResponse").msgclass
|
|
447
|
+
ArchiveCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ArchiveCustomMetricRequest").msgclass
|
|
448
|
+
GetCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetCustomMetricRequest").msgclass
|
|
329
449
|
end
|
|
330
450
|
end
|
|
331
451
|
end
|
|
@@ -3558,71 +3558,1417 @@ module Google
|
|
|
3558
3558
|
raise ::Google::Cloud::Error.from_error(e)
|
|
3559
3559
|
end
|
|
3560
3560
|
|
|
3561
|
+
##
|
|
3562
|
+
# Lookup for a single "GA4" MeasurementProtocolSecret.
|
|
3563
|
+
#
|
|
3564
|
+
# @overload get_measurement_protocol_secret(request, options = nil)
|
|
3565
|
+
# Pass arguments to `get_measurement_protocol_secret` via a request object, either of type
|
|
3566
|
+
# {::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3567
|
+
#
|
|
3568
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest, ::Hash]
|
|
3569
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3570
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3571
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3572
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3573
|
+
#
|
|
3574
|
+
# @overload get_measurement_protocol_secret(name: nil)
|
|
3575
|
+
# Pass arguments to `get_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3576
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3577
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3578
|
+
#
|
|
3579
|
+
# @param name [::String]
|
|
3580
|
+
# Required. The name of the measurement protocol secret to lookup.
|
|
3581
|
+
# Format:
|
|
3582
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
|
3583
|
+
# Note: Any type of stream (WebDataStream, IosAppDataStream,
|
|
3584
|
+
# AndroidAppDataStream) may be a parent.
|
|
3585
|
+
#
|
|
3586
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3587
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3588
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3589
|
+
#
|
|
3590
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3591
|
+
#
|
|
3592
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3593
|
+
#
|
|
3594
|
+
def get_measurement_protocol_secret request, options = nil
|
|
3595
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3596
|
+
|
|
3597
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest
|
|
3598
|
+
|
|
3599
|
+
# Converts hash and nil to an options object
|
|
3600
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3601
|
+
|
|
3602
|
+
# Customize the options with defaults
|
|
3603
|
+
metadata = @config.rpcs.get_measurement_protocol_secret.metadata.to_h
|
|
3604
|
+
|
|
3605
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3606
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3607
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3608
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3609
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3610
|
+
|
|
3611
|
+
header_params = {
|
|
3612
|
+
"name" => request.name
|
|
3613
|
+
}
|
|
3614
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3615
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3616
|
+
|
|
3617
|
+
options.apply_defaults timeout: @config.rpcs.get_measurement_protocol_secret.timeout,
|
|
3618
|
+
metadata: metadata,
|
|
3619
|
+
retry_policy: @config.rpcs.get_measurement_protocol_secret.retry_policy
|
|
3620
|
+
options.apply_defaults metadata: @config.metadata,
|
|
3621
|
+
retry_policy: @config.retry_policy
|
|
3622
|
+
|
|
3623
|
+
@analytics_admin_service_stub.call_rpc :get_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3624
|
+
yield response, operation if block_given?
|
|
3625
|
+
return response
|
|
3626
|
+
end
|
|
3627
|
+
rescue ::GRPC::BadStatus => e
|
|
3628
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3629
|
+
end
|
|
3630
|
+
|
|
3631
|
+
##
|
|
3632
|
+
# Returns child MeasurementProtocolSecrets under the specified parent
|
|
3633
|
+
# Property.
|
|
3634
|
+
#
|
|
3635
|
+
# @overload list_measurement_protocol_secrets(request, options = nil)
|
|
3636
|
+
# Pass arguments to `list_measurement_protocol_secrets` via a request object, either of type
|
|
3637
|
+
# {::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest} or an equivalent Hash.
|
|
3638
|
+
#
|
|
3639
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest, ::Hash]
|
|
3640
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3641
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3642
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3643
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3644
|
+
#
|
|
3645
|
+
# @overload list_measurement_protocol_secrets(parent: nil, page_size: nil, page_token: nil)
|
|
3646
|
+
# Pass arguments to `list_measurement_protocol_secrets` via keyword arguments. Note that at
|
|
3647
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3648
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3649
|
+
#
|
|
3650
|
+
# @param parent [::String]
|
|
3651
|
+
# Required. The resource name of the parent stream.
|
|
3652
|
+
# Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
|
|
3653
|
+
# may be a parent.
|
|
3654
|
+
# Format:
|
|
3655
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets
|
|
3656
|
+
# @param page_size [::Integer]
|
|
3657
|
+
# The maximum number of resources to return.
|
|
3658
|
+
# If unspecified, at most 10 resources will be returned.
|
|
3659
|
+
# The maximum value is 10. Higher values will be coerced to the maximum.
|
|
3660
|
+
# @param page_token [::String]
|
|
3661
|
+
# A page token, received from a previous `ListMeasurementProtocolSecrets`
|
|
3662
|
+
# call. Provide this to retrieve the subsequent page. When paginating, all
|
|
3663
|
+
# other parameters provided to `ListMeasurementProtocolSecrets` must match
|
|
3664
|
+
# the call that provided the page token.
|
|
3665
|
+
#
|
|
3666
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3667
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
|
|
3668
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3669
|
+
#
|
|
3670
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
|
|
3671
|
+
#
|
|
3672
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3673
|
+
#
|
|
3674
|
+
def list_measurement_protocol_secrets request, options = nil
|
|
3675
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3676
|
+
|
|
3677
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest
|
|
3678
|
+
|
|
3679
|
+
# Converts hash and nil to an options object
|
|
3680
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3681
|
+
|
|
3682
|
+
# Customize the options with defaults
|
|
3683
|
+
metadata = @config.rpcs.list_measurement_protocol_secrets.metadata.to_h
|
|
3684
|
+
|
|
3685
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3686
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3687
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3688
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3689
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3690
|
+
|
|
3691
|
+
header_params = {
|
|
3692
|
+
"parent" => request.parent
|
|
3693
|
+
}
|
|
3694
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3695
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3696
|
+
|
|
3697
|
+
options.apply_defaults timeout: @config.rpcs.list_measurement_protocol_secrets.timeout,
|
|
3698
|
+
metadata: metadata,
|
|
3699
|
+
retry_policy: @config.rpcs.list_measurement_protocol_secrets.retry_policy
|
|
3700
|
+
options.apply_defaults metadata: @config.metadata,
|
|
3701
|
+
retry_policy: @config.retry_policy
|
|
3702
|
+
|
|
3703
|
+
@analytics_admin_service_stub.call_rpc :list_measurement_protocol_secrets, request, options: options do |response, operation|
|
|
3704
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_measurement_protocol_secrets, request, response, operation, options
|
|
3705
|
+
yield response, operation if block_given?
|
|
3706
|
+
return response
|
|
3707
|
+
end
|
|
3708
|
+
rescue ::GRPC::BadStatus => e
|
|
3709
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3710
|
+
end
|
|
3711
|
+
|
|
3712
|
+
##
|
|
3713
|
+
# Creates a measurement protocol secret.
|
|
3714
|
+
#
|
|
3715
|
+
# @overload create_measurement_protocol_secret(request, options = nil)
|
|
3716
|
+
# Pass arguments to `create_measurement_protocol_secret` via a request object, either of type
|
|
3717
|
+
# {::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3718
|
+
#
|
|
3719
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest, ::Hash]
|
|
3720
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3721
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3722
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3723
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3724
|
+
#
|
|
3725
|
+
# @overload create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil)
|
|
3726
|
+
# Pass arguments to `create_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3727
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3728
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3729
|
+
#
|
|
3730
|
+
# @param parent [::String]
|
|
3731
|
+
# Required. The parent resource where this secret will be created.
|
|
3732
|
+
# Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
|
|
3733
|
+
# may be a parent.
|
|
3734
|
+
# Format: properties/\\{property}/webDataStreams/\\{webDataStream}
|
|
3735
|
+
# @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
|
|
3736
|
+
# Required. The measurement protocol secret to create.
|
|
3737
|
+
#
|
|
3738
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3739
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3740
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3741
|
+
#
|
|
3742
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3743
|
+
#
|
|
3744
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3745
|
+
#
|
|
3746
|
+
def create_measurement_protocol_secret request, options = nil
|
|
3747
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3748
|
+
|
|
3749
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest
|
|
3750
|
+
|
|
3751
|
+
# Converts hash and nil to an options object
|
|
3752
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3753
|
+
|
|
3754
|
+
# Customize the options with defaults
|
|
3755
|
+
metadata = @config.rpcs.create_measurement_protocol_secret.metadata.to_h
|
|
3756
|
+
|
|
3757
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3758
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3759
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3760
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3761
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3762
|
+
|
|
3763
|
+
header_params = {
|
|
3764
|
+
"parent" => request.parent
|
|
3765
|
+
}
|
|
3766
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3767
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3768
|
+
|
|
3769
|
+
options.apply_defaults timeout: @config.rpcs.create_measurement_protocol_secret.timeout,
|
|
3770
|
+
metadata: metadata,
|
|
3771
|
+
retry_policy: @config.rpcs.create_measurement_protocol_secret.retry_policy
|
|
3772
|
+
options.apply_defaults metadata: @config.metadata,
|
|
3773
|
+
retry_policy: @config.retry_policy
|
|
3774
|
+
|
|
3775
|
+
@analytics_admin_service_stub.call_rpc :create_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3776
|
+
yield response, operation if block_given?
|
|
3777
|
+
return response
|
|
3778
|
+
end
|
|
3779
|
+
rescue ::GRPC::BadStatus => e
|
|
3780
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3781
|
+
end
|
|
3782
|
+
|
|
3783
|
+
##
|
|
3784
|
+
# Deletes target MeasurementProtocolSecret.
|
|
3785
|
+
#
|
|
3786
|
+
# @overload delete_measurement_protocol_secret(request, options = nil)
|
|
3787
|
+
# Pass arguments to `delete_measurement_protocol_secret` via a request object, either of type
|
|
3788
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3789
|
+
#
|
|
3790
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest, ::Hash]
|
|
3791
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3792
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3793
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3794
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3795
|
+
#
|
|
3796
|
+
# @overload delete_measurement_protocol_secret(name: nil)
|
|
3797
|
+
# Pass arguments to `delete_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3798
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3799
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3800
|
+
#
|
|
3801
|
+
# @param name [::String]
|
|
3802
|
+
# Required. The name of the MeasurementProtocolSecret to delete.
|
|
3803
|
+
# Format:
|
|
3804
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
|
3805
|
+
# Note: Any type of stream (WebDataStream, IosAppDataStream,
|
|
3806
|
+
# AndroidAppDataStream) may be a parent.
|
|
3807
|
+
#
|
|
3808
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3809
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
3810
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3811
|
+
#
|
|
3812
|
+
# @return [::Google::Protobuf::Empty]
|
|
3813
|
+
#
|
|
3814
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3815
|
+
#
|
|
3816
|
+
def delete_measurement_protocol_secret request, options = nil
|
|
3817
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3818
|
+
|
|
3819
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest
|
|
3820
|
+
|
|
3821
|
+
# Converts hash and nil to an options object
|
|
3822
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3823
|
+
|
|
3824
|
+
# Customize the options with defaults
|
|
3825
|
+
metadata = @config.rpcs.delete_measurement_protocol_secret.metadata.to_h
|
|
3826
|
+
|
|
3827
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3828
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3829
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3830
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3831
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3832
|
+
|
|
3833
|
+
header_params = {
|
|
3834
|
+
"name" => request.name
|
|
3835
|
+
}
|
|
3836
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3837
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3838
|
+
|
|
3839
|
+
options.apply_defaults timeout: @config.rpcs.delete_measurement_protocol_secret.timeout,
|
|
3840
|
+
metadata: metadata,
|
|
3841
|
+
retry_policy: @config.rpcs.delete_measurement_protocol_secret.retry_policy
|
|
3842
|
+
options.apply_defaults metadata: @config.metadata,
|
|
3843
|
+
retry_policy: @config.retry_policy
|
|
3844
|
+
|
|
3845
|
+
@analytics_admin_service_stub.call_rpc :delete_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3846
|
+
yield response, operation if block_given?
|
|
3847
|
+
return response
|
|
3848
|
+
end
|
|
3849
|
+
rescue ::GRPC::BadStatus => e
|
|
3850
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3851
|
+
end
|
|
3852
|
+
|
|
3853
|
+
##
|
|
3854
|
+
# Updates a measurement protocol secret.
|
|
3855
|
+
#
|
|
3856
|
+
# @overload update_measurement_protocol_secret(request, options = nil)
|
|
3857
|
+
# Pass arguments to `update_measurement_protocol_secret` via a request object, either of type
|
|
3858
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3859
|
+
#
|
|
3860
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest, ::Hash]
|
|
3861
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3862
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3863
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3864
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3865
|
+
#
|
|
3866
|
+
# @overload update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil)
|
|
3867
|
+
# Pass arguments to `update_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3868
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3869
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3870
|
+
#
|
|
3871
|
+
# @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
|
|
3872
|
+
# Required. The measurement protocol secret to update.
|
|
3873
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
3874
|
+
# The list of fields to be updated. Omitted fields will not be updated.
|
|
3875
|
+
#
|
|
3876
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3877
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3878
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3879
|
+
#
|
|
3880
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3881
|
+
#
|
|
3882
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3883
|
+
#
|
|
3884
|
+
def update_measurement_protocol_secret request, options = nil
|
|
3885
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3886
|
+
|
|
3887
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest
|
|
3888
|
+
|
|
3889
|
+
# Converts hash and nil to an options object
|
|
3890
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3891
|
+
|
|
3892
|
+
# Customize the options with defaults
|
|
3893
|
+
metadata = @config.rpcs.update_measurement_protocol_secret.metadata.to_h
|
|
3894
|
+
|
|
3895
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3896
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3897
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3898
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3899
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3900
|
+
|
|
3901
|
+
header_params = {
|
|
3902
|
+
"measurement_protocol_secret.name" => request.measurement_protocol_secret.name
|
|
3903
|
+
}
|
|
3904
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3905
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3906
|
+
|
|
3907
|
+
options.apply_defaults timeout: @config.rpcs.update_measurement_protocol_secret.timeout,
|
|
3908
|
+
metadata: metadata,
|
|
3909
|
+
retry_policy: @config.rpcs.update_measurement_protocol_secret.retry_policy
|
|
3910
|
+
options.apply_defaults metadata: @config.metadata,
|
|
3911
|
+
retry_policy: @config.retry_policy
|
|
3912
|
+
|
|
3913
|
+
@analytics_admin_service_stub.call_rpc :update_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3914
|
+
yield response, operation if block_given?
|
|
3915
|
+
return response
|
|
3916
|
+
end
|
|
3917
|
+
rescue ::GRPC::BadStatus => e
|
|
3918
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3919
|
+
end
|
|
3920
|
+
|
|
3561
3921
|
##
|
|
3562
3922
|
# Searches through all changes to an account or its children given the
|
|
3563
3923
|
# specified set of filters.
|
|
3564
3924
|
#
|
|
3565
|
-
# @overload search_change_history_events(request, options = nil)
|
|
3566
|
-
# Pass arguments to `search_change_history_events` via a request object, either of type
|
|
3567
|
-
# {::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest} or an equivalent Hash.
|
|
3925
|
+
# @overload search_change_history_events(request, options = nil)
|
|
3926
|
+
# Pass arguments to `search_change_history_events` via a request object, either of type
|
|
3927
|
+
# {::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest} or an equivalent Hash.
|
|
3928
|
+
#
|
|
3929
|
+
# @param request [::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Hash]
|
|
3930
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3931
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3932
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3933
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3934
|
+
#
|
|
3935
|
+
# @overload search_change_history_events(account: nil, property: nil, resource_type: nil, action: nil, actor_email: nil, earliest_change_time: nil, latest_change_time: nil, page_size: nil, page_token: nil)
|
|
3936
|
+
# Pass arguments to `search_change_history_events` via keyword arguments. Note that at
|
|
3937
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3938
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3939
|
+
#
|
|
3940
|
+
# @param account [::String]
|
|
3941
|
+
# Required. The account resource for which to return change history resources.
|
|
3942
|
+
# @param property [::String]
|
|
3943
|
+
# Optional. Resource name for a child property. If set, only return changes
|
|
3944
|
+
# made to this property or its child resources.
|
|
3945
|
+
# @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
|
3946
|
+
# Optional. If set, only return changes if they are for a resource that matches at
|
|
3947
|
+
# least one of these types.
|
|
3948
|
+
# @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
|
|
3949
|
+
# Optional. If set, only return changes that match one or more of these types of
|
|
3950
|
+
# actions.
|
|
3951
|
+
# @param actor_email [::Array<::String>]
|
|
3952
|
+
# Optional. If set, only return changes if they are made by a user in this list.
|
|
3953
|
+
# @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
3954
|
+
# Optional. If set, only return changes made after this time (inclusive).
|
|
3955
|
+
# @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
3956
|
+
# Optional. If set, only return changes made before this time (inclusive).
|
|
3957
|
+
# @param page_size [::Integer]
|
|
3958
|
+
# Optional. The maximum number of ChangeHistoryEvent items to return.
|
|
3959
|
+
# The service may return fewer than this value, even if there are additional
|
|
3960
|
+
# pages. If unspecified, at most 50 items will be returned.
|
|
3961
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
|
3962
|
+
# @param page_token [::String]
|
|
3963
|
+
# Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
|
|
3964
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
|
3965
|
+
# parameters provided to `SearchChangeHistoryEvents` must match the call that
|
|
3966
|
+
# provided the page token.
|
|
3967
|
+
#
|
|
3968
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3969
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
|
|
3970
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3971
|
+
#
|
|
3972
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
|
|
3973
|
+
#
|
|
3974
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3975
|
+
#
|
|
3976
|
+
def search_change_history_events request, options = nil
|
|
3977
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3978
|
+
|
|
3979
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest
|
|
3980
|
+
|
|
3981
|
+
# Converts hash and nil to an options object
|
|
3982
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3983
|
+
|
|
3984
|
+
# Customize the options with defaults
|
|
3985
|
+
metadata = @config.rpcs.search_change_history_events.metadata.to_h
|
|
3986
|
+
|
|
3987
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3988
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3989
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3990
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3991
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3992
|
+
|
|
3993
|
+
header_params = {
|
|
3994
|
+
"account" => request.account
|
|
3995
|
+
}
|
|
3996
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3997
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3998
|
+
|
|
3999
|
+
options.apply_defaults timeout: @config.rpcs.search_change_history_events.timeout,
|
|
4000
|
+
metadata: metadata,
|
|
4001
|
+
retry_policy: @config.rpcs.search_change_history_events.retry_policy
|
|
4002
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4003
|
+
retry_policy: @config.retry_policy
|
|
4004
|
+
|
|
4005
|
+
@analytics_admin_service_stub.call_rpc :search_change_history_events, request, options: options do |response, operation|
|
|
4006
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :search_change_history_events, request, response, operation, options
|
|
4007
|
+
yield response, operation if block_given?
|
|
4008
|
+
return response
|
|
4009
|
+
end
|
|
4010
|
+
rescue ::GRPC::BadStatus => e
|
|
4011
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4012
|
+
end
|
|
4013
|
+
|
|
4014
|
+
##
|
|
4015
|
+
# Lookup for Google Signals settings for a property.
|
|
4016
|
+
#
|
|
4017
|
+
# @overload get_google_signals_settings(request, options = nil)
|
|
4018
|
+
# Pass arguments to `get_google_signals_settings` via a request object, either of type
|
|
4019
|
+
# {::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest} or an equivalent Hash.
|
|
4020
|
+
#
|
|
4021
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest, ::Hash]
|
|
4022
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4023
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4024
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4025
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4026
|
+
#
|
|
4027
|
+
# @overload get_google_signals_settings(name: nil)
|
|
4028
|
+
# Pass arguments to `get_google_signals_settings` via keyword arguments. Note that at
|
|
4029
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4030
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4031
|
+
#
|
|
4032
|
+
# @param name [::String]
|
|
4033
|
+
# Required. The name of the google signals settings to retrieve.
|
|
4034
|
+
# Format: properties/\\{property}/googleSignalsSettings
|
|
4035
|
+
#
|
|
4036
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4037
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4038
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4039
|
+
#
|
|
4040
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4041
|
+
#
|
|
4042
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4043
|
+
#
|
|
4044
|
+
def get_google_signals_settings request, options = nil
|
|
4045
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4046
|
+
|
|
4047
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest
|
|
4048
|
+
|
|
4049
|
+
# Converts hash and nil to an options object
|
|
4050
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4051
|
+
|
|
4052
|
+
# Customize the options with defaults
|
|
4053
|
+
metadata = @config.rpcs.get_google_signals_settings.metadata.to_h
|
|
4054
|
+
|
|
4055
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4056
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4057
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4058
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4059
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4060
|
+
|
|
4061
|
+
header_params = {
|
|
4062
|
+
"name" => request.name
|
|
4063
|
+
}
|
|
4064
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4065
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4066
|
+
|
|
4067
|
+
options.apply_defaults timeout: @config.rpcs.get_google_signals_settings.timeout,
|
|
4068
|
+
metadata: metadata,
|
|
4069
|
+
retry_policy: @config.rpcs.get_google_signals_settings.retry_policy
|
|
4070
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4071
|
+
retry_policy: @config.retry_policy
|
|
4072
|
+
|
|
4073
|
+
@analytics_admin_service_stub.call_rpc :get_google_signals_settings, request, options: options do |response, operation|
|
|
4074
|
+
yield response, operation if block_given?
|
|
4075
|
+
return response
|
|
4076
|
+
end
|
|
4077
|
+
rescue ::GRPC::BadStatus => e
|
|
4078
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4079
|
+
end
|
|
4080
|
+
|
|
4081
|
+
##
|
|
4082
|
+
# Updates Google Signals settings for a property.
|
|
4083
|
+
#
|
|
4084
|
+
# @overload update_google_signals_settings(request, options = nil)
|
|
4085
|
+
# Pass arguments to `update_google_signals_settings` via a request object, either of type
|
|
4086
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest} or an equivalent Hash.
|
|
4087
|
+
#
|
|
4088
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest, ::Hash]
|
|
4089
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4090
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4091
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4092
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4093
|
+
#
|
|
4094
|
+
# @overload update_google_signals_settings(google_signals_settings: nil, update_mask: nil)
|
|
4095
|
+
# Pass arguments to `update_google_signals_settings` via keyword arguments. Note that at
|
|
4096
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4097
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4098
|
+
#
|
|
4099
|
+
# @param google_signals_settings [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings, ::Hash]
|
|
4100
|
+
# Required. The settings to update.
|
|
4101
|
+
# The `name` field is used to identify the settings to be updated.
|
|
4102
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
4103
|
+
# Required. The list of fields to be updated. Field names must be in snake case
|
|
4104
|
+
# (e.g., "field_to_update"). Omitted fields will not be updated. To replace
|
|
4105
|
+
# the entire entity, use one path with the string "*" to match all fields.
|
|
4106
|
+
#
|
|
4107
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4108
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4109
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4110
|
+
#
|
|
4111
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4112
|
+
#
|
|
4113
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4114
|
+
#
|
|
4115
|
+
def update_google_signals_settings request, options = nil
|
|
4116
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4117
|
+
|
|
4118
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest
|
|
4119
|
+
|
|
4120
|
+
# Converts hash and nil to an options object
|
|
4121
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4122
|
+
|
|
4123
|
+
# Customize the options with defaults
|
|
4124
|
+
metadata = @config.rpcs.update_google_signals_settings.metadata.to_h
|
|
4125
|
+
|
|
4126
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4127
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4128
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4129
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4130
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4131
|
+
|
|
4132
|
+
header_params = {
|
|
4133
|
+
"google_signals_settings.name" => request.google_signals_settings.name
|
|
4134
|
+
}
|
|
4135
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4136
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4137
|
+
|
|
4138
|
+
options.apply_defaults timeout: @config.rpcs.update_google_signals_settings.timeout,
|
|
4139
|
+
metadata: metadata,
|
|
4140
|
+
retry_policy: @config.rpcs.update_google_signals_settings.retry_policy
|
|
4141
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4142
|
+
retry_policy: @config.retry_policy
|
|
4143
|
+
|
|
4144
|
+
@analytics_admin_service_stub.call_rpc :update_google_signals_settings, request, options: options do |response, operation|
|
|
4145
|
+
yield response, operation if block_given?
|
|
4146
|
+
return response
|
|
4147
|
+
end
|
|
4148
|
+
rescue ::GRPC::BadStatus => e
|
|
4149
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4150
|
+
end
|
|
4151
|
+
|
|
4152
|
+
##
|
|
4153
|
+
# Creates a conversion event with the specified attributes.
|
|
4154
|
+
#
|
|
4155
|
+
# @overload create_conversion_event(request, options = nil)
|
|
4156
|
+
# Pass arguments to `create_conversion_event` via a request object, either of type
|
|
4157
|
+
# {::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest} or an equivalent Hash.
|
|
4158
|
+
#
|
|
4159
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest, ::Hash]
|
|
4160
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4161
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4162
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4163
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4164
|
+
#
|
|
4165
|
+
# @overload create_conversion_event(conversion_event: nil, parent: nil)
|
|
4166
|
+
# Pass arguments to `create_conversion_event` via keyword arguments. Note that at
|
|
4167
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4168
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4169
|
+
#
|
|
4170
|
+
# @param conversion_event [::Google::Analytics::Admin::V1alpha::ConversionEvent, ::Hash]
|
|
4171
|
+
# Required. The conversion event to create.
|
|
4172
|
+
# @param parent [::String]
|
|
4173
|
+
# Required. The resource name of the parent property where this conversion event will
|
|
4174
|
+
# be created. Format: properties/123
|
|
4175
|
+
#
|
|
4176
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4177
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4178
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4179
|
+
#
|
|
4180
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4181
|
+
#
|
|
4182
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4183
|
+
#
|
|
4184
|
+
def create_conversion_event request, options = nil
|
|
4185
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4186
|
+
|
|
4187
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest
|
|
4188
|
+
|
|
4189
|
+
# Converts hash and nil to an options object
|
|
4190
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4191
|
+
|
|
4192
|
+
# Customize the options with defaults
|
|
4193
|
+
metadata = @config.rpcs.create_conversion_event.metadata.to_h
|
|
4194
|
+
|
|
4195
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4196
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4197
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4198
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4199
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4200
|
+
|
|
4201
|
+
header_params = {
|
|
4202
|
+
"parent" => request.parent
|
|
4203
|
+
}
|
|
4204
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4205
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4206
|
+
|
|
4207
|
+
options.apply_defaults timeout: @config.rpcs.create_conversion_event.timeout,
|
|
4208
|
+
metadata: metadata,
|
|
4209
|
+
retry_policy: @config.rpcs.create_conversion_event.retry_policy
|
|
4210
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4211
|
+
retry_policy: @config.retry_policy
|
|
4212
|
+
|
|
4213
|
+
@analytics_admin_service_stub.call_rpc :create_conversion_event, request, options: options do |response, operation|
|
|
4214
|
+
yield response, operation if block_given?
|
|
4215
|
+
return response
|
|
4216
|
+
end
|
|
4217
|
+
rescue ::GRPC::BadStatus => e
|
|
4218
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4219
|
+
end
|
|
4220
|
+
|
|
4221
|
+
##
|
|
4222
|
+
# Retrieve a single conversion event.
|
|
4223
|
+
#
|
|
4224
|
+
# @overload get_conversion_event(request, options = nil)
|
|
4225
|
+
# Pass arguments to `get_conversion_event` via a request object, either of type
|
|
4226
|
+
# {::Google::Analytics::Admin::V1alpha::GetConversionEventRequest} or an equivalent Hash.
|
|
4227
|
+
#
|
|
4228
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetConversionEventRequest, ::Hash]
|
|
4229
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4230
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4231
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4232
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4233
|
+
#
|
|
4234
|
+
# @overload get_conversion_event(name: nil)
|
|
4235
|
+
# Pass arguments to `get_conversion_event` via keyword arguments. Note that at
|
|
4236
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4237
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4238
|
+
#
|
|
4239
|
+
# @param name [::String]
|
|
4240
|
+
# Required. The resource name of the conversion event to retrieve.
|
|
4241
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
|
4242
|
+
# Example: "properties/123/conversionEvents/456"
|
|
4243
|
+
#
|
|
4244
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4245
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4246
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4247
|
+
#
|
|
4248
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4249
|
+
#
|
|
4250
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4251
|
+
#
|
|
4252
|
+
def get_conversion_event request, options = nil
|
|
4253
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4254
|
+
|
|
4255
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetConversionEventRequest
|
|
4256
|
+
|
|
4257
|
+
# Converts hash and nil to an options object
|
|
4258
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4259
|
+
|
|
4260
|
+
# Customize the options with defaults
|
|
4261
|
+
metadata = @config.rpcs.get_conversion_event.metadata.to_h
|
|
4262
|
+
|
|
4263
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4264
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4265
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4266
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4267
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4268
|
+
|
|
4269
|
+
header_params = {
|
|
4270
|
+
"name" => request.name
|
|
4271
|
+
}
|
|
4272
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4273
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4274
|
+
|
|
4275
|
+
options.apply_defaults timeout: @config.rpcs.get_conversion_event.timeout,
|
|
4276
|
+
metadata: metadata,
|
|
4277
|
+
retry_policy: @config.rpcs.get_conversion_event.retry_policy
|
|
4278
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4279
|
+
retry_policy: @config.retry_policy
|
|
4280
|
+
|
|
4281
|
+
@analytics_admin_service_stub.call_rpc :get_conversion_event, request, options: options do |response, operation|
|
|
4282
|
+
yield response, operation if block_given?
|
|
4283
|
+
return response
|
|
4284
|
+
end
|
|
4285
|
+
rescue ::GRPC::BadStatus => e
|
|
4286
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4287
|
+
end
|
|
4288
|
+
|
|
4289
|
+
##
|
|
4290
|
+
# Deletes a conversion event in a property.
|
|
4291
|
+
#
|
|
4292
|
+
# @overload delete_conversion_event(request, options = nil)
|
|
4293
|
+
# Pass arguments to `delete_conversion_event` via a request object, either of type
|
|
4294
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest} or an equivalent Hash.
|
|
4295
|
+
#
|
|
4296
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest, ::Hash]
|
|
4297
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4298
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4299
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4300
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4301
|
+
#
|
|
4302
|
+
# @overload delete_conversion_event(name: nil)
|
|
4303
|
+
# Pass arguments to `delete_conversion_event` via keyword arguments. Note that at
|
|
4304
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4305
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4306
|
+
#
|
|
4307
|
+
# @param name [::String]
|
|
4308
|
+
# Required. The resource name of the conversion event to delete.
|
|
4309
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
|
4310
|
+
# Example: "properties/123/conversionEvents/456"
|
|
4311
|
+
#
|
|
4312
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4313
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
4314
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4315
|
+
#
|
|
4316
|
+
# @return [::Google::Protobuf::Empty]
|
|
4317
|
+
#
|
|
4318
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4319
|
+
#
|
|
4320
|
+
def delete_conversion_event request, options = nil
|
|
4321
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4322
|
+
|
|
4323
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest
|
|
4324
|
+
|
|
4325
|
+
# Converts hash and nil to an options object
|
|
4326
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4327
|
+
|
|
4328
|
+
# Customize the options with defaults
|
|
4329
|
+
metadata = @config.rpcs.delete_conversion_event.metadata.to_h
|
|
4330
|
+
|
|
4331
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4332
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4333
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4334
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4335
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4336
|
+
|
|
4337
|
+
header_params = {
|
|
4338
|
+
"name" => request.name
|
|
4339
|
+
}
|
|
4340
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4341
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4342
|
+
|
|
4343
|
+
options.apply_defaults timeout: @config.rpcs.delete_conversion_event.timeout,
|
|
4344
|
+
metadata: metadata,
|
|
4345
|
+
retry_policy: @config.rpcs.delete_conversion_event.retry_policy
|
|
4346
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4347
|
+
retry_policy: @config.retry_policy
|
|
4348
|
+
|
|
4349
|
+
@analytics_admin_service_stub.call_rpc :delete_conversion_event, request, options: options do |response, operation|
|
|
4350
|
+
yield response, operation if block_given?
|
|
4351
|
+
return response
|
|
4352
|
+
end
|
|
4353
|
+
rescue ::GRPC::BadStatus => e
|
|
4354
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4355
|
+
end
|
|
4356
|
+
|
|
4357
|
+
##
|
|
4358
|
+
# Returns a list of conversion events in the specified parent property.
|
|
4359
|
+
#
|
|
4360
|
+
# Returns an empty list if no conversion events are found.
|
|
4361
|
+
#
|
|
4362
|
+
# @overload list_conversion_events(request, options = nil)
|
|
4363
|
+
# Pass arguments to `list_conversion_events` via a request object, either of type
|
|
4364
|
+
# {::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest} or an equivalent Hash.
|
|
4365
|
+
#
|
|
4366
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest, ::Hash]
|
|
4367
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4368
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4369
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4370
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4371
|
+
#
|
|
4372
|
+
# @overload list_conversion_events(parent: nil, page_size: nil, page_token: nil)
|
|
4373
|
+
# Pass arguments to `list_conversion_events` via keyword arguments. Note that at
|
|
4374
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4375
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4376
|
+
#
|
|
4377
|
+
# @param parent [::String]
|
|
4378
|
+
# Required. The resource name of the parent property.
|
|
4379
|
+
# Example: 'properties/123'
|
|
4380
|
+
# @param page_size [::Integer]
|
|
4381
|
+
# The maximum number of resources to return.
|
|
4382
|
+
# If unspecified, at most 50 resources will be returned.
|
|
4383
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
|
4384
|
+
# @param page_token [::String]
|
|
4385
|
+
# A page token, received from a previous `ListConversionEvents` call.
|
|
4386
|
+
# Provide this to retrieve the subsequent page.
|
|
4387
|
+
# When paginating, all other parameters provided to `ListConversionEvents`
|
|
4388
|
+
# must match the call that provided the page token.
|
|
4389
|
+
#
|
|
4390
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4391
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
|
|
4392
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4393
|
+
#
|
|
4394
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
|
|
4395
|
+
#
|
|
4396
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4397
|
+
#
|
|
4398
|
+
def list_conversion_events request, options = nil
|
|
4399
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4400
|
+
|
|
4401
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest
|
|
4402
|
+
|
|
4403
|
+
# Converts hash and nil to an options object
|
|
4404
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4405
|
+
|
|
4406
|
+
# Customize the options with defaults
|
|
4407
|
+
metadata = @config.rpcs.list_conversion_events.metadata.to_h
|
|
4408
|
+
|
|
4409
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4410
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4411
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4412
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4413
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4414
|
+
|
|
4415
|
+
header_params = {
|
|
4416
|
+
"parent" => request.parent
|
|
4417
|
+
}
|
|
4418
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4419
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4420
|
+
|
|
4421
|
+
options.apply_defaults timeout: @config.rpcs.list_conversion_events.timeout,
|
|
4422
|
+
metadata: metadata,
|
|
4423
|
+
retry_policy: @config.rpcs.list_conversion_events.retry_policy
|
|
4424
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4425
|
+
retry_policy: @config.retry_policy
|
|
4426
|
+
|
|
4427
|
+
@analytics_admin_service_stub.call_rpc :list_conversion_events, request, options: options do |response, operation|
|
|
4428
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_conversion_events, request, response, operation, options
|
|
4429
|
+
yield response, operation if block_given?
|
|
4430
|
+
return response
|
|
4431
|
+
end
|
|
4432
|
+
rescue ::GRPC::BadStatus => e
|
|
4433
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4434
|
+
end
|
|
4435
|
+
|
|
4436
|
+
##
|
|
4437
|
+
# Creates a CustomDimension.
|
|
4438
|
+
#
|
|
4439
|
+
# @overload create_custom_dimension(request, options = nil)
|
|
4440
|
+
# Pass arguments to `create_custom_dimension` via a request object, either of type
|
|
4441
|
+
# {::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest} or an equivalent Hash.
|
|
4442
|
+
#
|
|
4443
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest, ::Hash]
|
|
4444
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4445
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4446
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4447
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4448
|
+
#
|
|
4449
|
+
# @overload create_custom_dimension(parent: nil, custom_dimension: nil)
|
|
4450
|
+
# Pass arguments to `create_custom_dimension` via keyword arguments. Note that at
|
|
4451
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4452
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4453
|
+
#
|
|
4454
|
+
# @param parent [::String]
|
|
4455
|
+
# Required. Example format: properties/1234
|
|
4456
|
+
# @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
|
|
4457
|
+
# Required. The CustomDimension to create.
|
|
4458
|
+
#
|
|
4459
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4460
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4461
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4462
|
+
#
|
|
4463
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4464
|
+
#
|
|
4465
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4466
|
+
#
|
|
4467
|
+
def create_custom_dimension request, options = nil
|
|
4468
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4469
|
+
|
|
4470
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest
|
|
4471
|
+
|
|
4472
|
+
# Converts hash and nil to an options object
|
|
4473
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4474
|
+
|
|
4475
|
+
# Customize the options with defaults
|
|
4476
|
+
metadata = @config.rpcs.create_custom_dimension.metadata.to_h
|
|
4477
|
+
|
|
4478
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4479
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4480
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4481
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4482
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4483
|
+
|
|
4484
|
+
header_params = {
|
|
4485
|
+
"parent" => request.parent
|
|
4486
|
+
}
|
|
4487
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4488
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4489
|
+
|
|
4490
|
+
options.apply_defaults timeout: @config.rpcs.create_custom_dimension.timeout,
|
|
4491
|
+
metadata: metadata,
|
|
4492
|
+
retry_policy: @config.rpcs.create_custom_dimension.retry_policy
|
|
4493
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4494
|
+
retry_policy: @config.retry_policy
|
|
4495
|
+
|
|
4496
|
+
@analytics_admin_service_stub.call_rpc :create_custom_dimension, request, options: options do |response, operation|
|
|
4497
|
+
yield response, operation if block_given?
|
|
4498
|
+
return response
|
|
4499
|
+
end
|
|
4500
|
+
rescue ::GRPC::BadStatus => e
|
|
4501
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4502
|
+
end
|
|
4503
|
+
|
|
4504
|
+
##
|
|
4505
|
+
# Updates a CustomDimension on a property.
|
|
4506
|
+
#
|
|
4507
|
+
# @overload update_custom_dimension(request, options = nil)
|
|
4508
|
+
# Pass arguments to `update_custom_dimension` via a request object, either of type
|
|
4509
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest} or an equivalent Hash.
|
|
4510
|
+
#
|
|
4511
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest, ::Hash]
|
|
4512
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4513
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4514
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4515
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4516
|
+
#
|
|
4517
|
+
# @overload update_custom_dimension(custom_dimension: nil, update_mask: nil)
|
|
4518
|
+
# Pass arguments to `update_custom_dimension` via keyword arguments. Note that at
|
|
4519
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4520
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4521
|
+
#
|
|
4522
|
+
# @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
|
|
4523
|
+
# The CustomDimension to update
|
|
4524
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
4525
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
|
4526
|
+
# To replace the entire entity, use one path with the string "*" to match
|
|
4527
|
+
# all fields.
|
|
4528
|
+
#
|
|
4529
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4530
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4531
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4532
|
+
#
|
|
4533
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4534
|
+
#
|
|
4535
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4536
|
+
#
|
|
4537
|
+
def update_custom_dimension request, options = nil
|
|
4538
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4539
|
+
|
|
4540
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest
|
|
4541
|
+
|
|
4542
|
+
# Converts hash and nil to an options object
|
|
4543
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4544
|
+
|
|
4545
|
+
# Customize the options with defaults
|
|
4546
|
+
metadata = @config.rpcs.update_custom_dimension.metadata.to_h
|
|
4547
|
+
|
|
4548
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4549
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4550
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4551
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4552
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4553
|
+
|
|
4554
|
+
header_params = {
|
|
4555
|
+
"custom_dimension.name" => request.custom_dimension.name
|
|
4556
|
+
}
|
|
4557
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4558
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4559
|
+
|
|
4560
|
+
options.apply_defaults timeout: @config.rpcs.update_custom_dimension.timeout,
|
|
4561
|
+
metadata: metadata,
|
|
4562
|
+
retry_policy: @config.rpcs.update_custom_dimension.retry_policy
|
|
4563
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4564
|
+
retry_policy: @config.retry_policy
|
|
4565
|
+
|
|
4566
|
+
@analytics_admin_service_stub.call_rpc :update_custom_dimension, request, options: options do |response, operation|
|
|
4567
|
+
yield response, operation if block_given?
|
|
4568
|
+
return response
|
|
4569
|
+
end
|
|
4570
|
+
rescue ::GRPC::BadStatus => e
|
|
4571
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4572
|
+
end
|
|
4573
|
+
|
|
4574
|
+
##
|
|
4575
|
+
# Lists CustomDimensions on a property.
|
|
4576
|
+
#
|
|
4577
|
+
# @overload list_custom_dimensions(request, options = nil)
|
|
4578
|
+
# Pass arguments to `list_custom_dimensions` via a request object, either of type
|
|
4579
|
+
# {::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest} or an equivalent Hash.
|
|
4580
|
+
#
|
|
4581
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest, ::Hash]
|
|
4582
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4583
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4584
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4585
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4586
|
+
#
|
|
4587
|
+
# @overload list_custom_dimensions(parent: nil, page_size: nil, page_token: nil)
|
|
4588
|
+
# Pass arguments to `list_custom_dimensions` via keyword arguments. Note that at
|
|
4589
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4590
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4591
|
+
#
|
|
4592
|
+
# @param parent [::String]
|
|
4593
|
+
# Required. Example format: properties/1234
|
|
4594
|
+
# @param page_size [::Integer]
|
|
4595
|
+
# The maximum number of resources to return.
|
|
4596
|
+
# If unspecified, at most 50 resources will be returned.
|
|
4597
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
|
4598
|
+
# @param page_token [::String]
|
|
4599
|
+
# A page token, received from a previous `ListCustomDimensions` call.
|
|
4600
|
+
# Provide this to retrieve the subsequent page.
|
|
4601
|
+
#
|
|
4602
|
+
# When paginating, all other parameters provided to `ListCustomDimensions`
|
|
4603
|
+
# must match the call that provided the page token.
|
|
4604
|
+
#
|
|
4605
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4606
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>]
|
|
4607
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4608
|
+
#
|
|
4609
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>]
|
|
4610
|
+
#
|
|
4611
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4612
|
+
#
|
|
4613
|
+
def list_custom_dimensions request, options = nil
|
|
4614
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4615
|
+
|
|
4616
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest
|
|
4617
|
+
|
|
4618
|
+
# Converts hash and nil to an options object
|
|
4619
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4620
|
+
|
|
4621
|
+
# Customize the options with defaults
|
|
4622
|
+
metadata = @config.rpcs.list_custom_dimensions.metadata.to_h
|
|
4623
|
+
|
|
4624
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4625
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4626
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4627
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4628
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4629
|
+
|
|
4630
|
+
header_params = {
|
|
4631
|
+
"parent" => request.parent
|
|
4632
|
+
}
|
|
4633
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4634
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4635
|
+
|
|
4636
|
+
options.apply_defaults timeout: @config.rpcs.list_custom_dimensions.timeout,
|
|
4637
|
+
metadata: metadata,
|
|
4638
|
+
retry_policy: @config.rpcs.list_custom_dimensions.retry_policy
|
|
4639
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4640
|
+
retry_policy: @config.retry_policy
|
|
4641
|
+
|
|
4642
|
+
@analytics_admin_service_stub.call_rpc :list_custom_dimensions, request, options: options do |response, operation|
|
|
4643
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_dimensions, request, response, operation, options
|
|
4644
|
+
yield response, operation if block_given?
|
|
4645
|
+
return response
|
|
4646
|
+
end
|
|
4647
|
+
rescue ::GRPC::BadStatus => e
|
|
4648
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4649
|
+
end
|
|
4650
|
+
|
|
4651
|
+
##
|
|
4652
|
+
# Archives a CustomDimension on a property.
|
|
4653
|
+
#
|
|
4654
|
+
# @overload archive_custom_dimension(request, options = nil)
|
|
4655
|
+
# Pass arguments to `archive_custom_dimension` via a request object, either of type
|
|
4656
|
+
# {::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest} or an equivalent Hash.
|
|
4657
|
+
#
|
|
4658
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest, ::Hash]
|
|
4659
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4660
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4661
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4662
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4663
|
+
#
|
|
4664
|
+
# @overload archive_custom_dimension(name: nil)
|
|
4665
|
+
# Pass arguments to `archive_custom_dimension` via keyword arguments. Note that at
|
|
4666
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4667
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4668
|
+
#
|
|
4669
|
+
# @param name [::String]
|
|
4670
|
+
# Required. The name of the CustomDimension to archive.
|
|
4671
|
+
# Example format: properties/1234/customDimensions/5678
|
|
4672
|
+
#
|
|
4673
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4674
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
4675
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4676
|
+
#
|
|
4677
|
+
# @return [::Google::Protobuf::Empty]
|
|
4678
|
+
#
|
|
4679
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4680
|
+
#
|
|
4681
|
+
def archive_custom_dimension request, options = nil
|
|
4682
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4683
|
+
|
|
4684
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest
|
|
4685
|
+
|
|
4686
|
+
# Converts hash and nil to an options object
|
|
4687
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4688
|
+
|
|
4689
|
+
# Customize the options with defaults
|
|
4690
|
+
metadata = @config.rpcs.archive_custom_dimension.metadata.to_h
|
|
4691
|
+
|
|
4692
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4693
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4694
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4695
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4696
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4697
|
+
|
|
4698
|
+
header_params = {
|
|
4699
|
+
"name" => request.name
|
|
4700
|
+
}
|
|
4701
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4702
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4703
|
+
|
|
4704
|
+
options.apply_defaults timeout: @config.rpcs.archive_custom_dimension.timeout,
|
|
4705
|
+
metadata: metadata,
|
|
4706
|
+
retry_policy: @config.rpcs.archive_custom_dimension.retry_policy
|
|
4707
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4708
|
+
retry_policy: @config.retry_policy
|
|
4709
|
+
|
|
4710
|
+
@analytics_admin_service_stub.call_rpc :archive_custom_dimension, request, options: options do |response, operation|
|
|
4711
|
+
yield response, operation if block_given?
|
|
4712
|
+
return response
|
|
4713
|
+
end
|
|
4714
|
+
rescue ::GRPC::BadStatus => e
|
|
4715
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4716
|
+
end
|
|
4717
|
+
|
|
4718
|
+
##
|
|
4719
|
+
# Lookup for a single CustomDimension.
|
|
4720
|
+
#
|
|
4721
|
+
# @overload get_custom_dimension(request, options = nil)
|
|
4722
|
+
# Pass arguments to `get_custom_dimension` via a request object, either of type
|
|
4723
|
+
# {::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest} or an equivalent Hash.
|
|
4724
|
+
#
|
|
4725
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest, ::Hash]
|
|
4726
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4727
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4728
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4729
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4730
|
+
#
|
|
4731
|
+
# @overload get_custom_dimension(name: nil)
|
|
4732
|
+
# Pass arguments to `get_custom_dimension` via keyword arguments. Note that at
|
|
4733
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4734
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4735
|
+
#
|
|
4736
|
+
# @param name [::String]
|
|
4737
|
+
# Required. The name of the CustomDimension to get.
|
|
4738
|
+
# Example format: properties/1234/customDimensions/5678
|
|
4739
|
+
#
|
|
4740
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4741
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4742
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4743
|
+
#
|
|
4744
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4745
|
+
#
|
|
4746
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4747
|
+
#
|
|
4748
|
+
def get_custom_dimension request, options = nil
|
|
4749
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4750
|
+
|
|
4751
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest
|
|
4752
|
+
|
|
4753
|
+
# Converts hash and nil to an options object
|
|
4754
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4755
|
+
|
|
4756
|
+
# Customize the options with defaults
|
|
4757
|
+
metadata = @config.rpcs.get_custom_dimension.metadata.to_h
|
|
4758
|
+
|
|
4759
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4760
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4761
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4762
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4763
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4764
|
+
|
|
4765
|
+
header_params = {
|
|
4766
|
+
"name" => request.name
|
|
4767
|
+
}
|
|
4768
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4769
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4770
|
+
|
|
4771
|
+
options.apply_defaults timeout: @config.rpcs.get_custom_dimension.timeout,
|
|
4772
|
+
metadata: metadata,
|
|
4773
|
+
retry_policy: @config.rpcs.get_custom_dimension.retry_policy
|
|
4774
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4775
|
+
retry_policy: @config.retry_policy
|
|
4776
|
+
|
|
4777
|
+
@analytics_admin_service_stub.call_rpc :get_custom_dimension, request, options: options do |response, operation|
|
|
4778
|
+
yield response, operation if block_given?
|
|
4779
|
+
return response
|
|
4780
|
+
end
|
|
4781
|
+
rescue ::GRPC::BadStatus => e
|
|
4782
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4783
|
+
end
|
|
4784
|
+
|
|
4785
|
+
##
|
|
4786
|
+
# Creates a CustomMetric.
|
|
4787
|
+
#
|
|
4788
|
+
# @overload create_custom_metric(request, options = nil)
|
|
4789
|
+
# Pass arguments to `create_custom_metric` via a request object, either of type
|
|
4790
|
+
# {::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest} or an equivalent Hash.
|
|
4791
|
+
#
|
|
4792
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest, ::Hash]
|
|
4793
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4794
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4795
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4796
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4797
|
+
#
|
|
4798
|
+
# @overload create_custom_metric(parent: nil, custom_metric: nil)
|
|
4799
|
+
# Pass arguments to `create_custom_metric` via keyword arguments. Note that at
|
|
4800
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4801
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4802
|
+
#
|
|
4803
|
+
# @param parent [::String]
|
|
4804
|
+
# Required. Example format: properties/1234
|
|
4805
|
+
# @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
|
|
4806
|
+
# Required. The CustomMetric to create.
|
|
4807
|
+
#
|
|
4808
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4809
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4810
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4811
|
+
#
|
|
4812
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4813
|
+
#
|
|
4814
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4815
|
+
#
|
|
4816
|
+
def create_custom_metric request, options = nil
|
|
4817
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4818
|
+
|
|
4819
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest
|
|
4820
|
+
|
|
4821
|
+
# Converts hash and nil to an options object
|
|
4822
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4823
|
+
|
|
4824
|
+
# Customize the options with defaults
|
|
4825
|
+
metadata = @config.rpcs.create_custom_metric.metadata.to_h
|
|
4826
|
+
|
|
4827
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4828
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4829
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4830
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4831
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4832
|
+
|
|
4833
|
+
header_params = {
|
|
4834
|
+
"parent" => request.parent
|
|
4835
|
+
}
|
|
4836
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4837
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4838
|
+
|
|
4839
|
+
options.apply_defaults timeout: @config.rpcs.create_custom_metric.timeout,
|
|
4840
|
+
metadata: metadata,
|
|
4841
|
+
retry_policy: @config.rpcs.create_custom_metric.retry_policy
|
|
4842
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4843
|
+
retry_policy: @config.retry_policy
|
|
4844
|
+
|
|
4845
|
+
@analytics_admin_service_stub.call_rpc :create_custom_metric, request, options: options do |response, operation|
|
|
4846
|
+
yield response, operation if block_given?
|
|
4847
|
+
return response
|
|
4848
|
+
end
|
|
4849
|
+
rescue ::GRPC::BadStatus => e
|
|
4850
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4851
|
+
end
|
|
4852
|
+
|
|
4853
|
+
##
|
|
4854
|
+
# Updates a CustomMetric on a property.
|
|
4855
|
+
#
|
|
4856
|
+
# @overload update_custom_metric(request, options = nil)
|
|
4857
|
+
# Pass arguments to `update_custom_metric` via a request object, either of type
|
|
4858
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest} or an equivalent Hash.
|
|
4859
|
+
#
|
|
4860
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest, ::Hash]
|
|
4861
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4862
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4863
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4864
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4865
|
+
#
|
|
4866
|
+
# @overload update_custom_metric(custom_metric: nil, update_mask: nil)
|
|
4867
|
+
# Pass arguments to `update_custom_metric` via keyword arguments. Note that at
|
|
4868
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4869
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3568
4870
|
#
|
|
3569
|
-
# @param
|
|
4871
|
+
# @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
|
|
4872
|
+
# The CustomMetric to update
|
|
4873
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
4874
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
|
4875
|
+
# To replace the entire entity, use one path with the string "*" to match
|
|
4876
|
+
# all fields.
|
|
4877
|
+
#
|
|
4878
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4879
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4880
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4881
|
+
#
|
|
4882
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4883
|
+
#
|
|
4884
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4885
|
+
#
|
|
4886
|
+
def update_custom_metric request, options = nil
|
|
4887
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4888
|
+
|
|
4889
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest
|
|
4890
|
+
|
|
4891
|
+
# Converts hash and nil to an options object
|
|
4892
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4893
|
+
|
|
4894
|
+
# Customize the options with defaults
|
|
4895
|
+
metadata = @config.rpcs.update_custom_metric.metadata.to_h
|
|
4896
|
+
|
|
4897
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4898
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4899
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4900
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4901
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4902
|
+
|
|
4903
|
+
header_params = {
|
|
4904
|
+
"custom_metric.name" => request.custom_metric.name
|
|
4905
|
+
}
|
|
4906
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4907
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4908
|
+
|
|
4909
|
+
options.apply_defaults timeout: @config.rpcs.update_custom_metric.timeout,
|
|
4910
|
+
metadata: metadata,
|
|
4911
|
+
retry_policy: @config.rpcs.update_custom_metric.retry_policy
|
|
4912
|
+
options.apply_defaults metadata: @config.metadata,
|
|
4913
|
+
retry_policy: @config.retry_policy
|
|
4914
|
+
|
|
4915
|
+
@analytics_admin_service_stub.call_rpc :update_custom_metric, request, options: options do |response, operation|
|
|
4916
|
+
yield response, operation if block_given?
|
|
4917
|
+
return response
|
|
4918
|
+
end
|
|
4919
|
+
rescue ::GRPC::BadStatus => e
|
|
4920
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4921
|
+
end
|
|
4922
|
+
|
|
4923
|
+
##
|
|
4924
|
+
# Lists CustomMetrics on a property.
|
|
4925
|
+
#
|
|
4926
|
+
# @overload list_custom_metrics(request, options = nil)
|
|
4927
|
+
# Pass arguments to `list_custom_metrics` via a request object, either of type
|
|
4928
|
+
# {::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest} or an equivalent Hash.
|
|
4929
|
+
#
|
|
4930
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest, ::Hash]
|
|
3570
4931
|
# A request object representing the call parameters. Required. To specify no
|
|
3571
4932
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3572
4933
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3573
4934
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3574
4935
|
#
|
|
3575
|
-
# @overload
|
|
3576
|
-
# Pass arguments to `
|
|
4936
|
+
# @overload list_custom_metrics(parent: nil, page_size: nil, page_token: nil)
|
|
4937
|
+
# Pass arguments to `list_custom_metrics` via keyword arguments. Note that at
|
|
3577
4938
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3578
4939
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3579
4940
|
#
|
|
3580
|
-
# @param
|
|
3581
|
-
# Required.
|
|
3582
|
-
# @param property [::String]
|
|
3583
|
-
# Optional. Resource name for a child property. If set, only return changes
|
|
3584
|
-
# made to this property or its child resources.
|
|
3585
|
-
# @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
|
3586
|
-
# Optional. If set, only return changes if they are for a resource that matches at
|
|
3587
|
-
# least one of these types.
|
|
3588
|
-
# @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
|
|
3589
|
-
# Optional. If set, only return changes that match one or more of these types of
|
|
3590
|
-
# actions.
|
|
3591
|
-
# @param actor_email [::Array<::String>]
|
|
3592
|
-
# Optional. If set, only return changes if they are made by a user in this list.
|
|
3593
|
-
# @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
3594
|
-
# Optional. If set, only return changes made after this time (inclusive).
|
|
3595
|
-
# @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
3596
|
-
# Optional. If set, only return changes made before this time (inclusive).
|
|
4941
|
+
# @param parent [::String]
|
|
4942
|
+
# Required. Example format: properties/1234
|
|
3597
4943
|
# @param page_size [::Integer]
|
|
3598
|
-
#
|
|
3599
|
-
#
|
|
3600
|
-
# pages. If unspecified, at most 50 items will be returned.
|
|
4944
|
+
# The maximum number of resources to return.
|
|
4945
|
+
# If unspecified, at most 50 resources will be returned.
|
|
3601
4946
|
# The maximum value is 200 (higher values will be coerced to the maximum).
|
|
3602
4947
|
# @param page_token [::String]
|
|
3603
|
-
#
|
|
3604
|
-
# Provide this to retrieve the subsequent page.
|
|
3605
|
-
#
|
|
3606
|
-
# provided
|
|
4948
|
+
# A page token, received from a previous `ListCustomMetrics` call.
|
|
4949
|
+
# Provide this to retrieve the subsequent page.
|
|
4950
|
+
#
|
|
4951
|
+
# When paginating, all other parameters provided to `ListCustomMetrics` must
|
|
4952
|
+
# match the call that provided the page token.
|
|
3607
4953
|
#
|
|
3608
4954
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
3609
|
-
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::
|
|
4955
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>]
|
|
3610
4956
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3611
4957
|
#
|
|
3612
|
-
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::
|
|
4958
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>]
|
|
3613
4959
|
#
|
|
3614
4960
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3615
4961
|
#
|
|
3616
|
-
def
|
|
4962
|
+
def list_custom_metrics request, options = nil
|
|
3617
4963
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3618
4964
|
|
|
3619
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
|
4965
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest
|
|
3620
4966
|
|
|
3621
4967
|
# Converts hash and nil to an options object
|
|
3622
4968
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3623
4969
|
|
|
3624
4970
|
# Customize the options with defaults
|
|
3625
|
-
metadata = @config.rpcs.
|
|
4971
|
+
metadata = @config.rpcs.list_custom_metrics.metadata.to_h
|
|
3626
4972
|
|
|
3627
4973
|
# Set x-goog-api-client and x-goog-user-project headers
|
|
3628
4974
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
@@ -3631,19 +4977,153 @@ module Google
|
|
|
3631
4977
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3632
4978
|
|
|
3633
4979
|
header_params = {
|
|
3634
|
-
"
|
|
4980
|
+
"parent" => request.parent
|
|
3635
4981
|
}
|
|
3636
4982
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3637
4983
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3638
4984
|
|
|
3639
|
-
options.apply_defaults timeout: @config.rpcs.
|
|
4985
|
+
options.apply_defaults timeout: @config.rpcs.list_custom_metrics.timeout,
|
|
3640
4986
|
metadata: metadata,
|
|
3641
|
-
retry_policy: @config.rpcs.
|
|
4987
|
+
retry_policy: @config.rpcs.list_custom_metrics.retry_policy
|
|
3642
4988
|
options.apply_defaults metadata: @config.metadata,
|
|
3643
4989
|
retry_policy: @config.retry_policy
|
|
3644
4990
|
|
|
3645
|
-
@analytics_admin_service_stub.call_rpc :
|
|
3646
|
-
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :
|
|
4991
|
+
@analytics_admin_service_stub.call_rpc :list_custom_metrics, request, options: options do |response, operation|
|
|
4992
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_metrics, request, response, operation, options
|
|
4993
|
+
yield response, operation if block_given?
|
|
4994
|
+
return response
|
|
4995
|
+
end
|
|
4996
|
+
rescue ::GRPC::BadStatus => e
|
|
4997
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4998
|
+
end
|
|
4999
|
+
|
|
5000
|
+
##
|
|
5001
|
+
# Archives a CustomMetric on a property.
|
|
5002
|
+
#
|
|
5003
|
+
# @overload archive_custom_metric(request, options = nil)
|
|
5004
|
+
# Pass arguments to `archive_custom_metric` via a request object, either of type
|
|
5005
|
+
# {::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest} or an equivalent Hash.
|
|
5006
|
+
#
|
|
5007
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest, ::Hash]
|
|
5008
|
+
# A request object representing the call parameters. Required. To specify no
|
|
5009
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
5010
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
5011
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
5012
|
+
#
|
|
5013
|
+
# @overload archive_custom_metric(name: nil)
|
|
5014
|
+
# Pass arguments to `archive_custom_metric` via keyword arguments. Note that at
|
|
5015
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
5016
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
5017
|
+
#
|
|
5018
|
+
# @param name [::String]
|
|
5019
|
+
# Required. The name of the CustomMetric to archive.
|
|
5020
|
+
# Example format: properties/1234/customMetrics/5678
|
|
5021
|
+
#
|
|
5022
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
5023
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
5024
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
5025
|
+
#
|
|
5026
|
+
# @return [::Google::Protobuf::Empty]
|
|
5027
|
+
#
|
|
5028
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
5029
|
+
#
|
|
5030
|
+
def archive_custom_metric request, options = nil
|
|
5031
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
5032
|
+
|
|
5033
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest
|
|
5034
|
+
|
|
5035
|
+
# Converts hash and nil to an options object
|
|
5036
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
5037
|
+
|
|
5038
|
+
# Customize the options with defaults
|
|
5039
|
+
metadata = @config.rpcs.archive_custom_metric.metadata.to_h
|
|
5040
|
+
|
|
5041
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
5042
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
5043
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
5044
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
5045
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
5046
|
+
|
|
5047
|
+
header_params = {
|
|
5048
|
+
"name" => request.name
|
|
5049
|
+
}
|
|
5050
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
5051
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
5052
|
+
|
|
5053
|
+
options.apply_defaults timeout: @config.rpcs.archive_custom_metric.timeout,
|
|
5054
|
+
metadata: metadata,
|
|
5055
|
+
retry_policy: @config.rpcs.archive_custom_metric.retry_policy
|
|
5056
|
+
options.apply_defaults metadata: @config.metadata,
|
|
5057
|
+
retry_policy: @config.retry_policy
|
|
5058
|
+
|
|
5059
|
+
@analytics_admin_service_stub.call_rpc :archive_custom_metric, request, options: options do |response, operation|
|
|
5060
|
+
yield response, operation if block_given?
|
|
5061
|
+
return response
|
|
5062
|
+
end
|
|
5063
|
+
rescue ::GRPC::BadStatus => e
|
|
5064
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
5065
|
+
end
|
|
5066
|
+
|
|
5067
|
+
##
|
|
5068
|
+
# Lookup for a single CustomMetric.
|
|
5069
|
+
#
|
|
5070
|
+
# @overload get_custom_metric(request, options = nil)
|
|
5071
|
+
# Pass arguments to `get_custom_metric` via a request object, either of type
|
|
5072
|
+
# {::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest} or an equivalent Hash.
|
|
5073
|
+
#
|
|
5074
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest, ::Hash]
|
|
5075
|
+
# A request object representing the call parameters. Required. To specify no
|
|
5076
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
5077
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
5078
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
5079
|
+
#
|
|
5080
|
+
# @overload get_custom_metric(name: nil)
|
|
5081
|
+
# Pass arguments to `get_custom_metric` via keyword arguments. Note that at
|
|
5082
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
5083
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
5084
|
+
#
|
|
5085
|
+
# @param name [::String]
|
|
5086
|
+
# Required. The name of the CustomMetric to get.
|
|
5087
|
+
# Example format: properties/1234/customMetrics/5678
|
|
5088
|
+
#
|
|
5089
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
5090
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
5091
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
5092
|
+
#
|
|
5093
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
5094
|
+
#
|
|
5095
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
5096
|
+
#
|
|
5097
|
+
def get_custom_metric request, options = nil
|
|
5098
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
5099
|
+
|
|
5100
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest
|
|
5101
|
+
|
|
5102
|
+
# Converts hash and nil to an options object
|
|
5103
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
5104
|
+
|
|
5105
|
+
# Customize the options with defaults
|
|
5106
|
+
metadata = @config.rpcs.get_custom_metric.metadata.to_h
|
|
5107
|
+
|
|
5108
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
5109
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
5110
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
5111
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
5112
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
5113
|
+
|
|
5114
|
+
header_params = {
|
|
5115
|
+
"name" => request.name
|
|
5116
|
+
}
|
|
5117
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
5118
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
5119
|
+
|
|
5120
|
+
options.apply_defaults timeout: @config.rpcs.get_custom_metric.timeout,
|
|
5121
|
+
metadata: metadata,
|
|
5122
|
+
retry_policy: @config.rpcs.get_custom_metric.retry_policy
|
|
5123
|
+
options.apply_defaults metadata: @config.metadata,
|
|
5124
|
+
retry_policy: @config.retry_policy
|
|
5125
|
+
|
|
5126
|
+
@analytics_admin_service_stub.call_rpc :get_custom_metric, request, options: options do |response, operation|
|
|
3647
5127
|
yield response, operation if block_given?
|
|
3648
5128
|
return response
|
|
3649
5129
|
end
|
|
@@ -4018,10 +5498,115 @@ module Google
|
|
|
4018
5498
|
#
|
|
4019
5499
|
attr_reader :get_data_sharing_settings
|
|
4020
5500
|
##
|
|
5501
|
+
# RPC-specific configuration for `get_measurement_protocol_secret`
|
|
5502
|
+
# @return [::Gapic::Config::Method]
|
|
5503
|
+
#
|
|
5504
|
+
attr_reader :get_measurement_protocol_secret
|
|
5505
|
+
##
|
|
5506
|
+
# RPC-specific configuration for `list_measurement_protocol_secrets`
|
|
5507
|
+
# @return [::Gapic::Config::Method]
|
|
5508
|
+
#
|
|
5509
|
+
attr_reader :list_measurement_protocol_secrets
|
|
5510
|
+
##
|
|
5511
|
+
# RPC-specific configuration for `create_measurement_protocol_secret`
|
|
5512
|
+
# @return [::Gapic::Config::Method]
|
|
5513
|
+
#
|
|
5514
|
+
attr_reader :create_measurement_protocol_secret
|
|
5515
|
+
##
|
|
5516
|
+
# RPC-specific configuration for `delete_measurement_protocol_secret`
|
|
5517
|
+
# @return [::Gapic::Config::Method]
|
|
5518
|
+
#
|
|
5519
|
+
attr_reader :delete_measurement_protocol_secret
|
|
5520
|
+
##
|
|
5521
|
+
# RPC-specific configuration for `update_measurement_protocol_secret`
|
|
5522
|
+
# @return [::Gapic::Config::Method]
|
|
5523
|
+
#
|
|
5524
|
+
attr_reader :update_measurement_protocol_secret
|
|
5525
|
+
##
|
|
4021
5526
|
# RPC-specific configuration for `search_change_history_events`
|
|
4022
5527
|
# @return [::Gapic::Config::Method]
|
|
4023
5528
|
#
|
|
4024
5529
|
attr_reader :search_change_history_events
|
|
5530
|
+
##
|
|
5531
|
+
# RPC-specific configuration for `get_google_signals_settings`
|
|
5532
|
+
# @return [::Gapic::Config::Method]
|
|
5533
|
+
#
|
|
5534
|
+
attr_reader :get_google_signals_settings
|
|
5535
|
+
##
|
|
5536
|
+
# RPC-specific configuration for `update_google_signals_settings`
|
|
5537
|
+
# @return [::Gapic::Config::Method]
|
|
5538
|
+
#
|
|
5539
|
+
attr_reader :update_google_signals_settings
|
|
5540
|
+
##
|
|
5541
|
+
# RPC-specific configuration for `create_conversion_event`
|
|
5542
|
+
# @return [::Gapic::Config::Method]
|
|
5543
|
+
#
|
|
5544
|
+
attr_reader :create_conversion_event
|
|
5545
|
+
##
|
|
5546
|
+
# RPC-specific configuration for `get_conversion_event`
|
|
5547
|
+
# @return [::Gapic::Config::Method]
|
|
5548
|
+
#
|
|
5549
|
+
attr_reader :get_conversion_event
|
|
5550
|
+
##
|
|
5551
|
+
# RPC-specific configuration for `delete_conversion_event`
|
|
5552
|
+
# @return [::Gapic::Config::Method]
|
|
5553
|
+
#
|
|
5554
|
+
attr_reader :delete_conversion_event
|
|
5555
|
+
##
|
|
5556
|
+
# RPC-specific configuration for `list_conversion_events`
|
|
5557
|
+
# @return [::Gapic::Config::Method]
|
|
5558
|
+
#
|
|
5559
|
+
attr_reader :list_conversion_events
|
|
5560
|
+
##
|
|
5561
|
+
# RPC-specific configuration for `create_custom_dimension`
|
|
5562
|
+
# @return [::Gapic::Config::Method]
|
|
5563
|
+
#
|
|
5564
|
+
attr_reader :create_custom_dimension
|
|
5565
|
+
##
|
|
5566
|
+
# RPC-specific configuration for `update_custom_dimension`
|
|
5567
|
+
# @return [::Gapic::Config::Method]
|
|
5568
|
+
#
|
|
5569
|
+
attr_reader :update_custom_dimension
|
|
5570
|
+
##
|
|
5571
|
+
# RPC-specific configuration for `list_custom_dimensions`
|
|
5572
|
+
# @return [::Gapic::Config::Method]
|
|
5573
|
+
#
|
|
5574
|
+
attr_reader :list_custom_dimensions
|
|
5575
|
+
##
|
|
5576
|
+
# RPC-specific configuration for `archive_custom_dimension`
|
|
5577
|
+
# @return [::Gapic::Config::Method]
|
|
5578
|
+
#
|
|
5579
|
+
attr_reader :archive_custom_dimension
|
|
5580
|
+
##
|
|
5581
|
+
# RPC-specific configuration for `get_custom_dimension`
|
|
5582
|
+
# @return [::Gapic::Config::Method]
|
|
5583
|
+
#
|
|
5584
|
+
attr_reader :get_custom_dimension
|
|
5585
|
+
##
|
|
5586
|
+
# RPC-specific configuration for `create_custom_metric`
|
|
5587
|
+
# @return [::Gapic::Config::Method]
|
|
5588
|
+
#
|
|
5589
|
+
attr_reader :create_custom_metric
|
|
5590
|
+
##
|
|
5591
|
+
# RPC-specific configuration for `update_custom_metric`
|
|
5592
|
+
# @return [::Gapic::Config::Method]
|
|
5593
|
+
#
|
|
5594
|
+
attr_reader :update_custom_metric
|
|
5595
|
+
##
|
|
5596
|
+
# RPC-specific configuration for `list_custom_metrics`
|
|
5597
|
+
# @return [::Gapic::Config::Method]
|
|
5598
|
+
#
|
|
5599
|
+
attr_reader :list_custom_metrics
|
|
5600
|
+
##
|
|
5601
|
+
# RPC-specific configuration for `archive_custom_metric`
|
|
5602
|
+
# @return [::Gapic::Config::Method]
|
|
5603
|
+
#
|
|
5604
|
+
attr_reader :archive_custom_metric
|
|
5605
|
+
##
|
|
5606
|
+
# RPC-specific configuration for `get_custom_metric`
|
|
5607
|
+
# @return [::Gapic::Config::Method]
|
|
5608
|
+
#
|
|
5609
|
+
attr_reader :get_custom_metric
|
|
4025
5610
|
|
|
4026
5611
|
# @private
|
|
4027
5612
|
def initialize parent_rpcs = nil
|
|
@@ -4117,8 +5702,50 @@ module Google
|
|
|
4117
5702
|
@list_google_ads_links = ::Gapic::Config::Method.new list_google_ads_links_config
|
|
4118
5703
|
get_data_sharing_settings_config = parent_rpcs.get_data_sharing_settings if parent_rpcs.respond_to? :get_data_sharing_settings
|
|
4119
5704
|
@get_data_sharing_settings = ::Gapic::Config::Method.new get_data_sharing_settings_config
|
|
5705
|
+
get_measurement_protocol_secret_config = parent_rpcs.get_measurement_protocol_secret if parent_rpcs.respond_to? :get_measurement_protocol_secret
|
|
5706
|
+
@get_measurement_protocol_secret = ::Gapic::Config::Method.new get_measurement_protocol_secret_config
|
|
5707
|
+
list_measurement_protocol_secrets_config = parent_rpcs.list_measurement_protocol_secrets if parent_rpcs.respond_to? :list_measurement_protocol_secrets
|
|
5708
|
+
@list_measurement_protocol_secrets = ::Gapic::Config::Method.new list_measurement_protocol_secrets_config
|
|
5709
|
+
create_measurement_protocol_secret_config = parent_rpcs.create_measurement_protocol_secret if parent_rpcs.respond_to? :create_measurement_protocol_secret
|
|
5710
|
+
@create_measurement_protocol_secret = ::Gapic::Config::Method.new create_measurement_protocol_secret_config
|
|
5711
|
+
delete_measurement_protocol_secret_config = parent_rpcs.delete_measurement_protocol_secret if parent_rpcs.respond_to? :delete_measurement_protocol_secret
|
|
5712
|
+
@delete_measurement_protocol_secret = ::Gapic::Config::Method.new delete_measurement_protocol_secret_config
|
|
5713
|
+
update_measurement_protocol_secret_config = parent_rpcs.update_measurement_protocol_secret if parent_rpcs.respond_to? :update_measurement_protocol_secret
|
|
5714
|
+
@update_measurement_protocol_secret = ::Gapic::Config::Method.new update_measurement_protocol_secret_config
|
|
4120
5715
|
search_change_history_events_config = parent_rpcs.search_change_history_events if parent_rpcs.respond_to? :search_change_history_events
|
|
4121
5716
|
@search_change_history_events = ::Gapic::Config::Method.new search_change_history_events_config
|
|
5717
|
+
get_google_signals_settings_config = parent_rpcs.get_google_signals_settings if parent_rpcs.respond_to? :get_google_signals_settings
|
|
5718
|
+
@get_google_signals_settings = ::Gapic::Config::Method.new get_google_signals_settings_config
|
|
5719
|
+
update_google_signals_settings_config = parent_rpcs.update_google_signals_settings if parent_rpcs.respond_to? :update_google_signals_settings
|
|
5720
|
+
@update_google_signals_settings = ::Gapic::Config::Method.new update_google_signals_settings_config
|
|
5721
|
+
create_conversion_event_config = parent_rpcs.create_conversion_event if parent_rpcs.respond_to? :create_conversion_event
|
|
5722
|
+
@create_conversion_event = ::Gapic::Config::Method.new create_conversion_event_config
|
|
5723
|
+
get_conversion_event_config = parent_rpcs.get_conversion_event if parent_rpcs.respond_to? :get_conversion_event
|
|
5724
|
+
@get_conversion_event = ::Gapic::Config::Method.new get_conversion_event_config
|
|
5725
|
+
delete_conversion_event_config = parent_rpcs.delete_conversion_event if parent_rpcs.respond_to? :delete_conversion_event
|
|
5726
|
+
@delete_conversion_event = ::Gapic::Config::Method.new delete_conversion_event_config
|
|
5727
|
+
list_conversion_events_config = parent_rpcs.list_conversion_events if parent_rpcs.respond_to? :list_conversion_events
|
|
5728
|
+
@list_conversion_events = ::Gapic::Config::Method.new list_conversion_events_config
|
|
5729
|
+
create_custom_dimension_config = parent_rpcs.create_custom_dimension if parent_rpcs.respond_to? :create_custom_dimension
|
|
5730
|
+
@create_custom_dimension = ::Gapic::Config::Method.new create_custom_dimension_config
|
|
5731
|
+
update_custom_dimension_config = parent_rpcs.update_custom_dimension if parent_rpcs.respond_to? :update_custom_dimension
|
|
5732
|
+
@update_custom_dimension = ::Gapic::Config::Method.new update_custom_dimension_config
|
|
5733
|
+
list_custom_dimensions_config = parent_rpcs.list_custom_dimensions if parent_rpcs.respond_to? :list_custom_dimensions
|
|
5734
|
+
@list_custom_dimensions = ::Gapic::Config::Method.new list_custom_dimensions_config
|
|
5735
|
+
archive_custom_dimension_config = parent_rpcs.archive_custom_dimension if parent_rpcs.respond_to? :archive_custom_dimension
|
|
5736
|
+
@archive_custom_dimension = ::Gapic::Config::Method.new archive_custom_dimension_config
|
|
5737
|
+
get_custom_dimension_config = parent_rpcs.get_custom_dimension if parent_rpcs.respond_to? :get_custom_dimension
|
|
5738
|
+
@get_custom_dimension = ::Gapic::Config::Method.new get_custom_dimension_config
|
|
5739
|
+
create_custom_metric_config = parent_rpcs.create_custom_metric if parent_rpcs.respond_to? :create_custom_metric
|
|
5740
|
+
@create_custom_metric = ::Gapic::Config::Method.new create_custom_metric_config
|
|
5741
|
+
update_custom_metric_config = parent_rpcs.update_custom_metric if parent_rpcs.respond_to? :update_custom_metric
|
|
5742
|
+
@update_custom_metric = ::Gapic::Config::Method.new update_custom_metric_config
|
|
5743
|
+
list_custom_metrics_config = parent_rpcs.list_custom_metrics if parent_rpcs.respond_to? :list_custom_metrics
|
|
5744
|
+
@list_custom_metrics = ::Gapic::Config::Method.new list_custom_metrics_config
|
|
5745
|
+
archive_custom_metric_config = parent_rpcs.archive_custom_metric if parent_rpcs.respond_to? :archive_custom_metric
|
|
5746
|
+
@archive_custom_metric = ::Gapic::Config::Method.new archive_custom_metric_config
|
|
5747
|
+
get_custom_metric_config = parent_rpcs.get_custom_metric if parent_rpcs.respond_to? :get_custom_metric
|
|
5748
|
+
@get_custom_metric = ::Gapic::Config::Method.new get_custom_metric_config
|
|
4122
5749
|
|
|
4123
5750
|
yield self if block_given?
|
|
4124
5751
|
end
|