google-analytics-admin-v1alpha 0.16.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/README.md +2 -2
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +68 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1266 -210
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +34 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +848 -17
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +682 -27
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +32 -0
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +74 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +25 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +217 -11
- 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 +93 -6
- data/proto_docs/google/api/client.rb +67 -4
- metadata +4 -2
@@ -125,6 +125,10 @@ module Google
|
|
125
125
|
|
126
126
|
default_config.rpcs.list_google_ads_links.timeout = 60.0
|
127
127
|
|
128
|
+
default_config.rpcs.get_enhanced_measurement_settings.timeout = 60.0
|
129
|
+
|
130
|
+
default_config.rpcs.update_enhanced_measurement_settings.timeout = 60.0
|
131
|
+
|
128
132
|
default_config
|
129
133
|
end
|
130
134
|
yield @configure if block_given?
|
@@ -600,7 +604,7 @@ module Google
|
|
600
604
|
# The account to create.
|
601
605
|
# @param redirect_uri [::String]
|
602
606
|
# Redirect URI where the user will be sent after accepting Terms of Service.
|
603
|
-
# Must be configured in
|
607
|
+
# Must be configured in Cloud Console as a Redirect URI.
|
604
608
|
#
|
605
609
|
# @yield [response, operation] Access the result along with the RPC operation
|
606
610
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse]
|
@@ -7799,9 +7803,14 @@ module Google
|
|
7799
7803
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
7800
7804
|
#
|
7801
7805
|
# @param entity [::String]
|
7802
|
-
# The Data Access Report
|
7803
|
-
#
|
7804
|
-
#
|
7806
|
+
# The Data Access Report supports requesting at the property level or account
|
7807
|
+
# level. If requested at the account level, Data Access Reports include all
|
7808
|
+
# access for all properties under that account.
|
7809
|
+
#
|
7810
|
+
# To request at the property level, entity should be for example
|
7811
|
+
# 'properties/123' if "123" is your GA4 property ID. To request at the
|
7812
|
+
# account level, entity should be for example 'accounts/1234' if "1234" is
|
7813
|
+
# your GA4 Account ID.
|
7805
7814
|
# @param dimensions [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension, ::Hash>]
|
7806
7815
|
# The dimensions requested and displayed in the response. Requests are
|
7807
7816
|
# allowed up to 9 dimensions.
|
@@ -7857,7 +7866,8 @@ module Google
|
|
7857
7866
|
# Specifies how rows are ordered in the response.
|
7858
7867
|
# @param return_entity_quota [::Boolean]
|
7859
7868
|
# Toggles whether to return the current state of this Analytics Property's
|
7860
|
-
# quota. Quota is returned in [AccessQuota](#AccessQuota).
|
7869
|
+
# quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level
|
7870
|
+
# requests, this field must be false.
|
7861
7871
|
#
|
7862
7872
|
# @yield [response, operation] Access the result along with the RPC operation
|
7863
7873
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
|
@@ -8586,8 +8596,9 @@ module Google
|
|
8586
8596
|
#
|
8587
8597
|
# @param parent [::String]
|
8588
8598
|
# Required. The account or property that owns the access bindings. The parent
|
8589
|
-
#
|
8590
|
-
# match this field.
|
8599
|
+
# of all provided AccessBinding in UpdateAccessBindingRequest messages must
|
8600
|
+
# match this field.
|
8601
|
+
# Formats:
|
8591
8602
|
# - accounts/\\{account}
|
8592
8603
|
# - properties/\\{property}
|
8593
8604
|
# @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::Hash>]
|
@@ -8678,8 +8689,8 @@ module Google
|
|
8678
8689
|
#
|
8679
8690
|
# @param parent [::String]
|
8680
8691
|
# Required. The account or property that owns the access bindings. The parent
|
8681
|
-
#
|
8682
|
-
# match this field. Formats:
|
8692
|
+
# of all provided values for the 'names' field in DeleteAccessBindingRequest
|
8693
|
+
# messages must match this field. Formats:
|
8683
8694
|
# - accounts/\\{account}
|
8684
8695
|
# - properties/\\{property}
|
8685
8696
|
# @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest, ::Hash>]
|
@@ -8769,7 +8780,7 @@ module Google
|
|
8769
8780
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
8770
8781
|
#
|
8771
8782
|
# @param name [::String]
|
8772
|
-
# Required. The name of the
|
8783
|
+
# Required. The name of the ExpandedDataSet to get.
|
8773
8784
|
# Example format: properties/1234/expandedDataSets/5678
|
8774
8785
|
#
|
8775
8786
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -9201,38 +9212,32 @@ module Google
|
|
9201
9212
|
end
|
9202
9213
|
|
9203
9214
|
##
|
9204
|
-
#
|
9205
|
-
# property.
|
9206
|
-
# Note: this has no effect on GA4 property.
|
9215
|
+
# Lookup for a single ChannelGroup.
|
9207
9216
|
#
|
9208
|
-
# @overload
|
9209
|
-
# Pass arguments to `
|
9210
|
-
# {::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.
|
9211
9220
|
#
|
9212
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9221
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest, ::Hash]
|
9213
9222
|
# A request object representing the call parameters. Required. To specify no
|
9214
9223
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9215
9224
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9216
9225
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9217
9226
|
#
|
9218
|
-
# @overload
|
9219
|
-
# Pass arguments to `
|
9227
|
+
# @overload get_channel_group(name: nil)
|
9228
|
+
# Pass arguments to `get_channel_group` via keyword arguments. Note that at
|
9220
9229
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9221
9230
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9222
9231
|
#
|
9223
|
-
# @param
|
9224
|
-
# Required. The
|
9225
|
-
#
|
9226
|
-
# Format: properties/\\{internalWebPropertyId}
|
9227
|
-
# Example: properties/1234
|
9228
|
-
# @param opt_out [::Boolean]
|
9229
|
-
# The status to set.
|
9232
|
+
# @param name [::String]
|
9233
|
+
# Required. The ChannelGroup to get.
|
9234
|
+
# Example format: properties/1234/channelGroups/5678
|
9230
9235
|
#
|
9231
9236
|
# @yield [response, operation] Access the result along with the RPC operation
|
9232
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
9237
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9233
9238
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9234
9239
|
#
|
9235
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
9240
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9236
9241
|
#
|
9237
9242
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9238
9243
|
#
|
@@ -9243,24 +9248,24 @@ module Google
|
|
9243
9248
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9244
9249
|
#
|
9245
9250
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9246
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9251
|
+
# request = Google::Analytics::Admin::V1alpha::GetChannelGroupRequest.new
|
9247
9252
|
#
|
9248
|
-
# # Call the
|
9249
|
-
# result = client.
|
9253
|
+
# # Call the get_channel_group method.
|
9254
|
+
# result = client.get_channel_group request
|
9250
9255
|
#
|
9251
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
9256
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9252
9257
|
# p result
|
9253
9258
|
#
|
9254
|
-
def
|
9259
|
+
def get_channel_group request, options = nil
|
9255
9260
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9256
9261
|
|
9257
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9262
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest
|
9258
9263
|
|
9259
9264
|
# Converts hash and nil to an options object
|
9260
9265
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9261
9266
|
|
9262
9267
|
# Customize the options with defaults
|
9263
|
-
metadata = @config.rpcs.
|
9268
|
+
metadata = @config.rpcs.get_channel_group.metadata.to_h
|
9264
9269
|
|
9265
9270
|
# Set x-goog-api-client and x-goog-user-project headers
|
9266
9271
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9268,15 +9273,23 @@ module Google
|
|
9268
9273
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9269
9274
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9270
9275
|
|
9271
|
-
|
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,
|
9272
9285
|
metadata: metadata,
|
9273
|
-
retry_policy: @config.rpcs.
|
9286
|
+
retry_policy: @config.rpcs.get_channel_group.retry_policy
|
9274
9287
|
|
9275
9288
|
options.apply_defaults timeout: @config.timeout,
|
9276
9289
|
metadata: @config.metadata,
|
9277
9290
|
retry_policy: @config.retry_policy
|
9278
9291
|
|
9279
|
-
@analytics_admin_service_stub.call_rpc :
|
9292
|
+
@analytics_admin_service_stub.call_rpc :get_channel_group, request, options: options do |response, operation|
|
9280
9293
|
yield response, operation if block_given?
|
9281
9294
|
return response
|
9282
9295
|
end
|
@@ -9285,36 +9298,42 @@ module Google
|
|
9285
9298
|
end
|
9286
9299
|
|
9287
9300
|
##
|
9288
|
-
#
|
9289
|
-
# property.
|
9290
|
-
# Note: this has no effect on GA4 property.
|
9301
|
+
# Lists ChannelGroups on a property.
|
9291
9302
|
#
|
9292
|
-
# @overload
|
9293
|
-
# Pass arguments to `
|
9294
|
-
# {::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.
|
9295
9306
|
#
|
9296
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9307
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest, ::Hash]
|
9297
9308
|
# A request object representing the call parameters. Required. To specify no
|
9298
9309
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9299
9310
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9300
9311
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9301
9312
|
#
|
9302
|
-
# @overload
|
9303
|
-
# 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
|
9304
9315
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9305
9316
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9306
9317
|
#
|
9307
|
-
# @param
|
9308
|
-
# Required. The
|
9309
|
-
#
|
9310
|
-
#
|
9311
|
-
#
|
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.
|
9312
9331
|
#
|
9313
9332
|
# @yield [response, operation] Access the result along with the RPC operation
|
9314
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
9333
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
9315
9334
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9316
9335
|
#
|
9317
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
9336
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
9318
9337
|
#
|
9319
9338
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9320
9339
|
#
|
@@ -9325,24 +9344,28 @@ module Google
|
|
9325
9344
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9326
9345
|
#
|
9327
9346
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9328
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9347
|
+
# request = Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest.new
|
9329
9348
|
#
|
9330
|
-
# # Call the
|
9331
|
-
# result = client.
|
9349
|
+
# # Call the list_channel_groups method.
|
9350
|
+
# result = client.list_channel_groups request
|
9332
9351
|
#
|
9333
|
-
# # The returned object is of type
|
9334
|
-
#
|
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
|
9335
9358
|
#
|
9336
|
-
def
|
9359
|
+
def list_channel_groups request, options = nil
|
9337
9360
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9338
9361
|
|
9339
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9362
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest
|
9340
9363
|
|
9341
9364
|
# Converts hash and nil to an options object
|
9342
9365
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9343
9366
|
|
9344
9367
|
# Customize the options with defaults
|
9345
|
-
metadata = @config.rpcs.
|
9368
|
+
metadata = @config.rpcs.list_channel_groups.metadata.to_h
|
9346
9369
|
|
9347
9370
|
# Set x-goog-api-client and x-goog-user-project headers
|
9348
9371
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9350,15 +9373,24 @@ module Google
|
|
9350
9373
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
9351
9374
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9352
9375
|
|
9353
|
-
|
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,
|
9354
9385
|
metadata: metadata,
|
9355
|
-
retry_policy: @config.rpcs.
|
9386
|
+
retry_policy: @config.rpcs.list_channel_groups.retry_policy
|
9356
9387
|
|
9357
9388
|
options.apply_defaults timeout: @config.timeout,
|
9358
9389
|
metadata: @config.metadata,
|
9359
9390
|
retry_policy: @config.retry_policy
|
9360
9391
|
|
9361
|
-
@analytics_admin_service_stub.call_rpc :
|
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
|
9362
9394
|
yield response, operation if block_given?
|
9363
9395
|
return response
|
9364
9396
|
end
|
@@ -9367,33 +9399,34 @@ module Google
|
|
9367
9399
|
end
|
9368
9400
|
|
9369
9401
|
##
|
9370
|
-
#
|
9402
|
+
# Creates a ChannelGroup.
|
9371
9403
|
#
|
9372
|
-
# @overload
|
9373
|
-
# Pass arguments to `
|
9374
|
-
# {::Google::Analytics::Admin::V1alpha::
|
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.
|
9375
9407
|
#
|
9376
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9408
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest, ::Hash]
|
9377
9409
|
# A request object representing the call parameters. Required. To specify no
|
9378
9410
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9379
9411
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9380
9412
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9381
9413
|
#
|
9382
|
-
# @overload
|
9383
|
-
# Pass arguments to `
|
9414
|
+
# @overload create_channel_group(parent: nil, channel_group: nil)
|
9415
|
+
# Pass arguments to `create_channel_group` via keyword arguments. Note that at
|
9384
9416
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9385
9417
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9386
9418
|
#
|
9387
|
-
# @param
|
9388
|
-
# Required. The
|
9389
|
-
#
|
9390
|
-
#
|
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.
|
9391
9424
|
#
|
9392
9425
|
# @yield [response, operation] Access the result along with the RPC operation
|
9393
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
9426
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9394
9427
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9395
9428
|
#
|
9396
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
9429
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9397
9430
|
#
|
9398
9431
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9399
9432
|
#
|
@@ -9404,24 +9437,24 @@ module Google
|
|
9404
9437
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9405
9438
|
#
|
9406
9439
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9407
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9440
|
+
# request = Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest.new
|
9408
9441
|
#
|
9409
|
-
# # Call the
|
9410
|
-
# result = client.
|
9442
|
+
# # Call the create_channel_group method.
|
9443
|
+
# result = client.create_channel_group request
|
9411
9444
|
#
|
9412
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
9445
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9413
9446
|
# p result
|
9414
9447
|
#
|
9415
|
-
def
|
9448
|
+
def create_channel_group request, options = nil
|
9416
9449
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9417
9450
|
|
9418
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9451
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest
|
9419
9452
|
|
9420
9453
|
# Converts hash and nil to an options object
|
9421
9454
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9422
9455
|
|
9423
9456
|
# Customize the options with defaults
|
9424
|
-
metadata = @config.rpcs.
|
9457
|
+
metadata = @config.rpcs.create_channel_group.metadata.to_h
|
9425
9458
|
|
9426
9459
|
# Set x-goog-api-client and x-goog-user-project headers
|
9427
9460
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9430,22 +9463,22 @@ module Google
|
|
9430
9463
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9431
9464
|
|
9432
9465
|
header_params = {}
|
9433
|
-
if request.
|
9434
|
-
header_params["
|
9466
|
+
if request.parent
|
9467
|
+
header_params["parent"] = request.parent
|
9435
9468
|
end
|
9436
9469
|
|
9437
9470
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9438
9471
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
9439
9472
|
|
9440
|
-
options.apply_defaults timeout: @config.rpcs.
|
9473
|
+
options.apply_defaults timeout: @config.rpcs.create_channel_group.timeout,
|
9441
9474
|
metadata: metadata,
|
9442
|
-
retry_policy: @config.rpcs.
|
9475
|
+
retry_policy: @config.rpcs.create_channel_group.retry_policy
|
9443
9476
|
|
9444
9477
|
options.apply_defaults timeout: @config.timeout,
|
9445
9478
|
metadata: @config.metadata,
|
9446
9479
|
retry_policy: @config.retry_policy
|
9447
9480
|
|
9448
|
-
@analytics_admin_service_stub.call_rpc :
|
9481
|
+
@analytics_admin_service_stub.call_rpc :create_channel_group, request, options: options do |response, operation|
|
9449
9482
|
yield response, operation if block_given?
|
9450
9483
|
return response
|
9451
9484
|
end
|
@@ -9454,43 +9487,38 @@ module Google
|
|
9454
9487
|
end
|
9455
9488
|
|
9456
9489
|
##
|
9457
|
-
#
|
9490
|
+
# Updates a ChannelGroup.
|
9458
9491
|
#
|
9459
|
-
# @overload
|
9460
|
-
# Pass arguments to `
|
9461
|
-
# {::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.
|
9462
9495
|
#
|
9463
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
9496
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest, ::Hash]
|
9464
9497
|
# A request object representing the call parameters. Required. To specify no
|
9465
9498
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9466
9499
|
# @param options [::Gapic::CallOptions, ::Hash]
|
9467
9500
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9468
9501
|
#
|
9469
|
-
# @overload
|
9470
|
-
# 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
|
9471
9504
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
9472
9505
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
9473
9506
|
#
|
9474
|
-
# @param
|
9475
|
-
# Required. The
|
9476
|
-
#
|
9477
|
-
#
|
9478
|
-
# @param
|
9479
|
-
# The
|
9480
|
-
#
|
9481
|
-
#
|
9482
|
-
#
|
9483
|
-
# @param page_token [::String]
|
9484
|
-
# A page token, received from a previous `ListBigQueryLinks` call.
|
9485
|
-
# Provide this to retrieve the subsequent page.
|
9486
|
-
# When paginating, all other parameters provided to `ListBigQueryLinks` must
|
9487
|
-
# match the call that provided the page token.
|
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.
|
9488
9516
|
#
|
9489
9517
|
# @yield [response, operation] Access the result along with the RPC operation
|
9490
|
-
# @yieldparam response [::
|
9518
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9491
9519
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9492
9520
|
#
|
9493
|
-
# @return [::
|
9521
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
9494
9522
|
#
|
9495
9523
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
9496
9524
|
#
|
@@ -9501,28 +9529,24 @@ module Google
|
|
9501
9529
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
9502
9530
|
#
|
9503
9531
|
# # Create a request. To set request fields, pass in keyword arguments.
|
9504
|
-
# request = Google::Analytics::Admin::V1alpha::
|
9532
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest.new
|
9505
9533
|
#
|
9506
|
-
# # Call the
|
9507
|
-
# result = client.
|
9534
|
+
# # Call the update_channel_group method.
|
9535
|
+
# result = client.update_channel_group request
|
9508
9536
|
#
|
9509
|
-
# # The returned object is of type
|
9510
|
-
#
|
9511
|
-
# result.each do |item|
|
9512
|
-
# # Each element is of type ::Google::Analytics::Admin::V1alpha::BigQueryLink.
|
9513
|
-
# p item
|
9514
|
-
# end
|
9537
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::ChannelGroup.
|
9538
|
+
# p result
|
9515
9539
|
#
|
9516
|
-
def
|
9540
|
+
def update_channel_group request, options = nil
|
9517
9541
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
9518
9542
|
|
9519
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
9543
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest
|
9520
9544
|
|
9521
9545
|
# Converts hash and nil to an options object
|
9522
9546
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
9523
9547
|
|
9524
9548
|
# Customize the options with defaults
|
9525
|
-
metadata = @config.rpcs.
|
9549
|
+
metadata = @config.rpcs.update_channel_group.metadata.to_h
|
9526
9550
|
|
9527
9551
|
# Set x-goog-api-client and x-goog-user-project headers
|
9528
9552
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -9531,23 +9555,22 @@ module Google
|
|
9531
9555
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
9532
9556
|
|
9533
9557
|
header_params = {}
|
9534
|
-
if request.
|
9535
|
-
header_params["
|
9558
|
+
if request.channel_group&.name
|
9559
|
+
header_params["channel_group.name"] = request.channel_group.name
|
9536
9560
|
end
|
9537
9561
|
|
9538
9562
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
9539
9563
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
9540
9564
|
|
9541
|
-
options.apply_defaults timeout: @config.rpcs.
|
9565
|
+
options.apply_defaults timeout: @config.rpcs.update_channel_group.timeout,
|
9542
9566
|
metadata: metadata,
|
9543
|
-
retry_policy: @config.rpcs.
|
9567
|
+
retry_policy: @config.rpcs.update_channel_group.retry_policy
|
9544
9568
|
|
9545
9569
|
options.apply_defaults timeout: @config.timeout,
|
9546
9570
|
metadata: @config.metadata,
|
9547
9571
|
retry_policy: @config.retry_policy
|
9548
9572
|
|
9549
|
-
@analytics_admin_service_stub.call_rpc :
|
9550
|
-
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_big_query_links, request, response, operation, options
|
9573
|
+
@analytics_admin_service_stub.call_rpc :update_channel_group, request, options: options do |response, operation|
|
9551
9574
|
yield response, operation if block_given?
|
9552
9575
|
return response
|
9553
9576
|
end
|
@@ -9556,92 +9579,1048 @@ module Google
|
|
9556
9579
|
end
|
9557
9580
|
|
9558
9581
|
##
|
9559
|
-
#
|
9582
|
+
# Deletes a ChannelGroup on a property.
|
9560
9583
|
#
|
9561
|
-
#
|
9562
|
-
#
|
9563
|
-
#
|
9564
|
-
# applied individually to specific RPCs. See
|
9565
|
-
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
9566
|
-
# for a list of RPCs that can be configured independently.
|
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.
|
9567
9587
|
#
|
9568
|
-
#
|
9569
|
-
#
|
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.
|
9570
9593
|
#
|
9571
|
-
# @
|
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).
|
9572
9598
|
#
|
9573
|
-
#
|
9574
|
-
#
|
9575
|
-
#
|
9576
|
-
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
9577
|
-
# config.timeout = 10.0
|
9578
|
-
# config.rpcs.get_account.timeout = 20.0
|
9579
|
-
# end
|
9599
|
+
# @param name [::String]
|
9600
|
+
# Required. The ChannelGroup to delete.
|
9601
|
+
# Example format: properties/1234/channelGroups/5678
|
9580
9602
|
#
|
9581
|
-
#
|
9582
|
-
#
|
9583
|
-
#
|
9584
|
-
# config.rpcs.get_account.timeout = 20.0
|
9585
|
-
# end
|
9603
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
9604
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
9605
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
9586
9606
|
#
|
9587
|
-
#
|
9588
|
-
# The hostname or hostname:port of the service endpoint.
|
9589
|
-
# Defaults to `"analyticsadmin.googleapis.com"`.
|
9590
|
-
# @return [::String]
|
9591
|
-
# @!attribute [rw] credentials
|
9592
|
-
# Credentials to send with calls. You may provide any of the following types:
|
9593
|
-
# * (`String`) The path to a service account key file in JSON format
|
9594
|
-
# * (`Hash`) A service account key as a Hash
|
9595
|
-
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
9596
|
-
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
9597
|
-
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
9598
|
-
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
9599
|
-
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
9600
|
-
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
9601
|
-
# * (`nil`) indicating no credentials
|
9602
|
-
# @return [::Object]
|
9603
|
-
# @!attribute [rw] scope
|
9604
|
-
# The OAuth scopes
|
9605
|
-
# @return [::Array<::String>]
|
9606
|
-
# @!attribute [rw] lib_name
|
9607
|
-
# The library name as recorded in instrumentation and logging
|
9608
|
-
# @return [::String]
|
9609
|
-
# @!attribute [rw] lib_version
|
9610
|
-
# The library version as recorded in instrumentation and logging
|
9611
|
-
# @return [::String]
|
9612
|
-
# @!attribute [rw] channel_args
|
9613
|
-
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
9614
|
-
# `GRPC::Core::Channel` object is provided as the credential.
|
9615
|
-
# @return [::Hash]
|
9616
|
-
# @!attribute [rw] interceptors
|
9617
|
-
# An array of interceptors that are run before calls are executed.
|
9618
|
-
# @return [::Array<::GRPC::ClientInterceptor>]
|
9619
|
-
# @!attribute [rw] timeout
|
9620
|
-
# The call timeout in seconds.
|
9621
|
-
# @return [::Numeric]
|
9622
|
-
# @!attribute [rw] metadata
|
9623
|
-
# Additional gRPC headers to be sent with the call.
|
9624
|
-
# @return [::Hash{::Symbol=>::String}]
|
9625
|
-
# @!attribute [rw] retry_policy
|
9626
|
-
# The retry policy. The value is a hash with the following keys:
|
9627
|
-
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
9628
|
-
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
9629
|
-
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
9630
|
-
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
9631
|
-
# trigger a retry.
|
9632
|
-
# @return [::Hash]
|
9633
|
-
# @!attribute [rw] quota_project
|
9634
|
-
# A separate project against which to charge quota.
|
9635
|
-
# @return [::String]
|
9607
|
+
# @return [::Google::Protobuf::Empty]
|
9636
9608
|
#
|
9637
|
-
|
9638
|
-
|
9639
|
-
|
9640
|
-
|
9641
|
-
|
9642
|
-
|
9643
|
-
|
9644
|
-
|
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
|
+
|
9667
|
+
##
|
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.
|
9671
|
+
#
|
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.
|
9675
|
+
#
|
9676
|
+
# @param request [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Hash]
|
9677
|
+
# A request object representing the call parameters. Required. To specify no
|
9678
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
9679
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
9680
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
9681
|
+
#
|
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)
|
9934
|
+
# Pass arguments to `list_big_query_links` via keyword arguments. Note that at
|
9935
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
9936
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
9937
|
+
#
|
9938
|
+
# @param parent [::String]
|
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
|
+
# Configuration class for the AnalyticsAdminService API.
|
10539
|
+
#
|
10540
|
+
# This class represents the configuration for AnalyticsAdminService,
|
10541
|
+
# providing control over timeouts, retry behavior, logging, transport
|
10542
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
10543
|
+
# applied individually to specific RPCs. See
|
10544
|
+
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
10545
|
+
# for a list of RPCs that can be configured independently.
|
10546
|
+
#
|
10547
|
+
# Configuration can be applied globally to all clients, or to a single client
|
10548
|
+
# on construction.
|
10549
|
+
#
|
10550
|
+
# @example
|
10551
|
+
#
|
10552
|
+
# # Modify the global config, setting the timeout for
|
10553
|
+
# # get_account to 20 seconds,
|
10554
|
+
# # and all remaining timeouts to 10 seconds.
|
10555
|
+
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
10556
|
+
# config.timeout = 10.0
|
10557
|
+
# config.rpcs.get_account.timeout = 20.0
|
10558
|
+
# end
|
10559
|
+
#
|
10560
|
+
# # Apply the above configuration only to a new client.
|
10561
|
+
# client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
|
10562
|
+
# config.timeout = 10.0
|
10563
|
+
# config.rpcs.get_account.timeout = 20.0
|
10564
|
+
# end
|
10565
|
+
#
|
10566
|
+
# @!attribute [rw] endpoint
|
10567
|
+
# The hostname or hostname:port of the service endpoint.
|
10568
|
+
# Defaults to `"analyticsadmin.googleapis.com"`.
|
10569
|
+
# @return [::String]
|
10570
|
+
# @!attribute [rw] credentials
|
10571
|
+
# Credentials to send with calls. You may provide any of the following types:
|
10572
|
+
# * (`String`) The path to a service account key file in JSON format
|
10573
|
+
# * (`Hash`) A service account key as a Hash
|
10574
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
10575
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
10576
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
10577
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
10578
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
10579
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
10580
|
+
# * (`nil`) indicating no credentials
|
10581
|
+
# @return [::Object]
|
10582
|
+
# @!attribute [rw] scope
|
10583
|
+
# The OAuth scopes
|
10584
|
+
# @return [::Array<::String>]
|
10585
|
+
# @!attribute [rw] lib_name
|
10586
|
+
# The library name as recorded in instrumentation and logging
|
10587
|
+
# @return [::String]
|
10588
|
+
# @!attribute [rw] lib_version
|
10589
|
+
# The library version as recorded in instrumentation and logging
|
10590
|
+
# @return [::String]
|
10591
|
+
# @!attribute [rw] channel_args
|
10592
|
+
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
10593
|
+
# `GRPC::Core::Channel` object is provided as the credential.
|
10594
|
+
# @return [::Hash]
|
10595
|
+
# @!attribute [rw] interceptors
|
10596
|
+
# An array of interceptors that are run before calls are executed.
|
10597
|
+
# @return [::Array<::GRPC::ClientInterceptor>]
|
10598
|
+
# @!attribute [rw] timeout
|
10599
|
+
# The call timeout in seconds.
|
10600
|
+
# @return [::Numeric]
|
10601
|
+
# @!attribute [rw] metadata
|
10602
|
+
# Additional gRPC headers to be sent with the call.
|
10603
|
+
# @return [::Hash{::Symbol=>::String}]
|
10604
|
+
# @!attribute [rw] retry_policy
|
10605
|
+
# The retry policy. The value is a hash with the following keys:
|
10606
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
10607
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
10608
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
10609
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
10610
|
+
# trigger a retry.
|
10611
|
+
# @return [::Hash]
|
10612
|
+
# @!attribute [rw] quota_project
|
10613
|
+
# A separate project against which to charge quota.
|
10614
|
+
# @return [::String]
|
10615
|
+
#
|
10616
|
+
class Configuration
|
10617
|
+
extend ::Gapic::Config
|
10618
|
+
|
10619
|
+
config_attr :endpoint, "analyticsadmin.googleapis.com", ::String
|
10620
|
+
config_attr :credentials, nil do |value|
|
10621
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
10622
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
10623
|
+
allowed.any? { |klass| klass === value }
|
9645
10624
|
end
|
9646
10625
|
config_attr :scope, nil, ::String, ::Array, nil
|
9647
10626
|
config_attr :lib_name, nil, ::String, nil
|
@@ -10181,6 +11160,31 @@ module Google
|
|
10181
11160
|
#
|
10182
11161
|
attr_reader :delete_expanded_data_set
|
10183
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
|
+
##
|
10184
11188
|
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
10185
11189
|
# @return [::Gapic::Config::Method]
|
10186
11190
|
#
|
@@ -10200,6 +11204,36 @@ module Google
|
|
10200
11204
|
# @return [::Gapic::Config::Method]
|
10201
11205
|
#
|
10202
11206
|
attr_reader :list_big_query_links
|
11207
|
+
##
|
11208
|
+
# RPC-specific configuration for `get_enhanced_measurement_settings`
|
11209
|
+
# @return [::Gapic::Config::Method]
|
11210
|
+
#
|
11211
|
+
attr_reader :get_enhanced_measurement_settings
|
11212
|
+
##
|
11213
|
+
# RPC-specific configuration for `update_enhanced_measurement_settings`
|
11214
|
+
# @return [::Gapic::Config::Method]
|
11215
|
+
#
|
11216
|
+
attr_reader :update_enhanced_measurement_settings
|
11217
|
+
##
|
11218
|
+
# RPC-specific configuration for `create_connected_site_tag`
|
11219
|
+
# @return [::Gapic::Config::Method]
|
11220
|
+
#
|
11221
|
+
attr_reader :create_connected_site_tag
|
11222
|
+
##
|
11223
|
+
# RPC-specific configuration for `delete_connected_site_tag`
|
11224
|
+
# @return [::Gapic::Config::Method]
|
11225
|
+
#
|
11226
|
+
attr_reader :delete_connected_site_tag
|
11227
|
+
##
|
11228
|
+
# RPC-specific configuration for `list_connected_site_tags`
|
11229
|
+
# @return [::Gapic::Config::Method]
|
11230
|
+
#
|
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
|
10203
11237
|
|
10204
11238
|
# @private
|
10205
11239
|
def initialize parent_rpcs = nil
|
@@ -10399,6 +11433,16 @@ module Google
|
|
10399
11433
|
@update_expanded_data_set = ::Gapic::Config::Method.new update_expanded_data_set_config
|
10400
11434
|
delete_expanded_data_set_config = parent_rpcs.delete_expanded_data_set if parent_rpcs.respond_to? :delete_expanded_data_set
|
10401
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
|
10402
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
|
10403
11447
|
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
10404
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
|
@@ -10407,6 +11451,18 @@ module Google
|
|
10407
11451
|
@get_big_query_link = ::Gapic::Config::Method.new get_big_query_link_config
|
10408
11452
|
list_big_query_links_config = parent_rpcs.list_big_query_links if parent_rpcs.respond_to? :list_big_query_links
|
10409
11453
|
@list_big_query_links = ::Gapic::Config::Method.new list_big_query_links_config
|
11454
|
+
get_enhanced_measurement_settings_config = parent_rpcs.get_enhanced_measurement_settings if parent_rpcs.respond_to? :get_enhanced_measurement_settings
|
11455
|
+
@get_enhanced_measurement_settings = ::Gapic::Config::Method.new get_enhanced_measurement_settings_config
|
11456
|
+
update_enhanced_measurement_settings_config = parent_rpcs.update_enhanced_measurement_settings if parent_rpcs.respond_to? :update_enhanced_measurement_settings
|
11457
|
+
@update_enhanced_measurement_settings = ::Gapic::Config::Method.new update_enhanced_measurement_settings_config
|
11458
|
+
create_connected_site_tag_config = parent_rpcs.create_connected_site_tag if parent_rpcs.respond_to? :create_connected_site_tag
|
11459
|
+
@create_connected_site_tag = ::Gapic::Config::Method.new create_connected_site_tag_config
|
11460
|
+
delete_connected_site_tag_config = parent_rpcs.delete_connected_site_tag if parent_rpcs.respond_to? :delete_connected_site_tag
|
11461
|
+
@delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
|
11462
|
+
list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
|
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
|
10410
11466
|
|
10411
11467
|
yield self if block_given?
|
10412
11468
|
end
|