google-analytics-admin-v1alpha 0.17.0 → 0.19.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 +92 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1698 -242
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +53 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +1294 -187
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +891 -3
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +31 -0
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +74 -0
- data/lib/google/analytics/admin/v1alpha/event_create_and_edit_pb.rb +59 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +16 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +268 -1
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +15 -10
- data/proto_docs/google/analytics/admin/v1alpha/channel_group.rb +158 -0
- data/proto_docs/google/analytics/admin/v1alpha/event_create_and_edit.rb +167 -0
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +42 -0
- data/proto_docs/google/api/client.rb +58 -1
- metadata +6 -2
@@ -8780,7 +8780,7 @@ module Google
|
|
8780
8780
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
8781
8781
|
#
|
8782
8782
|
# @param name [::String]
|
8783
|
-
# Required. The name of the
|
8783
|
+
# Required. The name of the ExpandedDataSet to get.
|
8784
8784
|
# Example format: properties/1234/expandedDataSets/5678
|
8785
8785
|
#
|
8786
8786
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -9212,38 +9212,32 @@ module Google
|
|
9212
9212
|
end
|
9213
9213
|
|
9214
9214
|
##
|
9215
|
-
#
|
9216
|
-
# property.
|
9217
|
-
# Note: this has no effect on GA4 property.
|
9215
|
+
# Lookup for a single ChannelGroup.
|
9218
9216
|
#
|
9219
|
-
# @overload
|
9220
|
-
# Pass arguments to `
|
9221
|
-
# {::Google::Analytics::Admin::V1alpha::
|
9217
|
+
# @overload get_channel_group(request, options = nil)
|
9218
|
+
# Pass arguments to `get_channel_group` via a request object, either of type
|
9219
|
+
# {::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest} or an equivalent Hash.
|
9222
9220
|
#
|
9223
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9221
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest, ::Hash]
|
9224
9222
|
# A request object representing the call parameters. Required. To specify no
|
9225
9223
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9226
9224
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9227
9225
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9228
9226
|
#
|
9229
|
-
# @overload
|
9230
|
-
# Pass arguments to `
|
9227
|
+
# @overload get_channel_group(name: nil)
|
9228
|
+
# Pass arguments to `get_channel_group` via keyword arguments. Note that at
|
9231
9229
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9232
9230
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9233
9231
|
#
|
9234
|
-
# @param
|
9235
|
-
# Required. The
|
9236
|
-
#
|
9237
|
-
# Format: properties/\\{internalWebPropertyId}
|
9238
|
-
# Example: properties/1234
|
9239
|
-
# @param opt_out [::Boolean]
|
9240
|
-
# The status to set.
|
9232
|
+
# @param name [::String]
|
9233
|
+
# Required. The ChannelGroup to get.
|
9234
|
+
# Example format: properties/1234/channelGroups/5678
|
9241
9235
|
#
|
9242
9236
|
# @yield [response, operation] Access the result along with the RPC operation
|
9243
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
9237
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9244
9238
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9245
9239
|
#
|
9246
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
9240
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9247
9241
|
#
|
9248
9242
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9249
9243
|
#
|
@@ -9254,24 +9248,24 @@ module Google
|
|
9254
9248
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9255
9249
|
#
|
9256
9250
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9257
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9251
|
+
# request = Google::Analytics::Admin::V1alpha::GetChannelGroupRequest.new
|
9258
9252
|
#
|
9259
|
-
# # Call the
|
9260
|
-
# result = client.
|
9253
|
+
# # Call the get_channel_group method.
|
9254
|
+
# result = client.get_channel_group request
|
9261
9255
|
#
|
9262
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
9256
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9263
9257
|
# p result
|
9264
9258
|
#
|
9265
|
-
def
|
9259
|
+
def get_channel_group request, options = nil
|
9266
9260
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9267
9261
|
|
9268
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9262
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest
|
9269
9263
|
|
9270
9264
|
# Converts hash and nil to an options object
|
9271
9265
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9272
9266
|
|
9273
9267
|
# Customize the options with defaults
|
9274
|
-
metadata = @config.rpcs.
|
9268
|
+
metadata = @config.rpcs.get_channel_group.metadata.to_h
|
9275
9269
|
|
9276
9270
|
# Set x-goog-api-client and x-goog-user-project headers
|
9277
9271
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9279,15 +9273,23 @@ module Google
|
|
9279
9273
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9280
9274
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9281
9275
|
|
9282
|
-
|
9276
|
+
header_params = {}
|
9277
|
+
if request.name
|
9278
|
+
header_params["name"] = request.name
|
9279
|
+
end
|
9280
|
+
|
9281
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9282
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
9283
|
+
|
9284
|
+
options.apply_defaults timeout: @config.rpcs.get_channel_group.timeout,
|
9283
9285
|
metadata: metadata,
|
9284
|
-
retry_policy: @config.rpcs.
|
9286
|
+
retry_policy: @config.rpcs.get_channel_group.retry_policy
|
9285
9287
|
|
9286
9288
|
options.apply_defaults timeout: @config.timeout,
|
9287
9289
|
metadata: @config.metadata,
|
9288
9290
|
retry_policy: @config.retry_policy
|
9289
9291
|
|
9290
|
-
@analytics_admin_service_stub.call_rpc :
|
9292
|
+
@analytics_admin_service_stub.call_rpc :get_channel_group, request, options: options do |response, operation|
|
9291
9293
|
yield response, operation if block_given?
|
9292
9294
|
return response
|
9293
9295
|
end
|
@@ -9296,36 +9298,42 @@ module Google
|
|
9296
9298
|
end
|
9297
9299
|
|
9298
9300
|
##
|
9299
|
-
#
|
9300
|
-
# property.
|
9301
|
-
# Note: this has no effect on GA4 property.
|
9301
|
+
# Lists ChannelGroups on a property.
|
9302
9302
|
#
|
9303
|
-
# @overload
|
9304
|
-
# Pass arguments to `
|
9305
|
-
# {::Google::Analytics::Admin::V1alpha::
|
9303
|
+
# @overload list_channel_groups(request, options = nil)
|
9304
|
+
# Pass arguments to `list_channel_groups` via a request object, either of type
|
9305
|
+
# {::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest} or an equivalent Hash.
|
9306
9306
|
#
|
9307
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9307
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest, ::Hash]
|
9308
9308
|
# A request object representing the call parameters. Required. To specify no
|
9309
9309
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9310
9310
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9311
9311
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9312
9312
|
#
|
9313
|
-
# @overload
|
9314
|
-
# Pass arguments to `
|
9313
|
+
# @overload list_channel_groups(parent: nil, page_size: nil, page_token: nil)
|
9314
|
+
# Pass arguments to `list_channel_groups` via keyword arguments. Note that at
|
9315
9315
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9316
9316
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9317
9317
|
#
|
9318
|
-
# @param
|
9319
|
-
# Required. The
|
9320
|
-
#
|
9321
|
-
#
|
9322
|
-
#
|
9318
|
+
# @param parent [::String]
|
9319
|
+
# Required. The property for which to list ChannelGroups.
|
9320
|
+
# Example format: properties/1234
|
9321
|
+
# @param page_size [::Integer]
|
9322
|
+
# The maximum number of resources to return.
|
9323
|
+
# If unspecified, at most 50 resources will be returned.
|
9324
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
9325
|
+
# @param page_token [::String]
|
9326
|
+
# A page token, received from a previous `ListChannelGroups` call. Provide
|
9327
|
+
# this to retrieve the subsequent page.
|
9328
|
+
#
|
9329
|
+
# When paginating, all other parameters provided to `ListChannelGroups`
|
9330
|
+
# must match the call that provided the page token.
|
9323
9331
|
#
|
9324
9332
|
# @yield [response, operation] Access the result along with the RPC operation
|
9325
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
9333
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
9326
9334
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9327
9335
|
#
|
9328
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
9336
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
9329
9337
|
#
|
9330
9338
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9331
9339
|
#
|
@@ -9336,24 +9344,117 @@ module Google
|
|
9336
9344
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9337
9345
|
#
|
9338
9346
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9339
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9347
|
+
# request = Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest.new
|
9340
9348
|
#
|
9341
|
-
# # Call the
|
9342
|
-
# result = client.
|
9349
|
+
# # Call the list_channel_groups method.
|
9350
|
+
# result = client.list_channel_groups request
|
9343
9351
|
#
|
9344
|
-
# # The returned object is of type
|
9352
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
9353
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
9354
|
+
# result.each do |item|
|
9355
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9356
|
+
# p item
|
9357
|
+
# end
|
9358
|
+
#
|
9359
|
+
def list_channel_groups request, options = nil
|
9360
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9361
|
+
|
9362
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest
|
9363
|
+
|
9364
|
+
# Converts hash and nil to an options object
|
9365
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9366
|
+
|
9367
|
+
# Customize the options with defaults
|
9368
|
+
metadata = @config.rpcs.list_channel_groups.metadata.to_h
|
9369
|
+
|
9370
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9371
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9372
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9373
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9374
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9375
|
+
|
9376
|
+
header_params = {}
|
9377
|
+
if request.parent
|
9378
|
+
header_params["parent"] = request.parent
|
9379
|
+
end
|
9380
|
+
|
9381
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9382
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
9383
|
+
|
9384
|
+
options.apply_defaults timeout: @config.rpcs.list_channel_groups.timeout,
|
9385
|
+
metadata: metadata,
|
9386
|
+
retry_policy: @config.rpcs.list_channel_groups.retry_policy
|
9387
|
+
|
9388
|
+
options.apply_defaults timeout: @config.timeout,
|
9389
|
+
metadata: @config.metadata,
|
9390
|
+
retry_policy: @config.retry_policy
|
9391
|
+
|
9392
|
+
@analytics_admin_service_stub.call_rpc :list_channel_groups, request, options: options do |response, operation|
|
9393
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_channel_groups, request, response, operation, options
|
9394
|
+
yield response, operation if block_given?
|
9395
|
+
return response
|
9396
|
+
end
|
9397
|
+
rescue ::GRPC::BadStatus => e
|
9398
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9399
|
+
end
|
9400
|
+
|
9401
|
+
##
|
9402
|
+
# Creates a ChannelGroup.
|
9403
|
+
#
|
9404
|
+
# @overload create_channel_group(request, options = nil)
|
9405
|
+
# Pass arguments to `create_channel_group` via a request object, either of type
|
9406
|
+
# {::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest} or an equivalent Hash.
|
9407
|
+
#
|
9408
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest, ::Hash]
|
9409
|
+
# A request object representing the call parameters. Required. To specify no
|
9410
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9411
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9412
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9413
|
+
#
|
9414
|
+
# @overload create_channel_group(parent: nil, channel_group: nil)
|
9415
|
+
# Pass arguments to `create_channel_group` via keyword arguments. Note that at
|
9416
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9417
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9418
|
+
#
|
9419
|
+
# @param parent [::String]
|
9420
|
+
# Required. The property for which to create a ChannelGroup.
|
9421
|
+
# Example format: properties/1234
|
9422
|
+
# @param channel_group [::Google::Analytics::Admin::V1alpha::ChannelGroup, ::Hash]
|
9423
|
+
# Required. The ChannelGroup to create.
|
9424
|
+
#
|
9425
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9426
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9427
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9428
|
+
#
|
9429
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9430
|
+
#
|
9431
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9432
|
+
#
|
9433
|
+
# @example Basic example
|
9434
|
+
# require "google/analytics/admin/v1alpha"
|
9435
|
+
#
|
9436
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9437
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9438
|
+
#
|
9439
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9440
|
+
# request = Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest.new
|
9441
|
+
#
|
9442
|
+
# # Call the create_channel_group method.
|
9443
|
+
# result = client.create_channel_group request
|
9444
|
+
#
|
9445
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9345
9446
|
# p result
|
9346
9447
|
#
|
9347
|
-
def
|
9448
|
+
def create_channel_group request, options = nil
|
9348
9449
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9349
9450
|
|
9350
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9451
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest
|
9351
9452
|
|
9352
9453
|
# Converts hash and nil to an options object
|
9353
9454
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9354
9455
|
|
9355
9456
|
# Customize the options with defaults
|
9356
|
-
metadata = @config.rpcs.
|
9457
|
+
metadata = @config.rpcs.create_channel_group.metadata.to_h
|
9357
9458
|
|
9358
9459
|
# Set x-goog-api-client and x-goog-user-project headers
|
9359
9460
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9361,15 +9462,23 @@ module Google
|
|
9361
9462
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9362
9463
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9363
9464
|
|
9364
|
-
|
9465
|
+
header_params = {}
|
9466
|
+
if request.parent
|
9467
|
+
header_params["parent"] = request.parent
|
9468
|
+
end
|
9469
|
+
|
9470
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9471
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
9472
|
+
|
9473
|
+
options.apply_defaults timeout: @config.rpcs.create_channel_group.timeout,
|
9365
9474
|
metadata: metadata,
|
9366
|
-
retry_policy: @config.rpcs.
|
9475
|
+
retry_policy: @config.rpcs.create_channel_group.retry_policy
|
9367
9476
|
|
9368
9477
|
options.apply_defaults timeout: @config.timeout,
|
9369
9478
|
metadata: @config.metadata,
|
9370
9479
|
retry_policy: @config.retry_policy
|
9371
9480
|
|
9372
|
-
@analytics_admin_service_stub.call_rpc :
|
9481
|
+
@analytics_admin_service_stub.call_rpc :create_channel_group, request, options: options do |response, operation|
|
9373
9482
|
yield response, operation if block_given?
|
9374
9483
|
return response
|
9375
9484
|
end
|
@@ -9378,33 +9487,124 @@ module Google
|
|
9378
9487
|
end
|
9379
9488
|
|
9380
9489
|
##
|
9381
|
-
#
|
9490
|
+
# Updates a ChannelGroup.
|
9382
9491
|
#
|
9383
|
-
# @overload
|
9384
|
-
# Pass arguments to `
|
9385
|
-
# {::Google::Analytics::Admin::V1alpha::
|
9492
|
+
# @overload update_channel_group(request, options = nil)
|
9493
|
+
# Pass arguments to `update_channel_group` via a request object, either of type
|
9494
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest} or an equivalent Hash.
|
9386
9495
|
#
|
9387
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9496
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest, ::Hash]
|
9388
9497
|
# A request object representing the call parameters. Required. To specify no
|
9389
9498
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9390
9499
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9391
9500
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9392
9501
|
#
|
9393
|
-
# @overload
|
9394
|
-
# Pass arguments to `
|
9502
|
+
# @overload update_channel_group(channel_group: nil, update_mask: nil)
|
9503
|
+
# Pass arguments to `update_channel_group` via keyword arguments. Note that at
|
9504
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9505
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9506
|
+
#
|
9507
|
+
# @param channel_group [::Google::Analytics::Admin::V1alpha::ChannelGroup, ::Hash]
|
9508
|
+
# Required. The ChannelGroup to update.
|
9509
|
+
# The resource's `name` field is used to identify the ChannelGroup to be
|
9510
|
+
# updated.
|
9511
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
9512
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
9513
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
9514
|
+
# replace the entire entity, use one path with the string "*" to match all
|
9515
|
+
# fields.
|
9516
|
+
#
|
9517
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9518
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9519
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9520
|
+
#
|
9521
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9522
|
+
#
|
9523
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9524
|
+
#
|
9525
|
+
# @example Basic example
|
9526
|
+
# require "google/analytics/admin/v1alpha"
|
9527
|
+
#
|
9528
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9529
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9530
|
+
#
|
9531
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9532
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest.new
|
9533
|
+
#
|
9534
|
+
# # Call the update_channel_group method.
|
9535
|
+
# result = client.update_channel_group request
|
9536
|
+
#
|
9537
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9538
|
+
# p result
|
9539
|
+
#
|
9540
|
+
def update_channel_group request, options = nil
|
9541
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9542
|
+
|
9543
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest
|
9544
|
+
|
9545
|
+
# Converts hash and nil to an options object
|
9546
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9547
|
+
|
9548
|
+
# Customize the options with defaults
|
9549
|
+
metadata = @config.rpcs.update_channel_group.metadata.to_h
|
9550
|
+
|
9551
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9552
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9553
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9554
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9555
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9556
|
+
|
9557
|
+
header_params = {}
|
9558
|
+
if request.channel_group&.name
|
9559
|
+
header_params["channel_group.name"] = request.channel_group.name
|
9560
|
+
end
|
9561
|
+
|
9562
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9563
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
9564
|
+
|
9565
|
+
options.apply_defaults timeout: @config.rpcs.update_channel_group.timeout,
|
9566
|
+
metadata: metadata,
|
9567
|
+
retry_policy: @config.rpcs.update_channel_group.retry_policy
|
9568
|
+
|
9569
|
+
options.apply_defaults timeout: @config.timeout,
|
9570
|
+
metadata: @config.metadata,
|
9571
|
+
retry_policy: @config.retry_policy
|
9572
|
+
|
9573
|
+
@analytics_admin_service_stub.call_rpc :update_channel_group, request, options: options do |response, operation|
|
9574
|
+
yield response, operation if block_given?
|
9575
|
+
return response
|
9576
|
+
end
|
9577
|
+
rescue ::GRPC::BadStatus => e
|
9578
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9579
|
+
end
|
9580
|
+
|
9581
|
+
##
|
9582
|
+
# Deletes a ChannelGroup on a property.
|
9583
|
+
#
|
9584
|
+
# @overload delete_channel_group(request, options = nil)
|
9585
|
+
# Pass arguments to `delete_channel_group` via a request object, either of type
|
9586
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest} or an equivalent Hash.
|
9587
|
+
#
|
9588
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest, ::Hash]
|
9589
|
+
# A request object representing the call parameters. Required. To specify no
|
9590
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9591
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9592
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9593
|
+
#
|
9594
|
+
# @overload delete_channel_group(name: nil)
|
9595
|
+
# Pass arguments to `delete_channel_group` via keyword arguments. Note that at
|
9395
9596
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9396
9597
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9397
9598
|
#
|
9398
9599
|
# @param name [::String]
|
9399
|
-
# Required. The
|
9400
|
-
#
|
9401
|
-
# Example: properties/123/bigQueryLinks/456
|
9600
|
+
# Required. The ChannelGroup to delete.
|
9601
|
+
# Example format: properties/1234/channelGroups/5678
|
9402
9602
|
#
|
9403
9603
|
# @yield [response, operation] Access the result along with the RPC operation
|
9404
|
-
# @yieldparam response [::Google::
|
9604
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
9405
9605
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9406
9606
|
#
|
9407
|
-
# @return [::Google::
|
9607
|
+
# @return [::Google::Protobuf::Empty]
|
9408
9608
|
#
|
9409
9609
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9410
9610
|
#
|
@@ -9415,24 +9615,24 @@ module Google
|
|
9415
9615
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9416
9616
|
#
|
9417
9617
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9418
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9618
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest.new
|
9419
9619
|
#
|
9420
|
-
# # Call the
|
9421
|
-
# result = client.
|
9620
|
+
# # Call the delete_channel_group method.
|
9621
|
+
# result = client.delete_channel_group request
|
9422
9622
|
#
|
9423
|
-
# # The returned object is of type Google::
|
9623
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
9424
9624
|
# p result
|
9425
9625
|
#
|
9426
|
-
def
|
9626
|
+
def delete_channel_group request, options = nil
|
9427
9627
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9428
9628
|
|
9429
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9629
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest
|
9430
9630
|
|
9431
9631
|
# Converts hash and nil to an options object
|
9432
9632
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9433
9633
|
|
9434
9634
|
# Customize the options with defaults
|
9435
|
-
metadata = @config.rpcs.
|
9635
|
+
metadata = @config.rpcs.delete_channel_group.metadata.to_h
|
9436
9636
|
|
9437
9637
|
# Set x-goog-api-client and x-goog-user-project headers
|
9438
9638
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9448,15 +9648,15 @@ module Google
|
|
9448
9648
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9449
9649
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
9450
9650
|
|
9451
|
-
options.apply_defaults timeout: @config.rpcs.
|
9651
|
+
options.apply_defaults timeout: @config.rpcs.delete_channel_group.timeout,
|
9452
9652
|
metadata: metadata,
|
9453
|
-
retry_policy: @config.rpcs.
|
9653
|
+
retry_policy: @config.rpcs.delete_channel_group.retry_policy
|
9454
9654
|
|
9455
9655
|
options.apply_defaults timeout: @config.timeout,
|
9456
9656
|
metadata: @config.metadata,
|
9457
9657
|
retry_policy: @config.retry_policy
|
9458
9658
|
|
9459
|
-
@analytics_admin_service_stub.call_rpc :
|
9659
|
+
@analytics_admin_service_stub.call_rpc :delete_channel_group, request, options: options do |response, operation|
|
9460
9660
|
yield response, operation if block_given?
|
9461
9661
|
return response
|
9462
9662
|
end
|
@@ -9465,43 +9665,1176 @@ module Google
|
|
9465
9665
|
end
|
9466
9666
|
|
9467
9667
|
##
|
9468
|
-
#
|
9668
|
+
# Sets the opt out status for the automated GA4 setup process for a UA
|
9669
|
+
# property.
|
9670
|
+
# Note: this has no effect on GA4 property.
|
9469
9671
|
#
|
9470
|
-
# @overload
|
9471
|
-
# Pass arguments to `
|
9472
|
-
# {::Google::Analytics::Admin::V1alpha::
|
9672
|
+
# @overload set_automated_ga4_configuration_opt_out(request, options = nil)
|
9673
|
+
# Pass arguments to `set_automated_ga4_configuration_opt_out` via a request object, either of type
|
9674
|
+
# {::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
|
9473
9675
|
#
|
9474
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9676
|
+
# @param request [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Hash]
|
9475
9677
|
# A request object representing the call parameters. Required. To specify no
|
9476
9678
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9477
9679
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9478
9680
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9479
9681
|
#
|
9480
|
-
# @overload
|
9682
|
+
# @overload set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil)
|
9683
|
+
# Pass arguments to `set_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
|
9684
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9685
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9686
|
+
#
|
9687
|
+
# @param property [::String]
|
9688
|
+
# Required. The UA property to set the opt out status. Note this request uses
|
9689
|
+
# the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
9690
|
+
# Format: properties/\\{internalWebPropertyId}
|
9691
|
+
# Example: properties/1234
|
9692
|
+
# @param opt_out [::Boolean]
|
9693
|
+
# The status to set.
|
9694
|
+
#
|
9695
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9696
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
|
9697
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9698
|
+
#
|
9699
|
+
# @return [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
|
9700
|
+
#
|
9701
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9702
|
+
#
|
9703
|
+
# @example Basic example
|
9704
|
+
# require "google/analytics/admin/v1alpha"
|
9705
|
+
#
|
9706
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9707
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9708
|
+
#
|
9709
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9710
|
+
# request = Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest.new
|
9711
|
+
#
|
9712
|
+
# # Call the set_automated_ga4_configuration_opt_out method.
|
9713
|
+
# result = client.set_automated_ga4_configuration_opt_out request
|
9714
|
+
#
|
9715
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse.
|
9716
|
+
# p result
|
9717
|
+
#
|
9718
|
+
def set_automated_ga4_configuration_opt_out request, options = nil
|
9719
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9720
|
+
|
9721
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest
|
9722
|
+
|
9723
|
+
# Converts hash and nil to an options object
|
9724
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9725
|
+
|
9726
|
+
# Customize the options with defaults
|
9727
|
+
metadata = @config.rpcs.set_automated_ga4_configuration_opt_out.metadata.to_h
|
9728
|
+
|
9729
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9730
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9731
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9732
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9733
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9734
|
+
|
9735
|
+
options.apply_defaults timeout: @config.rpcs.set_automated_ga4_configuration_opt_out.timeout,
|
9736
|
+
metadata: metadata,
|
9737
|
+
retry_policy: @config.rpcs.set_automated_ga4_configuration_opt_out.retry_policy
|
9738
|
+
|
9739
|
+
options.apply_defaults timeout: @config.timeout,
|
9740
|
+
metadata: @config.metadata,
|
9741
|
+
retry_policy: @config.retry_policy
|
9742
|
+
|
9743
|
+
@analytics_admin_service_stub.call_rpc :set_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
|
9744
|
+
yield response, operation if block_given?
|
9745
|
+
return response
|
9746
|
+
end
|
9747
|
+
rescue ::GRPC::BadStatus => e
|
9748
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9749
|
+
end
|
9750
|
+
|
9751
|
+
##
|
9752
|
+
# Fetches the opt out status for the automated GA4 setup process for a UA
|
9753
|
+
# property.
|
9754
|
+
# Note: this has no effect on GA4 property.
|
9755
|
+
#
|
9756
|
+
# @overload fetch_automated_ga4_configuration_opt_out(request, options = nil)
|
9757
|
+
# Pass arguments to `fetch_automated_ga4_configuration_opt_out` via a request object, either of type
|
9758
|
+
# {::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
|
9759
|
+
#
|
9760
|
+
# @param request [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::Hash]
|
9761
|
+
# A request object representing the call parameters. Required. To specify no
|
9762
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9763
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9764
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9765
|
+
#
|
9766
|
+
# @overload fetch_automated_ga4_configuration_opt_out(property: nil)
|
9767
|
+
# Pass arguments to `fetch_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
|
9768
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9769
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9770
|
+
#
|
9771
|
+
# @param property [::String]
|
9772
|
+
# Required. The UA property to get the opt out status. Note this request uses
|
9773
|
+
# the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
9774
|
+
# Format: properties/\\{internalWebPropertyId}
|
9775
|
+
# Example: properties/1234
|
9776
|
+
#
|
9777
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9778
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
|
9779
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9780
|
+
#
|
9781
|
+
# @return [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
|
9782
|
+
#
|
9783
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9784
|
+
#
|
9785
|
+
# @example Basic example
|
9786
|
+
# require "google/analytics/admin/v1alpha"
|
9787
|
+
#
|
9788
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9789
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9790
|
+
#
|
9791
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9792
|
+
# request = Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest.new
|
9793
|
+
#
|
9794
|
+
# # Call the fetch_automated_ga4_configuration_opt_out method.
|
9795
|
+
# result = client.fetch_automated_ga4_configuration_opt_out request
|
9796
|
+
#
|
9797
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse.
|
9798
|
+
# p result
|
9799
|
+
#
|
9800
|
+
def fetch_automated_ga4_configuration_opt_out request, options = nil
|
9801
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9802
|
+
|
9803
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest
|
9804
|
+
|
9805
|
+
# Converts hash and nil to an options object
|
9806
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9807
|
+
|
9808
|
+
# Customize the options with defaults
|
9809
|
+
metadata = @config.rpcs.fetch_automated_ga4_configuration_opt_out.metadata.to_h
|
9810
|
+
|
9811
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9812
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9813
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9814
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9815
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9816
|
+
|
9817
|
+
options.apply_defaults timeout: @config.rpcs.fetch_automated_ga4_configuration_opt_out.timeout,
|
9818
|
+
metadata: metadata,
|
9819
|
+
retry_policy: @config.rpcs.fetch_automated_ga4_configuration_opt_out.retry_policy
|
9820
|
+
|
9821
|
+
options.apply_defaults timeout: @config.timeout,
|
9822
|
+
metadata: @config.metadata,
|
9823
|
+
retry_policy: @config.retry_policy
|
9824
|
+
|
9825
|
+
@analytics_admin_service_stub.call_rpc :fetch_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
|
9826
|
+
yield response, operation if block_given?
|
9827
|
+
return response
|
9828
|
+
end
|
9829
|
+
rescue ::GRPC::BadStatus => e
|
9830
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9831
|
+
end
|
9832
|
+
|
9833
|
+
##
|
9834
|
+
# Lookup for a single BigQuery Link.
|
9835
|
+
#
|
9836
|
+
# @overload get_big_query_link(request, options = nil)
|
9837
|
+
# Pass arguments to `get_big_query_link` via a request object, either of type
|
9838
|
+
# {::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest} or an equivalent Hash.
|
9839
|
+
#
|
9840
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::Hash]
|
9841
|
+
# A request object representing the call parameters. Required. To specify no
|
9842
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9843
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9844
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9845
|
+
#
|
9846
|
+
# @overload get_big_query_link(name: nil)
|
9847
|
+
# Pass arguments to `get_big_query_link` via keyword arguments. Note that at
|
9848
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9849
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9850
|
+
#
|
9851
|
+
# @param name [::String]
|
9852
|
+
# Required. The name of the BigQuery link to lookup.
|
9853
|
+
# Format: properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}
|
9854
|
+
# Example: properties/123/bigQueryLinks/456
|
9855
|
+
#
|
9856
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9857
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
9858
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9859
|
+
#
|
9860
|
+
# @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
9861
|
+
#
|
9862
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9863
|
+
#
|
9864
|
+
# @example Basic example
|
9865
|
+
# require "google/analytics/admin/v1alpha"
|
9866
|
+
#
|
9867
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9868
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9869
|
+
#
|
9870
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9871
|
+
# request = Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest.new
|
9872
|
+
#
|
9873
|
+
# # Call the get_big_query_link method.
|
9874
|
+
# result = client.get_big_query_link request
|
9875
|
+
#
|
9876
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::BigQueryLink.
|
9877
|
+
# p result
|
9878
|
+
#
|
9879
|
+
def get_big_query_link request, options = nil
|
9880
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9881
|
+
|
9882
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest
|
9883
|
+
|
9884
|
+
# Converts hash and nil to an options object
|
9885
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9886
|
+
|
9887
|
+
# Customize the options with defaults
|
9888
|
+
metadata = @config.rpcs.get_big_query_link.metadata.to_h
|
9889
|
+
|
9890
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9891
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9892
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9893
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9894
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9895
|
+
|
9896
|
+
header_params = {}
|
9897
|
+
if request.name
|
9898
|
+
header_params["name"] = request.name
|
9899
|
+
end
|
9900
|
+
|
9901
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9902
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
9903
|
+
|
9904
|
+
options.apply_defaults timeout: @config.rpcs.get_big_query_link.timeout,
|
9905
|
+
metadata: metadata,
|
9906
|
+
retry_policy: @config.rpcs.get_big_query_link.retry_policy
|
9907
|
+
|
9908
|
+
options.apply_defaults timeout: @config.timeout,
|
9909
|
+
metadata: @config.metadata,
|
9910
|
+
retry_policy: @config.retry_policy
|
9911
|
+
|
9912
|
+
@analytics_admin_service_stub.call_rpc :get_big_query_link, request, options: options do |response, operation|
|
9913
|
+
yield response, operation if block_given?
|
9914
|
+
return response
|
9915
|
+
end
|
9916
|
+
rescue ::GRPC::BadStatus => e
|
9917
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9918
|
+
end
|
9919
|
+
|
9920
|
+
##
|
9921
|
+
# Lists BigQuery Links on a property.
|
9922
|
+
#
|
9923
|
+
# @overload list_big_query_links(request, options = nil)
|
9924
|
+
# Pass arguments to `list_big_query_links` via a request object, either of type
|
9925
|
+
# {::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest} or an equivalent Hash.
|
9926
|
+
#
|
9927
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::Hash]
|
9928
|
+
# A request object representing the call parameters. Required. To specify no
|
9929
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9930
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9931
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9932
|
+
#
|
9933
|
+
# @overload list_big_query_links(parent: nil, page_size: nil, page_token: nil)
|
9481
9934
|
# Pass arguments to `list_big_query_links` via keyword arguments. Note that at
|
9482
9935
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9483
9936
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9484
9937
|
#
|
9485
9938
|
# @param parent [::String]
|
9486
|
-
# Required. The name of the property to list BigQuery links under.
|
9487
|
-
# Format: properties/\\{property_id}
|
9939
|
+
# Required. The name of the property to list BigQuery links under.
|
9940
|
+
# Format: properties/\\{property_id}
|
9941
|
+
# Example: properties/1234
|
9942
|
+
# @param page_size [::Integer]
|
9943
|
+
# The maximum number of resources to return. The service may return
|
9944
|
+
# fewer than this value, even if there are additional pages.
|
9945
|
+
# If unspecified, at most 50 resources will be returned.
|
9946
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
9947
|
+
# @param page_token [::String]
|
9948
|
+
# A page token, received from a previous `ListBigQueryLinks` call.
|
9949
|
+
# Provide this to retrieve the subsequent page.
|
9950
|
+
# When paginating, all other parameters provided to `ListBigQueryLinks` must
|
9951
|
+
# match the call that provided the page token.
|
9952
|
+
#
|
9953
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9954
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
|
9955
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9956
|
+
#
|
9957
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
|
9958
|
+
#
|
9959
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9960
|
+
#
|
9961
|
+
# @example Basic example
|
9962
|
+
# require "google/analytics/admin/v1alpha"
|
9963
|
+
#
|
9964
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9965
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9966
|
+
#
|
9967
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9968
|
+
# request = Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest.new
|
9969
|
+
#
|
9970
|
+
# # Call the list_big_query_links method.
|
9971
|
+
# result = client.list_big_query_links request
|
9972
|
+
#
|
9973
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
9974
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
9975
|
+
# result.each do |item|
|
9976
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::BigQueryLink.
|
9977
|
+
# p item
|
9978
|
+
# end
|
9979
|
+
#
|
9980
|
+
def list_big_query_links request, options = nil
|
9981
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9982
|
+
|
9983
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest
|
9984
|
+
|
9985
|
+
# Converts hash and nil to an options object
|
9986
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9987
|
+
|
9988
|
+
# Customize the options with defaults
|
9989
|
+
metadata = @config.rpcs.list_big_query_links.metadata.to_h
|
9990
|
+
|
9991
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9992
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9993
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9994
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9995
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9996
|
+
|
9997
|
+
header_params = {}
|
9998
|
+
if request.parent
|
9999
|
+
header_params["parent"] = request.parent
|
10000
|
+
end
|
10001
|
+
|
10002
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
10003
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
10004
|
+
|
10005
|
+
options.apply_defaults timeout: @config.rpcs.list_big_query_links.timeout,
|
10006
|
+
metadata: metadata,
|
10007
|
+
retry_policy: @config.rpcs.list_big_query_links.retry_policy
|
10008
|
+
|
10009
|
+
options.apply_defaults timeout: @config.timeout,
|
10010
|
+
metadata: @config.metadata,
|
10011
|
+
retry_policy: @config.retry_policy
|
10012
|
+
|
10013
|
+
@analytics_admin_service_stub.call_rpc :list_big_query_links, request, options: options do |response, operation|
|
10014
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_big_query_links, request, response, operation, options
|
10015
|
+
yield response, operation if block_given?
|
10016
|
+
return response
|
10017
|
+
end
|
10018
|
+
rescue ::GRPC::BadStatus => e
|
10019
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10020
|
+
end
|
10021
|
+
|
10022
|
+
##
|
10023
|
+
# Returns the enhanced measurement settings for this data stream.
|
10024
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
10025
|
+
# take effect.
|
10026
|
+
#
|
10027
|
+
# @overload get_enhanced_measurement_settings(request, options = nil)
|
10028
|
+
# Pass arguments to `get_enhanced_measurement_settings` via a request object, either of type
|
10029
|
+
# {::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest} or an equivalent Hash.
|
10030
|
+
#
|
10031
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Hash]
|
10032
|
+
# A request object representing the call parameters. Required. To specify no
|
10033
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10034
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10035
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10036
|
+
#
|
10037
|
+
# @overload get_enhanced_measurement_settings(name: nil)
|
10038
|
+
# Pass arguments to `get_enhanced_measurement_settings` via keyword arguments. Note that at
|
10039
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10040
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10041
|
+
#
|
10042
|
+
# @param name [::String]
|
10043
|
+
# Required. The name of the settings to lookup.
|
10044
|
+
# Format:
|
10045
|
+
# properties/\\{property}/dataStreams/\\{data_stream}/enhancedMeasurementSettings
|
10046
|
+
# Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
10047
|
+
#
|
10048
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10049
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
10050
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10051
|
+
#
|
10052
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
10053
|
+
#
|
10054
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10055
|
+
#
|
10056
|
+
# @example Basic example
|
10057
|
+
# require "google/analytics/admin/v1alpha"
|
10058
|
+
#
|
10059
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10060
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10061
|
+
#
|
10062
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10063
|
+
# request = Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest.new
|
10064
|
+
#
|
10065
|
+
# # Call the get_enhanced_measurement_settings method.
|
10066
|
+
# result = client.get_enhanced_measurement_settings request
|
10067
|
+
#
|
10068
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.
|
10069
|
+
# p result
|
10070
|
+
#
|
10071
|
+
def get_enhanced_measurement_settings request, options = nil
|
10072
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10073
|
+
|
10074
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest
|
10075
|
+
|
10076
|
+
# Converts hash and nil to an options object
|
10077
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10078
|
+
|
10079
|
+
# Customize the options with defaults
|
10080
|
+
metadata = @config.rpcs.get_enhanced_measurement_settings.metadata.to_h
|
10081
|
+
|
10082
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10083
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10084
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10085
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10086
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10087
|
+
|
10088
|
+
header_params = {}
|
10089
|
+
if request.name
|
10090
|
+
header_params["name"] = request.name
|
10091
|
+
end
|
10092
|
+
|
10093
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
10094
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
10095
|
+
|
10096
|
+
options.apply_defaults timeout: @config.rpcs.get_enhanced_measurement_settings.timeout,
|
10097
|
+
metadata: metadata,
|
10098
|
+
retry_policy: @config.rpcs.get_enhanced_measurement_settings.retry_policy
|
10099
|
+
|
10100
|
+
options.apply_defaults timeout: @config.timeout,
|
10101
|
+
metadata: @config.metadata,
|
10102
|
+
retry_policy: @config.retry_policy
|
10103
|
+
|
10104
|
+
@analytics_admin_service_stub.call_rpc :get_enhanced_measurement_settings, request, options: options do |response, operation|
|
10105
|
+
yield response, operation if block_given?
|
10106
|
+
return response
|
10107
|
+
end
|
10108
|
+
rescue ::GRPC::BadStatus => e
|
10109
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10110
|
+
end
|
10111
|
+
|
10112
|
+
##
|
10113
|
+
# Updates the enhanced measurement settings for this data stream.
|
10114
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
10115
|
+
# take effect.
|
10116
|
+
#
|
10117
|
+
# @overload update_enhanced_measurement_settings(request, options = nil)
|
10118
|
+
# Pass arguments to `update_enhanced_measurement_settings` via a request object, either of type
|
10119
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest} or an equivalent Hash.
|
10120
|
+
#
|
10121
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Hash]
|
10122
|
+
# A request object representing the call parameters. Required. To specify no
|
10123
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10124
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10125
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10126
|
+
#
|
10127
|
+
# @overload update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil)
|
10128
|
+
# Pass arguments to `update_enhanced_measurement_settings` via keyword arguments. Note that at
|
10129
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10130
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10131
|
+
#
|
10132
|
+
# @param enhanced_measurement_settings [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings, ::Hash]
|
10133
|
+
# Required. The settings to update.
|
10134
|
+
# The `name` field is used to identify the settings to be updated.
|
10135
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
10136
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
10137
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
10138
|
+
# replace the entire entity, use one path with the string "*" to match all
|
10139
|
+
# fields.
|
10140
|
+
#
|
10141
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10142
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
10143
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10144
|
+
#
|
10145
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
10146
|
+
#
|
10147
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10148
|
+
#
|
10149
|
+
# @example Basic example
|
10150
|
+
# require "google/analytics/admin/v1alpha"
|
10151
|
+
#
|
10152
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10153
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10154
|
+
#
|
10155
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10156
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest.new
|
10157
|
+
#
|
10158
|
+
# # Call the update_enhanced_measurement_settings method.
|
10159
|
+
# result = client.update_enhanced_measurement_settings request
|
10160
|
+
#
|
10161
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.
|
10162
|
+
# p result
|
10163
|
+
#
|
10164
|
+
def update_enhanced_measurement_settings request, options = nil
|
10165
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10166
|
+
|
10167
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest
|
10168
|
+
|
10169
|
+
# Converts hash and nil to an options object
|
10170
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10171
|
+
|
10172
|
+
# Customize the options with defaults
|
10173
|
+
metadata = @config.rpcs.update_enhanced_measurement_settings.metadata.to_h
|
10174
|
+
|
10175
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10176
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10177
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10178
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10179
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10180
|
+
|
10181
|
+
header_params = {}
|
10182
|
+
if request.enhanced_measurement_settings&.name
|
10183
|
+
header_params["enhanced_measurement_settings.name"] = request.enhanced_measurement_settings.name
|
10184
|
+
end
|
10185
|
+
|
10186
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
10187
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
10188
|
+
|
10189
|
+
options.apply_defaults timeout: @config.rpcs.update_enhanced_measurement_settings.timeout,
|
10190
|
+
metadata: metadata,
|
10191
|
+
retry_policy: @config.rpcs.update_enhanced_measurement_settings.retry_policy
|
10192
|
+
|
10193
|
+
options.apply_defaults timeout: @config.timeout,
|
10194
|
+
metadata: @config.metadata,
|
10195
|
+
retry_policy: @config.retry_policy
|
10196
|
+
|
10197
|
+
@analytics_admin_service_stub.call_rpc :update_enhanced_measurement_settings, request, options: options do |response, operation|
|
10198
|
+
yield response, operation if block_given?
|
10199
|
+
return response
|
10200
|
+
end
|
10201
|
+
rescue ::GRPC::BadStatus => e
|
10202
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10203
|
+
end
|
10204
|
+
|
10205
|
+
##
|
10206
|
+
# Creates a connected site tag for a Universal Analytics property. You can
|
10207
|
+
# create a maximum of 20 connected site tags per property.
|
10208
|
+
# Note: This API cannot be used on GA4 properties.
|
10209
|
+
#
|
10210
|
+
# @overload create_connected_site_tag(request, options = nil)
|
10211
|
+
# Pass arguments to `create_connected_site_tag` via a request object, either of type
|
10212
|
+
# {::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest} or an equivalent Hash.
|
10213
|
+
#
|
10214
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::Hash]
|
10215
|
+
# A request object representing the call parameters. Required. To specify no
|
10216
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10217
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10218
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10219
|
+
#
|
10220
|
+
# @overload create_connected_site_tag(property: nil, connected_site_tag: nil)
|
10221
|
+
# Pass arguments to `create_connected_site_tag` via keyword arguments. Note that at
|
10222
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10223
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10224
|
+
#
|
10225
|
+
# @param property [::String]
|
10226
|
+
# The Universal Analytics property to create connected site tags for.
|
10227
|
+
# This API does not support GA4 properties.
|
10228
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
10229
|
+
# Example: properties/1234
|
10230
|
+
# @param connected_site_tag [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag, ::Hash]
|
10231
|
+
# Required. The tag to add to the Universal Analytics property
|
10232
|
+
#
|
10233
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10234
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
|
10235
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10236
|
+
#
|
10237
|
+
# @return [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
|
10238
|
+
#
|
10239
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10240
|
+
#
|
10241
|
+
# @example Basic example
|
10242
|
+
# require "google/analytics/admin/v1alpha"
|
10243
|
+
#
|
10244
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10245
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10246
|
+
#
|
10247
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10248
|
+
# request = Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest.new
|
10249
|
+
#
|
10250
|
+
# # Call the create_connected_site_tag method.
|
10251
|
+
# result = client.create_connected_site_tag request
|
10252
|
+
#
|
10253
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse.
|
10254
|
+
# p result
|
10255
|
+
#
|
10256
|
+
def create_connected_site_tag request, options = nil
|
10257
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10258
|
+
|
10259
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest
|
10260
|
+
|
10261
|
+
# Converts hash and nil to an options object
|
10262
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10263
|
+
|
10264
|
+
# Customize the options with defaults
|
10265
|
+
metadata = @config.rpcs.create_connected_site_tag.metadata.to_h
|
10266
|
+
|
10267
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10268
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10269
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10270
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10271
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10272
|
+
|
10273
|
+
options.apply_defaults timeout: @config.rpcs.create_connected_site_tag.timeout,
|
10274
|
+
metadata: metadata,
|
10275
|
+
retry_policy: @config.rpcs.create_connected_site_tag.retry_policy
|
10276
|
+
|
10277
|
+
options.apply_defaults timeout: @config.timeout,
|
10278
|
+
metadata: @config.metadata,
|
10279
|
+
retry_policy: @config.retry_policy
|
10280
|
+
|
10281
|
+
@analytics_admin_service_stub.call_rpc :create_connected_site_tag, request, options: options do |response, operation|
|
10282
|
+
yield response, operation if block_given?
|
10283
|
+
return response
|
10284
|
+
end
|
10285
|
+
rescue ::GRPC::BadStatus => e
|
10286
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10287
|
+
end
|
10288
|
+
|
10289
|
+
##
|
10290
|
+
# Deletes a connected site tag for a Universal Analytics property.
|
10291
|
+
# Note: this has no effect on GA4 properties.
|
10292
|
+
#
|
10293
|
+
# @overload delete_connected_site_tag(request, options = nil)
|
10294
|
+
# Pass arguments to `delete_connected_site_tag` via a request object, either of type
|
10295
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest} or an equivalent Hash.
|
10296
|
+
#
|
10297
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::Hash]
|
10298
|
+
# A request object representing the call parameters. Required. To specify no
|
10299
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10300
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10301
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10302
|
+
#
|
10303
|
+
# @overload delete_connected_site_tag(property: nil, tag_id: nil)
|
10304
|
+
# Pass arguments to `delete_connected_site_tag` via keyword arguments. Note that at
|
10305
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10306
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10307
|
+
#
|
10308
|
+
# @param property [::String]
|
10309
|
+
# The Universal Analytics property to delete connected site tags for.
|
10310
|
+
# This API does not support GA4 properties.
|
10311
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
10312
|
+
# Example: properties/1234
|
10313
|
+
# @param tag_id [::String]
|
10314
|
+
# Tag ID to forward events to. Also known as the Measurement ID, or the
|
10315
|
+
# "G-ID" (For example: G-12345).
|
10316
|
+
#
|
10317
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10318
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
10319
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10320
|
+
#
|
10321
|
+
# @return [::Google::Protobuf::Empty]
|
10322
|
+
#
|
10323
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10324
|
+
#
|
10325
|
+
# @example Basic example
|
10326
|
+
# require "google/analytics/admin/v1alpha"
|
10327
|
+
#
|
10328
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10329
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10330
|
+
#
|
10331
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10332
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest.new
|
10333
|
+
#
|
10334
|
+
# # Call the delete_connected_site_tag method.
|
10335
|
+
# result = client.delete_connected_site_tag request
|
10336
|
+
#
|
10337
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
10338
|
+
# p result
|
10339
|
+
#
|
10340
|
+
def delete_connected_site_tag request, options = nil
|
10341
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10342
|
+
|
10343
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest
|
10344
|
+
|
10345
|
+
# Converts hash and nil to an options object
|
10346
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10347
|
+
|
10348
|
+
# Customize the options with defaults
|
10349
|
+
metadata = @config.rpcs.delete_connected_site_tag.metadata.to_h
|
10350
|
+
|
10351
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10352
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10353
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10354
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10355
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10356
|
+
|
10357
|
+
options.apply_defaults timeout: @config.rpcs.delete_connected_site_tag.timeout,
|
10358
|
+
metadata: metadata,
|
10359
|
+
retry_policy: @config.rpcs.delete_connected_site_tag.retry_policy
|
10360
|
+
|
10361
|
+
options.apply_defaults timeout: @config.timeout,
|
10362
|
+
metadata: @config.metadata,
|
10363
|
+
retry_policy: @config.retry_policy
|
10364
|
+
|
10365
|
+
@analytics_admin_service_stub.call_rpc :delete_connected_site_tag, request, options: options do |response, operation|
|
10366
|
+
yield response, operation if block_given?
|
10367
|
+
return response
|
10368
|
+
end
|
10369
|
+
rescue ::GRPC::BadStatus => e
|
10370
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10371
|
+
end
|
10372
|
+
|
10373
|
+
##
|
10374
|
+
# Lists the connected site tags for a Universal Analytics property. A maximum
|
10375
|
+
# of 20 connected site tags will be returned. Note: this has no effect on GA4
|
10376
|
+
# property.
|
10377
|
+
#
|
10378
|
+
# @overload list_connected_site_tags(request, options = nil)
|
10379
|
+
# Pass arguments to `list_connected_site_tags` via a request object, either of type
|
10380
|
+
# {::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest} or an equivalent Hash.
|
10381
|
+
#
|
10382
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::Hash]
|
10383
|
+
# A request object representing the call parameters. Required. To specify no
|
10384
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10385
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10386
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10387
|
+
#
|
10388
|
+
# @overload list_connected_site_tags(property: nil)
|
10389
|
+
# Pass arguments to `list_connected_site_tags` via keyword arguments. Note that at
|
10390
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10391
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10392
|
+
#
|
10393
|
+
# @param property [::String]
|
10394
|
+
# The Universal Analytics property to fetch connected site tags for.
|
10395
|
+
# This does not work on GA4 properties. A maximum of 20 connected site tags
|
10396
|
+
# will be returned.
|
10397
|
+
# Example Format: `properties/1234`
|
10398
|
+
#
|
10399
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10400
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
|
10401
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10402
|
+
#
|
10403
|
+
# @return [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
|
10404
|
+
#
|
10405
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10406
|
+
#
|
10407
|
+
# @example Basic example
|
10408
|
+
# require "google/analytics/admin/v1alpha"
|
10409
|
+
#
|
10410
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10411
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10412
|
+
#
|
10413
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10414
|
+
# request = Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest.new
|
10415
|
+
#
|
10416
|
+
# # Call the list_connected_site_tags method.
|
10417
|
+
# result = client.list_connected_site_tags request
|
10418
|
+
#
|
10419
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse.
|
10420
|
+
# p result
|
10421
|
+
#
|
10422
|
+
def list_connected_site_tags request, options = nil
|
10423
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10424
|
+
|
10425
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest
|
10426
|
+
|
10427
|
+
# Converts hash and nil to an options object
|
10428
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10429
|
+
|
10430
|
+
# Customize the options with defaults
|
10431
|
+
metadata = @config.rpcs.list_connected_site_tags.metadata.to_h
|
10432
|
+
|
10433
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10434
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10435
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10436
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10437
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10438
|
+
|
10439
|
+
options.apply_defaults timeout: @config.rpcs.list_connected_site_tags.timeout,
|
10440
|
+
metadata: metadata,
|
10441
|
+
retry_policy: @config.rpcs.list_connected_site_tags.retry_policy
|
10442
|
+
|
10443
|
+
options.apply_defaults timeout: @config.timeout,
|
10444
|
+
metadata: @config.metadata,
|
10445
|
+
retry_policy: @config.retry_policy
|
10446
|
+
|
10447
|
+
@analytics_admin_service_stub.call_rpc :list_connected_site_tags, request, options: options do |response, operation|
|
10448
|
+
yield response, operation if block_given?
|
10449
|
+
return response
|
10450
|
+
end
|
10451
|
+
rescue ::GRPC::BadStatus => e
|
10452
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10453
|
+
end
|
10454
|
+
|
10455
|
+
##
|
10456
|
+
# Given a specified UA property, looks up the GA4 property connected to it.
|
10457
|
+
# Note: this cannot be used with GA4 properties.
|
10458
|
+
#
|
10459
|
+
# @overload fetch_connected_ga4_property(request, options = nil)
|
10460
|
+
# Pass arguments to `fetch_connected_ga4_property` via a request object, either of type
|
10461
|
+
# {::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest} or an equivalent Hash.
|
10462
|
+
#
|
10463
|
+
# @param request [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest, ::Hash]
|
10464
|
+
# A request object representing the call parameters. Required. To specify no
|
10465
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10466
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10467
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10468
|
+
#
|
10469
|
+
# @overload fetch_connected_ga4_property(property: nil)
|
10470
|
+
# Pass arguments to `fetch_connected_ga4_property` via keyword arguments. Note that at
|
10471
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10472
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10473
|
+
#
|
10474
|
+
# @param property [::String]
|
10475
|
+
# Required. The UA property for which to look up the connected GA4 property.
|
10476
|
+
# Note this request uses the
|
10477
|
+
# internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
10478
|
+
# Format: properties/\\{internal_web_property_id}
|
10479
|
+
# Example: properties/1234
|
10480
|
+
#
|
10481
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10482
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
|
10483
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10484
|
+
#
|
10485
|
+
# @return [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
|
10486
|
+
#
|
10487
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10488
|
+
#
|
10489
|
+
# @example Basic example
|
10490
|
+
# require "google/analytics/admin/v1alpha"
|
10491
|
+
#
|
10492
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10493
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10494
|
+
#
|
10495
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10496
|
+
# request = Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest.new
|
10497
|
+
#
|
10498
|
+
# # Call the fetch_connected_ga4_property method.
|
10499
|
+
# result = client.fetch_connected_ga4_property request
|
10500
|
+
#
|
10501
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse.
|
10502
|
+
# p result
|
10503
|
+
#
|
10504
|
+
def fetch_connected_ga4_property request, options = nil
|
10505
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10506
|
+
|
10507
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest
|
10508
|
+
|
10509
|
+
# Converts hash and nil to an options object
|
10510
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10511
|
+
|
10512
|
+
# Customize the options with defaults
|
10513
|
+
metadata = @config.rpcs.fetch_connected_ga4_property.metadata.to_h
|
10514
|
+
|
10515
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10516
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10517
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10518
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10519
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10520
|
+
|
10521
|
+
options.apply_defaults timeout: @config.rpcs.fetch_connected_ga4_property.timeout,
|
10522
|
+
metadata: metadata,
|
10523
|
+
retry_policy: @config.rpcs.fetch_connected_ga4_property.retry_policy
|
10524
|
+
|
10525
|
+
options.apply_defaults timeout: @config.timeout,
|
10526
|
+
metadata: @config.metadata,
|
10527
|
+
retry_policy: @config.retry_policy
|
10528
|
+
|
10529
|
+
@analytics_admin_service_stub.call_rpc :fetch_connected_ga4_property, request, options: options do |response, operation|
|
10530
|
+
yield response, operation if block_given?
|
10531
|
+
return response
|
10532
|
+
end
|
10533
|
+
rescue ::GRPC::BadStatus => e
|
10534
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10535
|
+
end
|
10536
|
+
|
10537
|
+
##
|
10538
|
+
# Looks up a single AdSenseLink.
|
10539
|
+
#
|
10540
|
+
# @overload get_ad_sense_link(request, options = nil)
|
10541
|
+
# Pass arguments to `get_ad_sense_link` via a request object, either of type
|
10542
|
+
# {::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest} or an equivalent Hash.
|
10543
|
+
#
|
10544
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest, ::Hash]
|
10545
|
+
# A request object representing the call parameters. Required. To specify no
|
10546
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10547
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10548
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10549
|
+
#
|
10550
|
+
# @overload get_ad_sense_link(name: nil)
|
10551
|
+
# Pass arguments to `get_ad_sense_link` via keyword arguments. Note that at
|
10552
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10553
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10554
|
+
#
|
10555
|
+
# @param name [::String]
|
10556
|
+
# Required. Unique identifier for the AdSense Link requested.
|
10557
|
+
# Format: properties/\\{propertyId}/adSenseLinks/\\{linkId}
|
10558
|
+
# Example: properties/1234/adSenseLinks/5678
|
10559
|
+
#
|
10560
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10561
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
10562
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10563
|
+
#
|
10564
|
+
# @return [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
10565
|
+
#
|
10566
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10567
|
+
#
|
10568
|
+
# @example Basic example
|
10569
|
+
# require "google/analytics/admin/v1alpha"
|
10570
|
+
#
|
10571
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10572
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10573
|
+
#
|
10574
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10575
|
+
# request = Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest.new
|
10576
|
+
#
|
10577
|
+
# # Call the get_ad_sense_link method.
|
10578
|
+
# result = client.get_ad_sense_link request
|
10579
|
+
#
|
10580
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AdSenseLink.
|
10581
|
+
# p result
|
10582
|
+
#
|
10583
|
+
def get_ad_sense_link request, options = nil
|
10584
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10585
|
+
|
10586
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest
|
10587
|
+
|
10588
|
+
# Converts hash and nil to an options object
|
10589
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10590
|
+
|
10591
|
+
# Customize the options with defaults
|
10592
|
+
metadata = @config.rpcs.get_ad_sense_link.metadata.to_h
|
10593
|
+
|
10594
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10595
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10596
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10597
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10598
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10599
|
+
|
10600
|
+
header_params = {}
|
10601
|
+
if request.name
|
10602
|
+
header_params["name"] = request.name
|
10603
|
+
end
|
10604
|
+
|
10605
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
10606
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
10607
|
+
|
10608
|
+
options.apply_defaults timeout: @config.rpcs.get_ad_sense_link.timeout,
|
10609
|
+
metadata: metadata,
|
10610
|
+
retry_policy: @config.rpcs.get_ad_sense_link.retry_policy
|
10611
|
+
|
10612
|
+
options.apply_defaults timeout: @config.timeout,
|
10613
|
+
metadata: @config.metadata,
|
10614
|
+
retry_policy: @config.retry_policy
|
10615
|
+
|
10616
|
+
@analytics_admin_service_stub.call_rpc :get_ad_sense_link, request, options: options do |response, operation|
|
10617
|
+
yield response, operation if block_given?
|
10618
|
+
return response
|
10619
|
+
end
|
10620
|
+
rescue ::GRPC::BadStatus => e
|
10621
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10622
|
+
end
|
10623
|
+
|
10624
|
+
##
|
10625
|
+
# Creates an AdSenseLink.
|
10626
|
+
#
|
10627
|
+
# @overload create_ad_sense_link(request, options = nil)
|
10628
|
+
# Pass arguments to `create_ad_sense_link` via a request object, either of type
|
10629
|
+
# {::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest} or an equivalent Hash.
|
10630
|
+
#
|
10631
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest, ::Hash]
|
10632
|
+
# A request object representing the call parameters. Required. To specify no
|
10633
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10634
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10635
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10636
|
+
#
|
10637
|
+
# @overload create_ad_sense_link(parent: nil, adsense_link: nil)
|
10638
|
+
# Pass arguments to `create_ad_sense_link` via keyword arguments. Note that at
|
10639
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10640
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10641
|
+
#
|
10642
|
+
# @param parent [::String]
|
10643
|
+
# Required. The property for which to create an AdSense Link.
|
10644
|
+
# Format: properties/\\{propertyId}
|
10645
|
+
# Example: properties/1234
|
10646
|
+
# @param adsense_link [::Google::Analytics::Admin::V1alpha::AdSenseLink, ::Hash]
|
10647
|
+
# Required. The AdSense Link to create
|
10648
|
+
#
|
10649
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10650
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
10651
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10652
|
+
#
|
10653
|
+
# @return [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
10654
|
+
#
|
10655
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10656
|
+
#
|
10657
|
+
# @example Basic example
|
10658
|
+
# require "google/analytics/admin/v1alpha"
|
10659
|
+
#
|
10660
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10661
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10662
|
+
#
|
10663
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10664
|
+
# request = Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest.new
|
10665
|
+
#
|
10666
|
+
# # Call the create_ad_sense_link method.
|
10667
|
+
# result = client.create_ad_sense_link request
|
10668
|
+
#
|
10669
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AdSenseLink.
|
10670
|
+
# p result
|
10671
|
+
#
|
10672
|
+
def create_ad_sense_link request, options = nil
|
10673
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10674
|
+
|
10675
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest
|
10676
|
+
|
10677
|
+
# Converts hash and nil to an options object
|
10678
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10679
|
+
|
10680
|
+
# Customize the options with defaults
|
10681
|
+
metadata = @config.rpcs.create_ad_sense_link.metadata.to_h
|
10682
|
+
|
10683
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10684
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10685
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10686
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10687
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10688
|
+
|
10689
|
+
header_params = {}
|
10690
|
+
if request.parent
|
10691
|
+
header_params["parent"] = request.parent
|
10692
|
+
end
|
10693
|
+
|
10694
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
10695
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
10696
|
+
|
10697
|
+
options.apply_defaults timeout: @config.rpcs.create_ad_sense_link.timeout,
|
10698
|
+
metadata: metadata,
|
10699
|
+
retry_policy: @config.rpcs.create_ad_sense_link.retry_policy
|
10700
|
+
|
10701
|
+
options.apply_defaults timeout: @config.timeout,
|
10702
|
+
metadata: @config.metadata,
|
10703
|
+
retry_policy: @config.retry_policy
|
10704
|
+
|
10705
|
+
@analytics_admin_service_stub.call_rpc :create_ad_sense_link, request, options: options do |response, operation|
|
10706
|
+
yield response, operation if block_given?
|
10707
|
+
return response
|
10708
|
+
end
|
10709
|
+
rescue ::GRPC::BadStatus => e
|
10710
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10711
|
+
end
|
10712
|
+
|
10713
|
+
##
|
10714
|
+
# Deletes an AdSenseLink.
|
10715
|
+
#
|
10716
|
+
# @overload delete_ad_sense_link(request, options = nil)
|
10717
|
+
# Pass arguments to `delete_ad_sense_link` via a request object, either of type
|
10718
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest} or an equivalent Hash.
|
10719
|
+
#
|
10720
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest, ::Hash]
|
10721
|
+
# A request object representing the call parameters. Required. To specify no
|
10722
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10723
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10724
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10725
|
+
#
|
10726
|
+
# @overload delete_ad_sense_link(name: nil)
|
10727
|
+
# Pass arguments to `delete_ad_sense_link` via keyword arguments. Note that at
|
10728
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10729
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10730
|
+
#
|
10731
|
+
# @param name [::String]
|
10732
|
+
# Required. Unique identifier for the AdSense Link to be deleted.
|
10733
|
+
# Format: properties/\\{propertyId}/adSenseLinks/\\{linkId}
|
10734
|
+
# Example: properties/1234/adSenseLinks/5678
|
10735
|
+
#
|
10736
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
10737
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
10738
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
10739
|
+
#
|
10740
|
+
# @return [::Google::Protobuf::Empty]
|
10741
|
+
#
|
10742
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
10743
|
+
#
|
10744
|
+
# @example Basic example
|
10745
|
+
# require "google/analytics/admin/v1alpha"
|
10746
|
+
#
|
10747
|
+
# # Create a client object. The client can be reused for multiple calls.
|
10748
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
10749
|
+
#
|
10750
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
10751
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest.new
|
10752
|
+
#
|
10753
|
+
# # Call the delete_ad_sense_link method.
|
10754
|
+
# result = client.delete_ad_sense_link request
|
10755
|
+
#
|
10756
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
10757
|
+
# p result
|
10758
|
+
#
|
10759
|
+
def delete_ad_sense_link request, options = nil
|
10760
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
10761
|
+
|
10762
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest
|
10763
|
+
|
10764
|
+
# Converts hash and nil to an options object
|
10765
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
10766
|
+
|
10767
|
+
# Customize the options with defaults
|
10768
|
+
metadata = @config.rpcs.delete_ad_sense_link.metadata.to_h
|
10769
|
+
|
10770
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
10771
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
10772
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
10773
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
10774
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
10775
|
+
|
10776
|
+
header_params = {}
|
10777
|
+
if request.name
|
10778
|
+
header_params["name"] = request.name
|
10779
|
+
end
|
10780
|
+
|
10781
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
10782
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
10783
|
+
|
10784
|
+
options.apply_defaults timeout: @config.rpcs.delete_ad_sense_link.timeout,
|
10785
|
+
metadata: metadata,
|
10786
|
+
retry_policy: @config.rpcs.delete_ad_sense_link.retry_policy
|
10787
|
+
|
10788
|
+
options.apply_defaults timeout: @config.timeout,
|
10789
|
+
metadata: @config.metadata,
|
10790
|
+
retry_policy: @config.retry_policy
|
10791
|
+
|
10792
|
+
@analytics_admin_service_stub.call_rpc :delete_ad_sense_link, request, options: options do |response, operation|
|
10793
|
+
yield response, operation if block_given?
|
10794
|
+
return response
|
10795
|
+
end
|
10796
|
+
rescue ::GRPC::BadStatus => e
|
10797
|
+
raise ::Google::Cloud::Error.from_error(e)
|
10798
|
+
end
|
10799
|
+
|
10800
|
+
##
|
10801
|
+
# Lists AdSenseLinks on a property.
|
10802
|
+
#
|
10803
|
+
# @overload list_ad_sense_links(request, options = nil)
|
10804
|
+
# Pass arguments to `list_ad_sense_links` via a request object, either of type
|
10805
|
+
# {::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest} or an equivalent Hash.
|
10806
|
+
#
|
10807
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest, ::Hash]
|
10808
|
+
# A request object representing the call parameters. Required. To specify no
|
10809
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
10810
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
10811
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
10812
|
+
#
|
10813
|
+
# @overload list_ad_sense_links(parent: nil, page_size: nil, page_token: nil)
|
10814
|
+
# Pass arguments to `list_ad_sense_links` via keyword arguments. Note that at
|
10815
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
10816
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
10817
|
+
#
|
10818
|
+
# @param parent [::String]
|
10819
|
+
# Required. Resource name of the parent property.
|
10820
|
+
# Format: properties/\\{propertyId}
|
9488
10821
|
# Example: properties/1234
|
9489
10822
|
# @param page_size [::Integer]
|
9490
|
-
# The maximum number of resources to return.
|
9491
|
-
# fewer than this value, even if there are additional pages.
|
10823
|
+
# The maximum number of resources to return.
|
9492
10824
|
# If unspecified, at most 50 resources will be returned.
|
9493
|
-
# The maximum value is 200
|
10825
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
9494
10826
|
# @param page_token [::String]
|
9495
|
-
# A page token
|
10827
|
+
# A page token received from a previous `ListAdSenseLinks` call.
|
9496
10828
|
# Provide this to retrieve the subsequent page.
|
9497
|
-
#
|
10829
|
+
#
|
10830
|
+
# When paginating, all other parameters provided to `ListAdSenseLinks` must
|
9498
10831
|
# match the call that provided the page token.
|
9499
10832
|
#
|
9500
10833
|
# @yield [response, operation] Access the result along with the RPC operation
|
9501
|
-
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::
|
10834
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>]
|
9502
10835
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9503
10836
|
#
|
9504
|
-
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::
|
10837
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>]
|
9505
10838
|
#
|
9506
10839
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9507
10840
|
#
|
@@ -9512,28 +10845,28 @@ module Google
|
|
9512
10845
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9513
10846
|
#
|
9514
10847
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9515
|
-
# request = Google::Analytics::Admin::V1alpha::
|
10848
|
+
# request = Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest.new
|
9516
10849
|
#
|
9517
|
-
# # Call the
|
9518
|
-
# result = client.
|
10850
|
+
# # Call the list_ad_sense_links method.
|
10851
|
+
# result = client.list_ad_sense_links request
|
9519
10852
|
#
|
9520
10853
|
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
9521
10854
|
# # over elements, and API calls will be issued to fetch pages as needed.
|
9522
10855
|
# result.each do |item|
|
9523
|
-
# # Each element is of type ::Google::Analytics::Admin::V1alpha::
|
10856
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::AdSenseLink.
|
9524
10857
|
# p item
|
9525
10858
|
# end
|
9526
10859
|
#
|
9527
|
-
def
|
10860
|
+
def list_ad_sense_links request, options = nil
|
9528
10861
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9529
10862
|
|
9530
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
10863
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest
|
9531
10864
|
|
9532
10865
|
# Converts hash and nil to an options object
|
9533
10866
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9534
10867
|
|
9535
10868
|
# Customize the options with defaults
|
9536
|
-
metadata = @config.rpcs.
|
10869
|
+
metadata = @config.rpcs.list_ad_sense_links.metadata.to_h
|
9537
10870
|
|
9538
10871
|
# Set x-goog-api-client and x-goog-user-project headers
|
9539
10872
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9549,16 +10882,16 @@ module Google
|
|
9549
10882
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9550
10883
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
9551
10884
|
|
9552
|
-
options.apply_defaults timeout: @config.rpcs.
|
10885
|
+
options.apply_defaults timeout: @config.rpcs.list_ad_sense_links.timeout,
|
9553
10886
|
metadata: metadata,
|
9554
|
-
retry_policy: @config.rpcs.
|
10887
|
+
retry_policy: @config.rpcs.list_ad_sense_links.retry_policy
|
9555
10888
|
|
9556
10889
|
options.apply_defaults timeout: @config.timeout,
|
9557
10890
|
metadata: @config.metadata,
|
9558
10891
|
retry_policy: @config.retry_policy
|
9559
10892
|
|
9560
|
-
@analytics_admin_service_stub.call_rpc :
|
9561
|
-
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :
|
10893
|
+
@analytics_admin_service_stub.call_rpc :list_ad_sense_links, request, options: options do |response, operation|
|
10894
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_ad_sense_links, request, response, operation, options
|
9562
10895
|
yield response, operation if block_given?
|
9563
10896
|
return response
|
9564
10897
|
end
|
@@ -9567,36 +10900,32 @@ module Google
|
|
9567
10900
|
end
|
9568
10901
|
|
9569
10902
|
##
|
9570
|
-
#
|
9571
|
-
# Note that the stream must enable enhanced measurement for these settings to
|
9572
|
-
# take effect.
|
10903
|
+
# Lookup for a single EventCreateRule.
|
9573
10904
|
#
|
9574
|
-
# @overload
|
9575
|
-
# Pass arguments to `
|
9576
|
-
# {::Google::Analytics::Admin::V1alpha::
|
10905
|
+
# @overload get_event_create_rule(request, options = nil)
|
10906
|
+
# Pass arguments to `get_event_create_rule` via a request object, either of type
|
10907
|
+
# {::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest} or an equivalent Hash.
|
9577
10908
|
#
|
9578
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
10909
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest, ::Hash]
|
9579
10910
|
# A request object representing the call parameters. Required. To specify no
|
9580
10911
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9581
10912
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9582
10913
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9583
10914
|
#
|
9584
|
-
# @overload
|
9585
|
-
# Pass arguments to `
|
10915
|
+
# @overload get_event_create_rule(name: nil)
|
10916
|
+
# Pass arguments to `get_event_create_rule` via keyword arguments. Note that at
|
9586
10917
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9587
10918
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9588
10919
|
#
|
9589
10920
|
# @param name [::String]
|
9590
|
-
# Required. The name of the
|
9591
|
-
#
|
9592
|
-
# properties/\\{property}/dataStreams/\\{data_stream}/enhancedMeasurementSettings
|
9593
|
-
# Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
10921
|
+
# Required. The name of the EventCreateRule to get.
|
10922
|
+
# Example format: properties/123/dataStreams/456/eventCreateRules/789
|
9594
10923
|
#
|
9595
10924
|
# @yield [response, operation] Access the result along with the RPC operation
|
9596
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
10925
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
9597
10926
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9598
10927
|
#
|
9599
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
10928
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
9600
10929
|
#
|
9601
10930
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9602
10931
|
#
|
@@ -9607,24 +10936,24 @@ module Google
|
|
9607
10936
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9608
10937
|
#
|
9609
10938
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9610
|
-
# request = Google::Analytics::Admin::V1alpha::
|
10939
|
+
# request = Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest.new
|
9611
10940
|
#
|
9612
|
-
# # Call the
|
9613
|
-
# result = client.
|
10941
|
+
# # Call the get_event_create_rule method.
|
10942
|
+
# result = client.get_event_create_rule request
|
9614
10943
|
#
|
9615
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
10944
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::EventCreateRule.
|
9616
10945
|
# p result
|
9617
10946
|
#
|
9618
|
-
def
|
10947
|
+
def get_event_create_rule request, options = nil
|
9619
10948
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9620
10949
|
|
9621
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
10950
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest
|
9622
10951
|
|
9623
10952
|
# Converts hash and nil to an options object
|
9624
10953
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9625
10954
|
|
9626
10955
|
# Customize the options with defaults
|
9627
|
-
metadata = @config.rpcs.
|
10956
|
+
metadata = @config.rpcs.get_event_create_rule.metadata.to_h
|
9628
10957
|
|
9629
10958
|
# Set x-goog-api-client and x-goog-user-project headers
|
9630
10959
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9640,15 +10969,15 @@ module Google
|
|
9640
10969
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9641
10970
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
9642
10971
|
|
9643
|
-
options.apply_defaults timeout: @config.rpcs.
|
10972
|
+
options.apply_defaults timeout: @config.rpcs.get_event_create_rule.timeout,
|
9644
10973
|
metadata: metadata,
|
9645
|
-
retry_policy: @config.rpcs.
|
10974
|
+
retry_policy: @config.rpcs.get_event_create_rule.retry_policy
|
9646
10975
|
|
9647
10976
|
options.apply_defaults timeout: @config.timeout,
|
9648
10977
|
metadata: @config.metadata,
|
9649
10978
|
retry_policy: @config.retry_policy
|
9650
10979
|
|
9651
|
-
@analytics_admin_service_stub.call_rpc :
|
10980
|
+
@analytics_admin_service_stub.call_rpc :get_event_create_rule, request, options: options do |response, operation|
|
9652
10981
|
yield response, operation if block_given?
|
9653
10982
|
return response
|
9654
10983
|
end
|
@@ -9657,39 +10986,41 @@ module Google
|
|
9657
10986
|
end
|
9658
10987
|
|
9659
10988
|
##
|
9660
|
-
#
|
9661
|
-
# Note that the stream must enable enhanced measurement for these settings to
|
9662
|
-
# take effect.
|
10989
|
+
# Lists EventCreateRules on a web data stream.
|
9663
10990
|
#
|
9664
|
-
# @overload
|
9665
|
-
# Pass arguments to `
|
9666
|
-
# {::Google::Analytics::Admin::V1alpha::
|
10991
|
+
# @overload list_event_create_rules(request, options = nil)
|
10992
|
+
# Pass arguments to `list_event_create_rules` via a request object, either of type
|
10993
|
+
# {::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest} or an equivalent Hash.
|
9667
10994
|
#
|
9668
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
10995
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest, ::Hash]
|
9669
10996
|
# A request object representing the call parameters. Required. To specify no
|
9670
10997
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9671
10998
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9672
10999
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9673
11000
|
#
|
9674
|
-
# @overload
|
9675
|
-
# Pass arguments to `
|
11001
|
+
# @overload list_event_create_rules(parent: nil, page_size: nil, page_token: nil)
|
11002
|
+
# Pass arguments to `list_event_create_rules` via keyword arguments. Note that at
|
9676
11003
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9677
11004
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9678
11005
|
#
|
9679
|
-
# @param
|
9680
|
-
# Required.
|
9681
|
-
#
|
9682
|
-
#
|
9683
|
-
#
|
9684
|
-
#
|
9685
|
-
#
|
9686
|
-
#
|
11006
|
+
# @param parent [::String]
|
11007
|
+
# Required. Example format: properties/123/dataStreams/456
|
11008
|
+
# @param page_size [::Integer]
|
11009
|
+
# The maximum number of resources to return.
|
11010
|
+
# If unspecified, at most 50 resources will be returned.
|
11011
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
11012
|
+
# @param page_token [::String]
|
11013
|
+
# A page token, received from a previous `ListEventCreateRules` call. Provide
|
11014
|
+
# this to retrieve the subsequent page.
|
11015
|
+
#
|
11016
|
+
# When paginating, all other parameters provided to `ListEventCreateRules`
|
11017
|
+
# must match the call that provided the page token.
|
9687
11018
|
#
|
9688
11019
|
# @yield [response, operation] Access the result along with the RPC operation
|
9689
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
11020
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>]
|
9690
11021
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9691
11022
|
#
|
9692
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
11023
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>]
|
9693
11024
|
#
|
9694
11025
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9695
11026
|
#
|
@@ -9700,24 +11031,28 @@ module Google
|
|
9700
11031
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9701
11032
|
#
|
9702
11033
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9703
|
-
# request = Google::Analytics::Admin::V1alpha::
|
11034
|
+
# request = Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest.new
|
9704
11035
|
#
|
9705
|
-
# # Call the
|
9706
|
-
# result = client.
|
11036
|
+
# # Call the list_event_create_rules method.
|
11037
|
+
# result = client.list_event_create_rules request
|
9707
11038
|
#
|
9708
|
-
# # The returned object is of type
|
9709
|
-
#
|
11039
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
11040
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
11041
|
+
# result.each do |item|
|
11042
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::EventCreateRule.
|
11043
|
+
# p item
|
11044
|
+
# end
|
9710
11045
|
#
|
9711
|
-
def
|
11046
|
+
def list_event_create_rules request, options = nil
|
9712
11047
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9713
11048
|
|
9714
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
11049
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest
|
9715
11050
|
|
9716
11051
|
# Converts hash and nil to an options object
|
9717
11052
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9718
11053
|
|
9719
11054
|
# Customize the options with defaults
|
9720
|
-
metadata = @config.rpcs.
|
11055
|
+
metadata = @config.rpcs.list_event_create_rules.metadata.to_h
|
9721
11056
|
|
9722
11057
|
# Set x-goog-api-client and x-goog-user-project headers
|
9723
11058
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9726,22 +11061,23 @@ module Google
|
|
9726
11061
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9727
11062
|
|
9728
11063
|
header_params = {}
|
9729
|
-
if request.
|
9730
|
-
header_params["
|
11064
|
+
if request.parent
|
11065
|
+
header_params["parent"] = request.parent
|
9731
11066
|
end
|
9732
11067
|
|
9733
11068
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9734
11069
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
9735
11070
|
|
9736
|
-
options.apply_defaults timeout: @config.rpcs.
|
11071
|
+
options.apply_defaults timeout: @config.rpcs.list_event_create_rules.timeout,
|
9737
11072
|
metadata: metadata,
|
9738
|
-
retry_policy: @config.rpcs.
|
11073
|
+
retry_policy: @config.rpcs.list_event_create_rules.retry_policy
|
9739
11074
|
|
9740
11075
|
options.apply_defaults timeout: @config.timeout,
|
9741
11076
|
metadata: @config.metadata,
|
9742
11077
|
retry_policy: @config.retry_policy
|
9743
11078
|
|
9744
|
-
@analytics_admin_service_stub.call_rpc :
|
11079
|
+
@analytics_admin_service_stub.call_rpc :list_event_create_rules, request, options: options do |response, operation|
|
11080
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_event_create_rules, request, response, operation, options
|
9745
11081
|
yield response, operation if block_given?
|
9746
11082
|
return response
|
9747
11083
|
end
|
@@ -9750,38 +11086,33 @@ module Google
|
|
9750
11086
|
end
|
9751
11087
|
|
9752
11088
|
##
|
9753
|
-
# Creates
|
9754
|
-
# create a maximum of 20 connected site tags per property.
|
9755
|
-
# Note: This API cannot be used on GA4 properties.
|
11089
|
+
# Creates an EventCreateRule.
|
9756
11090
|
#
|
9757
|
-
# @overload
|
9758
|
-
# Pass arguments to `
|
9759
|
-
# {::Google::Analytics::Admin::V1alpha::
|
11091
|
+
# @overload create_event_create_rule(request, options = nil)
|
11092
|
+
# Pass arguments to `create_event_create_rule` via a request object, either of type
|
11093
|
+
# {::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest} or an equivalent Hash.
|
9760
11094
|
#
|
9761
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
11095
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest, ::Hash]
|
9762
11096
|
# A request object representing the call parameters. Required. To specify no
|
9763
11097
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9764
11098
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9765
11099
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9766
11100
|
#
|
9767
|
-
# @overload
|
9768
|
-
# Pass arguments to `
|
11101
|
+
# @overload create_event_create_rule(parent: nil, event_create_rule: nil)
|
11102
|
+
# Pass arguments to `create_event_create_rule` via keyword arguments. Note that at
|
9769
11103
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9770
11104
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9771
11105
|
#
|
9772
|
-
# @param
|
9773
|
-
#
|
9774
|
-
#
|
9775
|
-
#
|
9776
|
-
# Example: properties/1234
|
9777
|
-
# @param connected_site_tag [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag, ::Hash]
|
9778
|
-
# Required. The tag to add to the Universal Analytics property
|
11106
|
+
# @param parent [::String]
|
11107
|
+
# Required. Example format: properties/123/dataStreams/456
|
11108
|
+
# @param event_create_rule [::Google::Analytics::Admin::V1alpha::EventCreateRule, ::Hash]
|
11109
|
+
# Required. The EventCreateRule to create.
|
9779
11110
|
#
|
9780
11111
|
# @yield [response, operation] Access the result along with the RPC operation
|
9781
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
11112
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
9782
11113
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9783
11114
|
#
|
9784
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
11115
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
9785
11116
|
#
|
9786
11117
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9787
11118
|
#
|
@@ -9792,24 +11123,24 @@ module Google
|
|
9792
11123
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9793
11124
|
#
|
9794
11125
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9795
|
-
# request = Google::Analytics::Admin::V1alpha::
|
11126
|
+
# request = Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest.new
|
9796
11127
|
#
|
9797
|
-
# # Call the
|
9798
|
-
# result = client.
|
11128
|
+
# # Call the create_event_create_rule method.
|
11129
|
+
# result = client.create_event_create_rule request
|
9799
11130
|
#
|
9800
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
11131
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::EventCreateRule.
|
9801
11132
|
# p result
|
9802
11133
|
#
|
9803
|
-
def
|
11134
|
+
def create_event_create_rule request, options = nil
|
9804
11135
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9805
11136
|
|
9806
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
11137
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest
|
9807
11138
|
|
9808
11139
|
# Converts hash and nil to an options object
|
9809
11140
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9810
11141
|
|
9811
11142
|
# Customize the options with defaults
|
9812
|
-
metadata = @config.rpcs.
|
11143
|
+
metadata = @config.rpcs.create_event_create_rule.metadata.to_h
|
9813
11144
|
|
9814
11145
|
# Set x-goog-api-client and x-goog-user-project headers
|
9815
11146
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9817,15 +11148,23 @@ module Google
|
|
9817
11148
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9818
11149
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9819
11150
|
|
9820
|
-
|
11151
|
+
header_params = {}
|
11152
|
+
if request.parent
|
11153
|
+
header_params["parent"] = request.parent
|
11154
|
+
end
|
11155
|
+
|
11156
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
11157
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
11158
|
+
|
11159
|
+
options.apply_defaults timeout: @config.rpcs.create_event_create_rule.timeout,
|
9821
11160
|
metadata: metadata,
|
9822
|
-
retry_policy: @config.rpcs.
|
11161
|
+
retry_policy: @config.rpcs.create_event_create_rule.retry_policy
|
9823
11162
|
|
9824
11163
|
options.apply_defaults timeout: @config.timeout,
|
9825
11164
|
metadata: @config.metadata,
|
9826
11165
|
retry_policy: @config.retry_policy
|
9827
11166
|
|
9828
|
-
@analytics_admin_service_stub.call_rpc :
|
11167
|
+
@analytics_admin_service_stub.call_rpc :create_event_create_rule, request, options: options do |response, operation|
|
9829
11168
|
yield response, operation if block_given?
|
9830
11169
|
return response
|
9831
11170
|
end
|
@@ -9834,38 +11173,38 @@ module Google
|
|
9834
11173
|
end
|
9835
11174
|
|
9836
11175
|
##
|
9837
|
-
#
|
9838
|
-
# Note: this has no effect on GA4 properties.
|
11176
|
+
# Updates an EventCreateRule.
|
9839
11177
|
#
|
9840
|
-
# @overload
|
9841
|
-
# Pass arguments to `
|
9842
|
-
# {::Google::Analytics::Admin::V1alpha::
|
11178
|
+
# @overload update_event_create_rule(request, options = nil)
|
11179
|
+
# Pass arguments to `update_event_create_rule` via a request object, either of type
|
11180
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest} or an equivalent Hash.
|
9843
11181
|
#
|
9844
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
11182
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest, ::Hash]
|
9845
11183
|
# A request object representing the call parameters. Required. To specify no
|
9846
11184
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9847
11185
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9848
11186
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9849
11187
|
#
|
9850
|
-
# @overload
|
9851
|
-
# Pass arguments to `
|
11188
|
+
# @overload update_event_create_rule(event_create_rule: nil, update_mask: nil)
|
11189
|
+
# Pass arguments to `update_event_create_rule` via keyword arguments. Note that at
|
9852
11190
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9853
11191
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9854
11192
|
#
|
9855
|
-
# @param
|
9856
|
-
# The
|
9857
|
-
#
|
9858
|
-
#
|
9859
|
-
#
|
9860
|
-
#
|
9861
|
-
#
|
9862
|
-
# "
|
11193
|
+
# @param event_create_rule [::Google::Analytics::Admin::V1alpha::EventCreateRule, ::Hash]
|
11194
|
+
# Required. The EventCreateRule to update.
|
11195
|
+
# The resource's `name` field is used to identify the EventCreateRule to be
|
11196
|
+
# updated.
|
11197
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
11198
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
11199
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
11200
|
+
# replace the entire entity, use one path with the string "*" to match all
|
11201
|
+
# fields.
|
9863
11202
|
#
|
9864
11203
|
# @yield [response, operation] Access the result along with the RPC operation
|
9865
|
-
# @yieldparam response [::Google::
|
11204
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
9866
11205
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9867
11206
|
#
|
9868
|
-
# @return [::Google::
|
11207
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
9869
11208
|
#
|
9870
11209
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9871
11210
|
#
|
@@ -9876,24 +11215,24 @@ module Google
|
|
9876
11215
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9877
11216
|
#
|
9878
11217
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9879
|
-
# request = Google::Analytics::Admin::V1alpha::
|
11218
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest.new
|
9880
11219
|
#
|
9881
|
-
# # Call the
|
9882
|
-
# result = client.
|
11220
|
+
# # Call the update_event_create_rule method.
|
11221
|
+
# result = client.update_event_create_rule request
|
9883
11222
|
#
|
9884
|
-
# # The returned object is of type Google::
|
11223
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::EventCreateRule.
|
9885
11224
|
# p result
|
9886
11225
|
#
|
9887
|
-
def
|
11226
|
+
def update_event_create_rule request, options = nil
|
9888
11227
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9889
11228
|
|
9890
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
11229
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest
|
9891
11230
|
|
9892
11231
|
# Converts hash and nil to an options object
|
9893
11232
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9894
11233
|
|
9895
11234
|
# Customize the options with defaults
|
9896
|
-
metadata = @config.rpcs.
|
11235
|
+
metadata = @config.rpcs.update_event_create_rule.metadata.to_h
|
9897
11236
|
|
9898
11237
|
# Set x-goog-api-client and x-goog-user-project headers
|
9899
11238
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9901,15 +11240,23 @@ module Google
|
|
9901
11240
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9902
11241
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9903
11242
|
|
9904
|
-
|
11243
|
+
header_params = {}
|
11244
|
+
if request.event_create_rule&.name
|
11245
|
+
header_params["event_create_rule.name"] = request.event_create_rule.name
|
11246
|
+
end
|
11247
|
+
|
11248
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
11249
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
11250
|
+
|
11251
|
+
options.apply_defaults timeout: @config.rpcs.update_event_create_rule.timeout,
|
9905
11252
|
metadata: metadata,
|
9906
|
-
retry_policy: @config.rpcs.
|
11253
|
+
retry_policy: @config.rpcs.update_event_create_rule.retry_policy
|
9907
11254
|
|
9908
11255
|
options.apply_defaults timeout: @config.timeout,
|
9909
11256
|
metadata: @config.metadata,
|
9910
11257
|
retry_policy: @config.retry_policy
|
9911
11258
|
|
9912
|
-
@analytics_admin_service_stub.call_rpc :
|
11259
|
+
@analytics_admin_service_stub.call_rpc :update_event_create_rule, request, options: options do |response, operation|
|
9913
11260
|
yield response, operation if block_given?
|
9914
11261
|
return response
|
9915
11262
|
end
|
@@ -9918,36 +11265,32 @@ module Google
|
|
9918
11265
|
end
|
9919
11266
|
|
9920
11267
|
##
|
9921
|
-
#
|
9922
|
-
# of 20 connected site tags will be returned. Note: this has no effect on GA4
|
9923
|
-
# property.
|
11268
|
+
# Deletes an EventCreateRule.
|
9924
11269
|
#
|
9925
|
-
# @overload
|
9926
|
-
# Pass arguments to `
|
9927
|
-
# {::Google::Analytics::Admin::V1alpha::
|
11270
|
+
# @overload delete_event_create_rule(request, options = nil)
|
11271
|
+
# Pass arguments to `delete_event_create_rule` via a request object, either of type
|
11272
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest} or an equivalent Hash.
|
9928
11273
|
#
|
9929
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
11274
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest, ::Hash]
|
9930
11275
|
# A request object representing the call parameters. Required. To specify no
|
9931
11276
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9932
11277
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9933
11278
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9934
11279
|
#
|
9935
|
-
# @overload
|
9936
|
-
# Pass arguments to `
|
11280
|
+
# @overload delete_event_create_rule(name: nil)
|
11281
|
+
# Pass arguments to `delete_event_create_rule` via keyword arguments. Note that at
|
9937
11282
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9938
11283
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9939
11284
|
#
|
9940
|
-
# @param
|
9941
|
-
#
|
9942
|
-
#
|
9943
|
-
# will be returned.
|
9944
|
-
# Example Format: `properties/1234`
|
11285
|
+
# @param name [::String]
|
11286
|
+
# Required. Example format:
|
11287
|
+
# properties/123/dataStreams/456/eventCreateRules/789
|
9945
11288
|
#
|
9946
11289
|
# @yield [response, operation] Access the result along with the RPC operation
|
9947
|
-
# @yieldparam response [::Google::
|
11290
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
9948
11291
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9949
11292
|
#
|
9950
|
-
# @return [::Google::
|
11293
|
+
# @return [::Google::Protobuf::Empty]
|
9951
11294
|
#
|
9952
11295
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9953
11296
|
#
|
@@ -9958,24 +11301,24 @@ module Google
|
|
9958
11301
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9959
11302
|
#
|
9960
11303
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9961
|
-
# request = Google::Analytics::Admin::V1alpha::
|
11304
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest.new
|
9962
11305
|
#
|
9963
|
-
# # Call the
|
9964
|
-
# result = client.
|
11306
|
+
# # Call the delete_event_create_rule method.
|
11307
|
+
# result = client.delete_event_create_rule request
|
9965
11308
|
#
|
9966
|
-
# # The returned object is of type Google::
|
11309
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
9967
11310
|
# p result
|
9968
11311
|
#
|
9969
|
-
def
|
11312
|
+
def delete_event_create_rule request, options = nil
|
9970
11313
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9971
11314
|
|
9972
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
11315
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest
|
9973
11316
|
|
9974
11317
|
# Converts hash and nil to an options object
|
9975
11318
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9976
11319
|
|
9977
11320
|
# Customize the options with defaults
|
9978
|
-
metadata = @config.rpcs.
|
11321
|
+
metadata = @config.rpcs.delete_event_create_rule.metadata.to_h
|
9979
11322
|
|
9980
11323
|
# Set x-goog-api-client and x-goog-user-project headers
|
9981
11324
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9983,15 +11326,23 @@ module Google
|
|
9983
11326
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9984
11327
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9985
11328
|
|
9986
|
-
|
11329
|
+
header_params = {}
|
11330
|
+
if request.name
|
11331
|
+
header_params["name"] = request.name
|
11332
|
+
end
|
11333
|
+
|
11334
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
11335
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
11336
|
+
|
11337
|
+
options.apply_defaults timeout: @config.rpcs.delete_event_create_rule.timeout,
|
9987
11338
|
metadata: metadata,
|
9988
|
-
retry_policy: @config.rpcs.
|
11339
|
+
retry_policy: @config.rpcs.delete_event_create_rule.retry_policy
|
9989
11340
|
|
9990
11341
|
options.apply_defaults timeout: @config.timeout,
|
9991
11342
|
metadata: @config.metadata,
|
9992
11343
|
retry_policy: @config.retry_policy
|
9993
11344
|
|
9994
|
-
@analytics_admin_service_stub.call_rpc :
|
11345
|
+
@analytics_admin_service_stub.call_rpc :delete_event_create_rule, request, options: options do |response, operation|
|
9995
11346
|
yield response, operation if block_given?
|
9996
11347
|
return response
|
9997
11348
|
end
|
@@ -10625,6 +11976,31 @@ module Google
|
|
10625
11976
|
#
|
10626
11977
|
attr_reader :delete_expanded_data_set
|
10627
11978
|
##
|
11979
|
+
# RPC-specific configuration for `get_channel_group`
|
11980
|
+
# @return [::Gapic::Config::Method]
|
11981
|
+
#
|
11982
|
+
attr_reader :get_channel_group
|
11983
|
+
##
|
11984
|
+
# RPC-specific configuration for `list_channel_groups`
|
11985
|
+
# @return [::Gapic::Config::Method]
|
11986
|
+
#
|
11987
|
+
attr_reader :list_channel_groups
|
11988
|
+
##
|
11989
|
+
# RPC-specific configuration for `create_channel_group`
|
11990
|
+
# @return [::Gapic::Config::Method]
|
11991
|
+
#
|
11992
|
+
attr_reader :create_channel_group
|
11993
|
+
##
|
11994
|
+
# RPC-specific configuration for `update_channel_group`
|
11995
|
+
# @return [::Gapic::Config::Method]
|
11996
|
+
#
|
11997
|
+
attr_reader :update_channel_group
|
11998
|
+
##
|
11999
|
+
# RPC-specific configuration for `delete_channel_group`
|
12000
|
+
# @return [::Gapic::Config::Method]
|
12001
|
+
#
|
12002
|
+
attr_reader :delete_channel_group
|
12003
|
+
##
|
10628
12004
|
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
10629
12005
|
# @return [::Gapic::Config::Method]
|
10630
12006
|
#
|
@@ -10669,6 +12045,56 @@ module Google
|
|
10669
12045
|
# @return [::Gapic::Config::Method]
|
10670
12046
|
#
|
10671
12047
|
attr_reader :list_connected_site_tags
|
12048
|
+
##
|
12049
|
+
# RPC-specific configuration for `fetch_connected_ga4_property`
|
12050
|
+
# @return [::Gapic::Config::Method]
|
12051
|
+
#
|
12052
|
+
attr_reader :fetch_connected_ga4_property
|
12053
|
+
##
|
12054
|
+
# RPC-specific configuration for `get_ad_sense_link`
|
12055
|
+
# @return [::Gapic::Config::Method]
|
12056
|
+
#
|
12057
|
+
attr_reader :get_ad_sense_link
|
12058
|
+
##
|
12059
|
+
# RPC-specific configuration for `create_ad_sense_link`
|
12060
|
+
# @return [::Gapic::Config::Method]
|
12061
|
+
#
|
12062
|
+
attr_reader :create_ad_sense_link
|
12063
|
+
##
|
12064
|
+
# RPC-specific configuration for `delete_ad_sense_link`
|
12065
|
+
# @return [::Gapic::Config::Method]
|
12066
|
+
#
|
12067
|
+
attr_reader :delete_ad_sense_link
|
12068
|
+
##
|
12069
|
+
# RPC-specific configuration for `list_ad_sense_links`
|
12070
|
+
# @return [::Gapic::Config::Method]
|
12071
|
+
#
|
12072
|
+
attr_reader :list_ad_sense_links
|
12073
|
+
##
|
12074
|
+
# RPC-specific configuration for `get_event_create_rule`
|
12075
|
+
# @return [::Gapic::Config::Method]
|
12076
|
+
#
|
12077
|
+
attr_reader :get_event_create_rule
|
12078
|
+
##
|
12079
|
+
# RPC-specific configuration for `list_event_create_rules`
|
12080
|
+
# @return [::Gapic::Config::Method]
|
12081
|
+
#
|
12082
|
+
attr_reader :list_event_create_rules
|
12083
|
+
##
|
12084
|
+
# RPC-specific configuration for `create_event_create_rule`
|
12085
|
+
# @return [::Gapic::Config::Method]
|
12086
|
+
#
|
12087
|
+
attr_reader :create_event_create_rule
|
12088
|
+
##
|
12089
|
+
# RPC-specific configuration for `update_event_create_rule`
|
12090
|
+
# @return [::Gapic::Config::Method]
|
12091
|
+
#
|
12092
|
+
attr_reader :update_event_create_rule
|
12093
|
+
##
|
12094
|
+
# RPC-specific configuration for `delete_event_create_rule`
|
12095
|
+
# @return [::Gapic::Config::Method]
|
12096
|
+
#
|
12097
|
+
attr_reader :delete_event_create_rule
|
10672
12098
|
|
10673
12099
|
# @private
|
10674
12100
|
def initialize parent_rpcs = nil
|
@@ -10868,6 +12294,16 @@ module Google
|
|
10868
12294
|
@update_expanded_data_set = ::Gapic::Config::Method.new update_expanded_data_set_config
|
10869
12295
|
delete_expanded_data_set_config = parent_rpcs.delete_expanded_data_set if parent_rpcs.respond_to? :delete_expanded_data_set
|
10870
12296
|
@delete_expanded_data_set = ::Gapic::Config::Method.new delete_expanded_data_set_config
|
12297
|
+
get_channel_group_config = parent_rpcs.get_channel_group if parent_rpcs.respond_to? :get_channel_group
|
12298
|
+
@get_channel_group = ::Gapic::Config::Method.new get_channel_group_config
|
12299
|
+
list_channel_groups_config = parent_rpcs.list_channel_groups if parent_rpcs.respond_to? :list_channel_groups
|
12300
|
+
@list_channel_groups = ::Gapic::Config::Method.new list_channel_groups_config
|
12301
|
+
create_channel_group_config = parent_rpcs.create_channel_group if parent_rpcs.respond_to? :create_channel_group
|
12302
|
+
@create_channel_group = ::Gapic::Config::Method.new create_channel_group_config
|
12303
|
+
update_channel_group_config = parent_rpcs.update_channel_group if parent_rpcs.respond_to? :update_channel_group
|
12304
|
+
@update_channel_group = ::Gapic::Config::Method.new update_channel_group_config
|
12305
|
+
delete_channel_group_config = parent_rpcs.delete_channel_group if parent_rpcs.respond_to? :delete_channel_group
|
12306
|
+
@delete_channel_group = ::Gapic::Config::Method.new delete_channel_group_config
|
10871
12307
|
set_automated_ga4_configuration_opt_out_config = parent_rpcs.set_automated_ga4_configuration_opt_out if parent_rpcs.respond_to? :set_automated_ga4_configuration_opt_out
|
10872
12308
|
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
10873
12309
|
fetch_automated_ga4_configuration_opt_out_config = parent_rpcs.fetch_automated_ga4_configuration_opt_out if parent_rpcs.respond_to? :fetch_automated_ga4_configuration_opt_out
|
@@ -10886,6 +12322,26 @@ module Google
|
|
10886
12322
|
@delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
|
10887
12323
|
list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
|
10888
12324
|
@list_connected_site_tags = ::Gapic::Config::Method.new list_connected_site_tags_config
|
12325
|
+
fetch_connected_ga4_property_config = parent_rpcs.fetch_connected_ga4_property if parent_rpcs.respond_to? :fetch_connected_ga4_property
|
12326
|
+
@fetch_connected_ga4_property = ::Gapic::Config::Method.new fetch_connected_ga4_property_config
|
12327
|
+
get_ad_sense_link_config = parent_rpcs.get_ad_sense_link if parent_rpcs.respond_to? :get_ad_sense_link
|
12328
|
+
@get_ad_sense_link = ::Gapic::Config::Method.new get_ad_sense_link_config
|
12329
|
+
create_ad_sense_link_config = parent_rpcs.create_ad_sense_link if parent_rpcs.respond_to? :create_ad_sense_link
|
12330
|
+
@create_ad_sense_link = ::Gapic::Config::Method.new create_ad_sense_link_config
|
12331
|
+
delete_ad_sense_link_config = parent_rpcs.delete_ad_sense_link if parent_rpcs.respond_to? :delete_ad_sense_link
|
12332
|
+
@delete_ad_sense_link = ::Gapic::Config::Method.new delete_ad_sense_link_config
|
12333
|
+
list_ad_sense_links_config = parent_rpcs.list_ad_sense_links if parent_rpcs.respond_to? :list_ad_sense_links
|
12334
|
+
@list_ad_sense_links = ::Gapic::Config::Method.new list_ad_sense_links_config
|
12335
|
+
get_event_create_rule_config = parent_rpcs.get_event_create_rule if parent_rpcs.respond_to? :get_event_create_rule
|
12336
|
+
@get_event_create_rule = ::Gapic::Config::Method.new get_event_create_rule_config
|
12337
|
+
list_event_create_rules_config = parent_rpcs.list_event_create_rules if parent_rpcs.respond_to? :list_event_create_rules
|
12338
|
+
@list_event_create_rules = ::Gapic::Config::Method.new list_event_create_rules_config
|
12339
|
+
create_event_create_rule_config = parent_rpcs.create_event_create_rule if parent_rpcs.respond_to? :create_event_create_rule
|
12340
|
+
@create_event_create_rule = ::Gapic::Config::Method.new create_event_create_rule_config
|
12341
|
+
update_event_create_rule_config = parent_rpcs.update_event_create_rule if parent_rpcs.respond_to? :update_event_create_rule
|
12342
|
+
@update_event_create_rule = ::Gapic::Config::Method.new update_event_create_rule_config
|
12343
|
+
delete_event_create_rule_config = parent_rpcs.delete_event_create_rule if parent_rpcs.respond_to? :delete_event_create_rule
|
12344
|
+
@delete_event_create_rule = ::Gapic::Config::Method.new delete_event_create_rule_config
|
10889
12345
|
|
10890
12346
|
yield self if block_given?
|
10891
12347
|
end
|