google-analytics-admin-v1alpha 0.17.0 → 0.18.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 +38 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +578 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +17 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +444 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +354 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +13 -0
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +74 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +3 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +112 -1
- data/proto_docs/google/analytics/admin/v1alpha/channel_group.rb +158 -0
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +9 -0
- data/proto_docs/google/api/client.rb +58 -1
- metadata +4 -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
|
@@ -9211,6 +9211,459 @@ module Google
|
|
9211
9211
|
raise ::Google::Cloud::Error.from_error(e)
|
9212
9212
|
end
|
9213
9213
|
|
9214
|
+
##
|
9215
|
+
# Lookup for a single ChannelGroup.
|
9216
|
+
#
|
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.
|
9220
|
+
#
|
9221
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest, ::Hash]
|
9222
|
+
# A request object representing the call parameters. Required. To specify no
|
9223
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9224
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9225
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9226
|
+
#
|
9227
|
+
# @overload get_channel_group(name: nil)
|
9228
|
+
# Pass arguments to `get_channel_group` via keyword arguments. Note that at
|
9229
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9230
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9231
|
+
#
|
9232
|
+
# @param name [::String]
|
9233
|
+
# Required. The ChannelGroup to get.
|
9234
|
+
# Example format: properties/1234/channelGroups/5678
|
9235
|
+
#
|
9236
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9237
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9238
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9239
|
+
#
|
9240
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9241
|
+
#
|
9242
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9243
|
+
#
|
9244
|
+
# @example Basic example
|
9245
|
+
# require "google/analytics/admin/v1alpha"
|
9246
|
+
#
|
9247
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9248
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9249
|
+
#
|
9250
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9251
|
+
# request = Google::Analytics::Admin::V1alpha::GetChannelGroupRequest.new
|
9252
|
+
#
|
9253
|
+
# # Call the get_channel_group method.
|
9254
|
+
# result = client.get_channel_group request
|
9255
|
+
#
|
9256
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9257
|
+
# p result
|
9258
|
+
#
|
9259
|
+
def get_channel_group request, options = nil
|
9260
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9261
|
+
|
9262
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest
|
9263
|
+
|
9264
|
+
# Converts hash and nil to an options object
|
9265
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9266
|
+
|
9267
|
+
# Customize the options with defaults
|
9268
|
+
metadata = @config.rpcs.get_channel_group.metadata.to_h
|
9269
|
+
|
9270
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9271
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9272
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9273
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9274
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9275
|
+
|
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,
|
9285
|
+
metadata: metadata,
|
9286
|
+
retry_policy: @config.rpcs.get_channel_group.retry_policy
|
9287
|
+
|
9288
|
+
options.apply_defaults timeout: @config.timeout,
|
9289
|
+
metadata: @config.metadata,
|
9290
|
+
retry_policy: @config.retry_policy
|
9291
|
+
|
9292
|
+
@analytics_admin_service_stub.call_rpc :get_channel_group, request, options: options do |response, operation|
|
9293
|
+
yield response, operation if block_given?
|
9294
|
+
return response
|
9295
|
+
end
|
9296
|
+
rescue ::GRPC::BadStatus => e
|
9297
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9298
|
+
end
|
9299
|
+
|
9300
|
+
##
|
9301
|
+
# Lists ChannelGroups on a property.
|
9302
|
+
#
|
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
|
+
#
|
9307
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest, ::Hash]
|
9308
|
+
# A request object representing the call parameters. Required. To specify no
|
9309
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9310
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9311
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9312
|
+
#
|
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
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9316
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9317
|
+
#
|
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.
|
9331
|
+
#
|
9332
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9333
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
9334
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9335
|
+
#
|
9336
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
9337
|
+
#
|
9338
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9339
|
+
#
|
9340
|
+
# @example Basic example
|
9341
|
+
# require "google/analytics/admin/v1alpha"
|
9342
|
+
#
|
9343
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9344
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9345
|
+
#
|
9346
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9347
|
+
# request = Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest.new
|
9348
|
+
#
|
9349
|
+
# # Call the list_channel_groups method.
|
9350
|
+
# result = client.list_channel_groups request
|
9351
|
+
#
|
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.
|
9446
|
+
# p result
|
9447
|
+
#
|
9448
|
+
def create_channel_group request, options = nil
|
9449
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9450
|
+
|
9451
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest
|
9452
|
+
|
9453
|
+
# Converts hash and nil to an options object
|
9454
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9455
|
+
|
9456
|
+
# Customize the options with defaults
|
9457
|
+
metadata = @config.rpcs.create_channel_group.metadata.to_h
|
9458
|
+
|
9459
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9460
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9461
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9462
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9463
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9464
|
+
|
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,
|
9474
|
+
metadata: metadata,
|
9475
|
+
retry_policy: @config.rpcs.create_channel_group.retry_policy
|
9476
|
+
|
9477
|
+
options.apply_defaults timeout: @config.timeout,
|
9478
|
+
metadata: @config.metadata,
|
9479
|
+
retry_policy: @config.retry_policy
|
9480
|
+
|
9481
|
+
@analytics_admin_service_stub.call_rpc :create_channel_group, request, options: options do |response, operation|
|
9482
|
+
yield response, operation if block_given?
|
9483
|
+
return response
|
9484
|
+
end
|
9485
|
+
rescue ::GRPC::BadStatus => e
|
9486
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9487
|
+
end
|
9488
|
+
|
9489
|
+
##
|
9490
|
+
# Updates a ChannelGroup.
|
9491
|
+
#
|
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.
|
9495
|
+
#
|
9496
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest, ::Hash]
|
9497
|
+
# A request object representing the call parameters. Required. To specify no
|
9498
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9499
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9500
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9501
|
+
#
|
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
|
9596
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9597
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9598
|
+
#
|
9599
|
+
# @param name [::String]
|
9600
|
+
# Required. The ChannelGroup to delete.
|
9601
|
+
# Example format: properties/1234/channelGroups/5678
|
9602
|
+
#
|
9603
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9604
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
9605
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9606
|
+
#
|
9607
|
+
# @return [::Google::Protobuf::Empty]
|
9608
|
+
#
|
9609
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9610
|
+
#
|
9611
|
+
# @example Basic example
|
9612
|
+
# require "google/analytics/admin/v1alpha"
|
9613
|
+
#
|
9614
|
+
# # Create a client object. The client can be reused for multiple calls.
|
9615
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9616
|
+
#
|
9617
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
9618
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest.new
|
9619
|
+
#
|
9620
|
+
# # Call the delete_channel_group method.
|
9621
|
+
# result = client.delete_channel_group request
|
9622
|
+
#
|
9623
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
9624
|
+
# p result
|
9625
|
+
#
|
9626
|
+
def delete_channel_group request, options = nil
|
9627
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
9628
|
+
|
9629
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest
|
9630
|
+
|
9631
|
+
# Converts hash and nil to an options object
|
9632
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9633
|
+
|
9634
|
+
# Customize the options with defaults
|
9635
|
+
metadata = @config.rpcs.delete_channel_group.metadata.to_h
|
9636
|
+
|
9637
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
9638
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
9639
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
9640
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9641
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9642
|
+
|
9643
|
+
header_params = {}
|
9644
|
+
if request.name
|
9645
|
+
header_params["name"] = request.name
|
9646
|
+
end
|
9647
|
+
|
9648
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9649
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
9650
|
+
|
9651
|
+
options.apply_defaults timeout: @config.rpcs.delete_channel_group.timeout,
|
9652
|
+
metadata: metadata,
|
9653
|
+
retry_policy: @config.rpcs.delete_channel_group.retry_policy
|
9654
|
+
|
9655
|
+
options.apply_defaults timeout: @config.timeout,
|
9656
|
+
metadata: @config.metadata,
|
9657
|
+
retry_policy: @config.retry_policy
|
9658
|
+
|
9659
|
+
@analytics_admin_service_stub.call_rpc :delete_channel_group, request, options: options do |response, operation|
|
9660
|
+
yield response, operation if block_given?
|
9661
|
+
return response
|
9662
|
+
end
|
9663
|
+
rescue ::GRPC::BadStatus => e
|
9664
|
+
raise ::Google::Cloud::Error.from_error(e)
|
9665
|
+
end
|
9666
|
+
|
9214
9667
|
##
|
9215
9668
|
# Sets the opt out status for the automated GA4 setup process for a UA
|
9216
9669
|
# property.
|
@@ -9999,6 +10452,88 @@ module Google
|
|
9999
10452
|
raise ::Google::Cloud::Error.from_error(e)
|
10000
10453
|
end
|
10001
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
|
+
|
10002
10537
|
##
|
10003
10538
|
# Configuration class for the AnalyticsAdminService API.
|
10004
10539
|
#
|
@@ -10625,6 +11160,31 @@ module Google
|
|
10625
11160
|
#
|
10626
11161
|
attr_reader :delete_expanded_data_set
|
10627
11162
|
##
|
11163
|
+
# RPC-specific configuration for `get_channel_group`
|
11164
|
+
# @return [::Gapic::Config::Method]
|
11165
|
+
#
|
11166
|
+
attr_reader :get_channel_group
|
11167
|
+
##
|
11168
|
+
# RPC-specific configuration for `list_channel_groups`
|
11169
|
+
# @return [::Gapic::Config::Method]
|
11170
|
+
#
|
11171
|
+
attr_reader :list_channel_groups
|
11172
|
+
##
|
11173
|
+
# RPC-specific configuration for `create_channel_group`
|
11174
|
+
# @return [::Gapic::Config::Method]
|
11175
|
+
#
|
11176
|
+
attr_reader :create_channel_group
|
11177
|
+
##
|
11178
|
+
# RPC-specific configuration for `update_channel_group`
|
11179
|
+
# @return [::Gapic::Config::Method]
|
11180
|
+
#
|
11181
|
+
attr_reader :update_channel_group
|
11182
|
+
##
|
11183
|
+
# RPC-specific configuration for `delete_channel_group`
|
11184
|
+
# @return [::Gapic::Config::Method]
|
11185
|
+
#
|
11186
|
+
attr_reader :delete_channel_group
|
11187
|
+
##
|
10628
11188
|
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
10629
11189
|
# @return [::Gapic::Config::Method]
|
10630
11190
|
#
|
@@ -10669,6 +11229,11 @@ module Google
|
|
10669
11229
|
# @return [::Gapic::Config::Method]
|
10670
11230
|
#
|
10671
11231
|
attr_reader :list_connected_site_tags
|
11232
|
+
##
|
11233
|
+
# RPC-specific configuration for `fetch_connected_ga4_property`
|
11234
|
+
# @return [::Gapic::Config::Method]
|
11235
|
+
#
|
11236
|
+
attr_reader :fetch_connected_ga4_property
|
10672
11237
|
|
10673
11238
|
# @private
|
10674
11239
|
def initialize parent_rpcs = nil
|
@@ -10868,6 +11433,16 @@ module Google
|
|
10868
11433
|
@update_expanded_data_set = ::Gapic::Config::Method.new update_expanded_data_set_config
|
10869
11434
|
delete_expanded_data_set_config = parent_rpcs.delete_expanded_data_set if parent_rpcs.respond_to? :delete_expanded_data_set
|
10870
11435
|
@delete_expanded_data_set = ::Gapic::Config::Method.new delete_expanded_data_set_config
|
11436
|
+
get_channel_group_config = parent_rpcs.get_channel_group if parent_rpcs.respond_to? :get_channel_group
|
11437
|
+
@get_channel_group = ::Gapic::Config::Method.new get_channel_group_config
|
11438
|
+
list_channel_groups_config = parent_rpcs.list_channel_groups if parent_rpcs.respond_to? :list_channel_groups
|
11439
|
+
@list_channel_groups = ::Gapic::Config::Method.new list_channel_groups_config
|
11440
|
+
create_channel_group_config = parent_rpcs.create_channel_group if parent_rpcs.respond_to? :create_channel_group
|
11441
|
+
@create_channel_group = ::Gapic::Config::Method.new create_channel_group_config
|
11442
|
+
update_channel_group_config = parent_rpcs.update_channel_group if parent_rpcs.respond_to? :update_channel_group
|
11443
|
+
@update_channel_group = ::Gapic::Config::Method.new update_channel_group_config
|
11444
|
+
delete_channel_group_config = parent_rpcs.delete_channel_group if parent_rpcs.respond_to? :delete_channel_group
|
11445
|
+
@delete_channel_group = ::Gapic::Config::Method.new delete_channel_group_config
|
10871
11446
|
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
11447
|
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
10873
11448
|
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 +11461,8 @@ module Google
|
|
10886
11461
|
@delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
|
10887
11462
|
list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
|
10888
11463
|
@list_connected_site_tags = ::Gapic::Config::Method.new list_connected_site_tags_config
|
11464
|
+
fetch_connected_ga4_property_config = parent_rpcs.fetch_connected_ga4_property if parent_rpcs.respond_to? :fetch_connected_ga4_property
|
11465
|
+
@fetch_connected_ga4_property = ::Gapic::Config::Method.new fetch_connected_ga4_property_config
|
10889
11466
|
|
10890
11467
|
yield self if block_given?
|
10891
11468
|
end
|
@@ -125,6 +125,23 @@ module Google
|
|
125
125
|
"properties/#{property}/bigQueryLinks/#{bigquery_link}"
|
126
126
|
end
|
127
127
|
|
128
|
+
##
|
129
|
+
# Create a fully-qualified ChannelGroup resource string.
|
130
|
+
#
|
131
|
+
# The resource will be in the following format:
|
132
|
+
#
|
133
|
+
# `properties/{property}/channelGroups/{channel_group}`
|
134
|
+
#
|
135
|
+
# @param property [String]
|
136
|
+
# @param channel_group [String]
|
137
|
+
#
|
138
|
+
# @return [::String]
|
139
|
+
def channel_group_path property:, channel_group:
|
140
|
+
raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
|
141
|
+
|
142
|
+
"properties/#{property}/channelGroups/#{channel_group}"
|
143
|
+
end
|
144
|
+
|
128
145
|
##
|
129
146
|
# Create a fully-qualified ConversionEvent resource string.
|
130
147
|
#
|