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
@@ -127,6 +127,10 @@ module Google
|
|
127
127
|
|
128
128
|
default_config.rpcs.list_google_ads_links.timeout = 60.0
|
129
129
|
|
130
|
+
default_config.rpcs.get_enhanced_measurement_settings.timeout = 60.0
|
131
|
+
|
132
|
+
default_config.rpcs.update_enhanced_measurement_settings.timeout = 60.0
|
133
|
+
|
130
134
|
default_config
|
131
135
|
end
|
132
136
|
yield @configure if block_given?
|
@@ -503,7 +507,7 @@ module Google
|
|
503
507
|
# The account to create.
|
504
508
|
# @param redirect_uri [::String]
|
505
509
|
# Redirect URI where the user will be sent after accepting Terms of Service.
|
506
|
-
# Must be configured in
|
510
|
+
# Must be configured in Cloud Console as a Redirect URI.
|
507
511
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
508
512
|
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse]
|
509
513
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -5853,9 +5857,14 @@ module Google
|
|
5853
5857
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
5854
5858
|
#
|
5855
5859
|
# @param entity [::String]
|
5856
|
-
# The Data Access Report
|
5857
|
-
#
|
5858
|
-
#
|
5860
|
+
# The Data Access Report supports requesting at the property level or account
|
5861
|
+
# level. If requested at the account level, Data Access Reports include all
|
5862
|
+
# access for all properties under that account.
|
5863
|
+
#
|
5864
|
+
# To request at the property level, entity should be for example
|
5865
|
+
# 'properties/123' if "123" is your GA4 property ID. To request at the
|
5866
|
+
# account level, entity should be for example 'accounts/1234' if "1234" is
|
5867
|
+
# your GA4 Account ID.
|
5859
5868
|
# @param dimensions [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension, ::Hash>]
|
5860
5869
|
# The dimensions requested and displayed in the response. Requests are
|
5861
5870
|
# allowed up to 9 dimensions.
|
@@ -5911,7 +5920,8 @@ module Google
|
|
5911
5920
|
# Specifies how rows are ordered in the response.
|
5912
5921
|
# @param return_entity_quota [::Boolean]
|
5913
5922
|
# Toggles whether to return the current state of this Analytics Property's
|
5914
|
-
# quota. Quota is returned in [AccessQuota](#AccessQuota).
|
5923
|
+
# quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level
|
5924
|
+
# requests, this field must be false.
|
5915
5925
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
5916
5926
|
# @yieldparam result [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
|
5917
5927
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -6452,8 +6462,9 @@ module Google
|
|
6452
6462
|
#
|
6453
6463
|
# @param parent [::String]
|
6454
6464
|
# Required. The account or property that owns the access bindings. The parent
|
6455
|
-
#
|
6456
|
-
# match this field.
|
6465
|
+
# of all provided AccessBinding in UpdateAccessBindingRequest messages must
|
6466
|
+
# match this field.
|
6467
|
+
# Formats:
|
6457
6468
|
# - accounts/\\{account}
|
6458
6469
|
# - properties/\\{property}
|
6459
6470
|
# @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::Hash>]
|
@@ -6521,8 +6532,8 @@ module Google
|
|
6521
6532
|
#
|
6522
6533
|
# @param parent [::String]
|
6523
6534
|
# Required. The account or property that owns the access bindings. The parent
|
6524
|
-
#
|
6525
|
-
# match this field. Formats:
|
6535
|
+
# of all provided values for the 'names' field in DeleteAccessBindingRequest
|
6536
|
+
# messages must match this field. Formats:
|
6526
6537
|
# - accounts/\\{account}
|
6527
6538
|
# - properties/\\{property}
|
6528
6539
|
# @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest, ::Hash>]
|
@@ -6589,7 +6600,7 @@ module Google
|
|
6589
6600
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
6590
6601
|
#
|
6591
6602
|
# @param name [::String]
|
6592
|
-
# Required. The name of the
|
6603
|
+
# Required. The name of the ExpandedDataSet to get.
|
6593
6604
|
# Example format: properties/1234/expandedDataSets/5678
|
6594
6605
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
6595
6606
|
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
|
@@ -6901,6 +6912,340 @@ module Google
|
|
6901
6912
|
raise ::Google::Cloud::Error.from_error(e)
|
6902
6913
|
end
|
6903
6914
|
|
6915
|
+
##
|
6916
|
+
# Lookup for a single ChannelGroup.
|
6917
|
+
#
|
6918
|
+
# @overload get_channel_group(request, options = nil)
|
6919
|
+
# Pass arguments to `get_channel_group` via a request object, either of type
|
6920
|
+
# {::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest} or an equivalent Hash.
|
6921
|
+
#
|
6922
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest, ::Hash]
|
6923
|
+
# A request object representing the call parameters. Required. To specify no
|
6924
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
6925
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
6926
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
6927
|
+
#
|
6928
|
+
# @overload get_channel_group(name: nil)
|
6929
|
+
# Pass arguments to `get_channel_group` via keyword arguments. Note that at
|
6930
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
6931
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
6932
|
+
#
|
6933
|
+
# @param name [::String]
|
6934
|
+
# Required. The ChannelGroup to get.
|
6935
|
+
# Example format: properties/1234/channelGroups/5678
|
6936
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
6937
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
6938
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
6939
|
+
#
|
6940
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
6941
|
+
#
|
6942
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
6943
|
+
def get_channel_group request, options = nil
|
6944
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
6945
|
+
|
6946
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest
|
6947
|
+
|
6948
|
+
# Converts hash and nil to an options object
|
6949
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
6950
|
+
|
6951
|
+
# Customize the options with defaults
|
6952
|
+
call_metadata = @config.rpcs.get_channel_group.metadata.to_h
|
6953
|
+
|
6954
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
6955
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
6956
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
6957
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
6958
|
+
transports_version_send: [:rest]
|
6959
|
+
|
6960
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
6961
|
+
|
6962
|
+
options.apply_defaults timeout: @config.rpcs.get_channel_group.timeout,
|
6963
|
+
metadata: call_metadata,
|
6964
|
+
retry_policy: @config.rpcs.get_channel_group.retry_policy
|
6965
|
+
|
6966
|
+
options.apply_defaults timeout: @config.timeout,
|
6967
|
+
metadata: @config.metadata,
|
6968
|
+
retry_policy: @config.retry_policy
|
6969
|
+
|
6970
|
+
@analytics_admin_service_stub.get_channel_group request, options do |result, operation|
|
6971
|
+
yield result, operation if block_given?
|
6972
|
+
return result
|
6973
|
+
end
|
6974
|
+
rescue ::Gapic::Rest::Error => e
|
6975
|
+
raise ::Google::Cloud::Error.from_error(e)
|
6976
|
+
end
|
6977
|
+
|
6978
|
+
##
|
6979
|
+
# Lists ChannelGroups on a property.
|
6980
|
+
#
|
6981
|
+
# @overload list_channel_groups(request, options = nil)
|
6982
|
+
# Pass arguments to `list_channel_groups` via a request object, either of type
|
6983
|
+
# {::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest} or an equivalent Hash.
|
6984
|
+
#
|
6985
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest, ::Hash]
|
6986
|
+
# A request object representing the call parameters. Required. To specify no
|
6987
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
6988
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
6989
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
6990
|
+
#
|
6991
|
+
# @overload list_channel_groups(parent: nil, page_size: nil, page_token: nil)
|
6992
|
+
# Pass arguments to `list_channel_groups` via keyword arguments. Note that at
|
6993
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
6994
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
6995
|
+
#
|
6996
|
+
# @param parent [::String]
|
6997
|
+
# Required. The property for which to list ChannelGroups.
|
6998
|
+
# Example format: properties/1234
|
6999
|
+
# @param page_size [::Integer]
|
7000
|
+
# The maximum number of resources to return.
|
7001
|
+
# If unspecified, at most 50 resources will be returned.
|
7002
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
7003
|
+
# @param page_token [::String]
|
7004
|
+
# A page token, received from a previous `ListChannelGroups` call. Provide
|
7005
|
+
# this to retrieve the subsequent page.
|
7006
|
+
#
|
7007
|
+
# When paginating, all other parameters provided to `ListChannelGroups`
|
7008
|
+
# must match the call that provided the page token.
|
7009
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7010
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
7011
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7012
|
+
#
|
7013
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>]
|
7014
|
+
#
|
7015
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7016
|
+
def list_channel_groups request, options = nil
|
7017
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7018
|
+
|
7019
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest
|
7020
|
+
|
7021
|
+
# Converts hash and nil to an options object
|
7022
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7023
|
+
|
7024
|
+
# Customize the options with defaults
|
7025
|
+
call_metadata = @config.rpcs.list_channel_groups.metadata.to_h
|
7026
|
+
|
7027
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7028
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7029
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7030
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7031
|
+
transports_version_send: [:rest]
|
7032
|
+
|
7033
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7034
|
+
|
7035
|
+
options.apply_defaults timeout: @config.rpcs.list_channel_groups.timeout,
|
7036
|
+
metadata: call_metadata,
|
7037
|
+
retry_policy: @config.rpcs.list_channel_groups.retry_policy
|
7038
|
+
|
7039
|
+
options.apply_defaults timeout: @config.timeout,
|
7040
|
+
metadata: @config.metadata,
|
7041
|
+
retry_policy: @config.retry_policy
|
7042
|
+
|
7043
|
+
@analytics_admin_service_stub.list_channel_groups request, options do |result, operation|
|
7044
|
+
result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_channel_groups, "channel_groups", request, result, options
|
7045
|
+
yield result, operation if block_given?
|
7046
|
+
return result
|
7047
|
+
end
|
7048
|
+
rescue ::Gapic::Rest::Error => e
|
7049
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7050
|
+
end
|
7051
|
+
|
7052
|
+
##
|
7053
|
+
# Creates a ChannelGroup.
|
7054
|
+
#
|
7055
|
+
# @overload create_channel_group(request, options = nil)
|
7056
|
+
# Pass arguments to `create_channel_group` via a request object, either of type
|
7057
|
+
# {::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest} or an equivalent Hash.
|
7058
|
+
#
|
7059
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest, ::Hash]
|
7060
|
+
# A request object representing the call parameters. Required. To specify no
|
7061
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7062
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7063
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7064
|
+
#
|
7065
|
+
# @overload create_channel_group(parent: nil, channel_group: nil)
|
7066
|
+
# Pass arguments to `create_channel_group` via keyword arguments. Note that at
|
7067
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7068
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7069
|
+
#
|
7070
|
+
# @param parent [::String]
|
7071
|
+
# Required. The property for which to create a ChannelGroup.
|
7072
|
+
# Example format: properties/1234
|
7073
|
+
# @param channel_group [::Google::Analytics::Admin::V1alpha::ChannelGroup, ::Hash]
|
7074
|
+
# Required. The ChannelGroup to create.
|
7075
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7076
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
7077
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7078
|
+
#
|
7079
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
7080
|
+
#
|
7081
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7082
|
+
def create_channel_group request, options = nil
|
7083
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7084
|
+
|
7085
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest
|
7086
|
+
|
7087
|
+
# Converts hash and nil to an options object
|
7088
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7089
|
+
|
7090
|
+
# Customize the options with defaults
|
7091
|
+
call_metadata = @config.rpcs.create_channel_group.metadata.to_h
|
7092
|
+
|
7093
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7094
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7095
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7096
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7097
|
+
transports_version_send: [:rest]
|
7098
|
+
|
7099
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7100
|
+
|
7101
|
+
options.apply_defaults timeout: @config.rpcs.create_channel_group.timeout,
|
7102
|
+
metadata: call_metadata,
|
7103
|
+
retry_policy: @config.rpcs.create_channel_group.retry_policy
|
7104
|
+
|
7105
|
+
options.apply_defaults timeout: @config.timeout,
|
7106
|
+
metadata: @config.metadata,
|
7107
|
+
retry_policy: @config.retry_policy
|
7108
|
+
|
7109
|
+
@analytics_admin_service_stub.create_channel_group request, options do |result, operation|
|
7110
|
+
yield result, operation if block_given?
|
7111
|
+
return result
|
7112
|
+
end
|
7113
|
+
rescue ::Gapic::Rest::Error => e
|
7114
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7115
|
+
end
|
7116
|
+
|
7117
|
+
##
|
7118
|
+
# Updates a ChannelGroup.
|
7119
|
+
#
|
7120
|
+
# @overload update_channel_group(request, options = nil)
|
7121
|
+
# Pass arguments to `update_channel_group` via a request object, either of type
|
7122
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest} or an equivalent Hash.
|
7123
|
+
#
|
7124
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest, ::Hash]
|
7125
|
+
# A request object representing the call parameters. Required. To specify no
|
7126
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7127
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7128
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7129
|
+
#
|
7130
|
+
# @overload update_channel_group(channel_group: nil, update_mask: nil)
|
7131
|
+
# Pass arguments to `update_channel_group` via keyword arguments. Note that at
|
7132
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7133
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7134
|
+
#
|
7135
|
+
# @param channel_group [::Google::Analytics::Admin::V1alpha::ChannelGroup, ::Hash]
|
7136
|
+
# Required. The ChannelGroup to update.
|
7137
|
+
# The resource's `name` field is used to identify the ChannelGroup to be
|
7138
|
+
# updated.
|
7139
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
7140
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
7141
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
7142
|
+
# replace the entire entity, use one path with the string "*" to match all
|
7143
|
+
# fields.
|
7144
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7145
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
7146
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7147
|
+
#
|
7148
|
+
# @return [::Google::Analytics::Admin::V1alpha::ChannelGroup]
|
7149
|
+
#
|
7150
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7151
|
+
def update_channel_group request, options = nil
|
7152
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7153
|
+
|
7154
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest
|
7155
|
+
|
7156
|
+
# Converts hash and nil to an options object
|
7157
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7158
|
+
|
7159
|
+
# Customize the options with defaults
|
7160
|
+
call_metadata = @config.rpcs.update_channel_group.metadata.to_h
|
7161
|
+
|
7162
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7163
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7164
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7165
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7166
|
+
transports_version_send: [:rest]
|
7167
|
+
|
7168
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7169
|
+
|
7170
|
+
options.apply_defaults timeout: @config.rpcs.update_channel_group.timeout,
|
7171
|
+
metadata: call_metadata,
|
7172
|
+
retry_policy: @config.rpcs.update_channel_group.retry_policy
|
7173
|
+
|
7174
|
+
options.apply_defaults timeout: @config.timeout,
|
7175
|
+
metadata: @config.metadata,
|
7176
|
+
retry_policy: @config.retry_policy
|
7177
|
+
|
7178
|
+
@analytics_admin_service_stub.update_channel_group request, options do |result, operation|
|
7179
|
+
yield result, operation if block_given?
|
7180
|
+
return result
|
7181
|
+
end
|
7182
|
+
rescue ::Gapic::Rest::Error => e
|
7183
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7184
|
+
end
|
7185
|
+
|
7186
|
+
##
|
7187
|
+
# Deletes a ChannelGroup on a property.
|
7188
|
+
#
|
7189
|
+
# @overload delete_channel_group(request, options = nil)
|
7190
|
+
# Pass arguments to `delete_channel_group` via a request object, either of type
|
7191
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest} or an equivalent Hash.
|
7192
|
+
#
|
7193
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest, ::Hash]
|
7194
|
+
# A request object representing the call parameters. Required. To specify no
|
7195
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7196
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7197
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7198
|
+
#
|
7199
|
+
# @overload delete_channel_group(name: nil)
|
7200
|
+
# Pass arguments to `delete_channel_group` via keyword arguments. Note that at
|
7201
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7202
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7203
|
+
#
|
7204
|
+
# @param name [::String]
|
7205
|
+
# Required. The ChannelGroup to delete.
|
7206
|
+
# Example format: properties/1234/channelGroups/5678
|
7207
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7208
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
7209
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7210
|
+
#
|
7211
|
+
# @return [::Google::Protobuf::Empty]
|
7212
|
+
#
|
7213
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7214
|
+
def delete_channel_group request, options = nil
|
7215
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7216
|
+
|
7217
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest
|
7218
|
+
|
7219
|
+
# Converts hash and nil to an options object
|
7220
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7221
|
+
|
7222
|
+
# Customize the options with defaults
|
7223
|
+
call_metadata = @config.rpcs.delete_channel_group.metadata.to_h
|
7224
|
+
|
7225
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7226
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7227
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7228
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7229
|
+
transports_version_send: [:rest]
|
7230
|
+
|
7231
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7232
|
+
|
7233
|
+
options.apply_defaults timeout: @config.rpcs.delete_channel_group.timeout,
|
7234
|
+
metadata: call_metadata,
|
7235
|
+
retry_policy: @config.rpcs.delete_channel_group.retry_policy
|
7236
|
+
|
7237
|
+
options.apply_defaults timeout: @config.timeout,
|
7238
|
+
metadata: @config.metadata,
|
7239
|
+
retry_policy: @config.retry_policy
|
7240
|
+
|
7241
|
+
@analytics_admin_service_stub.delete_channel_group request, options do |result, operation|
|
7242
|
+
yield result, operation if block_given?
|
7243
|
+
return result
|
7244
|
+
end
|
7245
|
+
rescue ::Gapic::Rest::Error => e
|
7246
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7247
|
+
end
|
7248
|
+
|
6904
7249
|
##
|
6905
7250
|
# Sets the opt out status for the automated GA4 setup process for a UA
|
6906
7251
|
# property.
|
@@ -7177,12 +7522,421 @@ module Google
|
|
7177
7522
|
end
|
7178
7523
|
|
7179
7524
|
##
|
7180
|
-
#
|
7525
|
+
# Returns the enhanced measurement settings for this data stream.
|
7526
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
7527
|
+
# take effect.
|
7181
7528
|
#
|
7182
|
-
#
|
7183
|
-
#
|
7184
|
-
#
|
7185
|
-
#
|
7529
|
+
# @overload get_enhanced_measurement_settings(request, options = nil)
|
7530
|
+
# Pass arguments to `get_enhanced_measurement_settings` via a request object, either of type
|
7531
|
+
# {::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest} or an equivalent Hash.
|
7532
|
+
#
|
7533
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Hash]
|
7534
|
+
# A request object representing the call parameters. Required. To specify no
|
7535
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7536
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7537
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7538
|
+
#
|
7539
|
+
# @overload get_enhanced_measurement_settings(name: nil)
|
7540
|
+
# Pass arguments to `get_enhanced_measurement_settings` via keyword arguments. Note that at
|
7541
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7542
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7543
|
+
#
|
7544
|
+
# @param name [::String]
|
7545
|
+
# Required. The name of the settings to lookup.
|
7546
|
+
# Format:
|
7547
|
+
# properties/\\{property}/dataStreams/\\{data_stream}/enhancedMeasurementSettings
|
7548
|
+
# Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
7549
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7550
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
7551
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7552
|
+
#
|
7553
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
7554
|
+
#
|
7555
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7556
|
+
def get_enhanced_measurement_settings request, options = nil
|
7557
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7558
|
+
|
7559
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest
|
7560
|
+
|
7561
|
+
# Converts hash and nil to an options object
|
7562
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7563
|
+
|
7564
|
+
# Customize the options with defaults
|
7565
|
+
call_metadata = @config.rpcs.get_enhanced_measurement_settings.metadata.to_h
|
7566
|
+
|
7567
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7568
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7569
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7570
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7571
|
+
transports_version_send: [:rest]
|
7572
|
+
|
7573
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7574
|
+
|
7575
|
+
options.apply_defaults timeout: @config.rpcs.get_enhanced_measurement_settings.timeout,
|
7576
|
+
metadata: call_metadata,
|
7577
|
+
retry_policy: @config.rpcs.get_enhanced_measurement_settings.retry_policy
|
7578
|
+
|
7579
|
+
options.apply_defaults timeout: @config.timeout,
|
7580
|
+
metadata: @config.metadata,
|
7581
|
+
retry_policy: @config.retry_policy
|
7582
|
+
|
7583
|
+
@analytics_admin_service_stub.get_enhanced_measurement_settings request, options do |result, operation|
|
7584
|
+
yield result, operation if block_given?
|
7585
|
+
return result
|
7586
|
+
end
|
7587
|
+
rescue ::Gapic::Rest::Error => e
|
7588
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7589
|
+
end
|
7590
|
+
|
7591
|
+
##
|
7592
|
+
# Updates the enhanced measurement settings for this data stream.
|
7593
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
7594
|
+
# take effect.
|
7595
|
+
#
|
7596
|
+
# @overload update_enhanced_measurement_settings(request, options = nil)
|
7597
|
+
# Pass arguments to `update_enhanced_measurement_settings` via a request object, either of type
|
7598
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest} or an equivalent Hash.
|
7599
|
+
#
|
7600
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Hash]
|
7601
|
+
# A request object representing the call parameters. Required. To specify no
|
7602
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7603
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7604
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7605
|
+
#
|
7606
|
+
# @overload update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil)
|
7607
|
+
# Pass arguments to `update_enhanced_measurement_settings` via keyword arguments. Note that at
|
7608
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7609
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7610
|
+
#
|
7611
|
+
# @param enhanced_measurement_settings [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings, ::Hash]
|
7612
|
+
# Required. The settings to update.
|
7613
|
+
# The `name` field is used to identify the settings to be updated.
|
7614
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
7615
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
7616
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
7617
|
+
# replace the entire entity, use one path with the string "*" to match all
|
7618
|
+
# fields.
|
7619
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7620
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
7621
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7622
|
+
#
|
7623
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
7624
|
+
#
|
7625
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7626
|
+
def update_enhanced_measurement_settings request, options = nil
|
7627
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7628
|
+
|
7629
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest
|
7630
|
+
|
7631
|
+
# Converts hash and nil to an options object
|
7632
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7633
|
+
|
7634
|
+
# Customize the options with defaults
|
7635
|
+
call_metadata = @config.rpcs.update_enhanced_measurement_settings.metadata.to_h
|
7636
|
+
|
7637
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7638
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7639
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7640
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7641
|
+
transports_version_send: [:rest]
|
7642
|
+
|
7643
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7644
|
+
|
7645
|
+
options.apply_defaults timeout: @config.rpcs.update_enhanced_measurement_settings.timeout,
|
7646
|
+
metadata: call_metadata,
|
7647
|
+
retry_policy: @config.rpcs.update_enhanced_measurement_settings.retry_policy
|
7648
|
+
|
7649
|
+
options.apply_defaults timeout: @config.timeout,
|
7650
|
+
metadata: @config.metadata,
|
7651
|
+
retry_policy: @config.retry_policy
|
7652
|
+
|
7653
|
+
@analytics_admin_service_stub.update_enhanced_measurement_settings request, options do |result, operation|
|
7654
|
+
yield result, operation if block_given?
|
7655
|
+
return result
|
7656
|
+
end
|
7657
|
+
rescue ::Gapic::Rest::Error => e
|
7658
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7659
|
+
end
|
7660
|
+
|
7661
|
+
##
|
7662
|
+
# Creates a connected site tag for a Universal Analytics property. You can
|
7663
|
+
# create a maximum of 20 connected site tags per property.
|
7664
|
+
# Note: This API cannot be used on GA4 properties.
|
7665
|
+
#
|
7666
|
+
# @overload create_connected_site_tag(request, options = nil)
|
7667
|
+
# Pass arguments to `create_connected_site_tag` via a request object, either of type
|
7668
|
+
# {::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest} or an equivalent Hash.
|
7669
|
+
#
|
7670
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::Hash]
|
7671
|
+
# A request object representing the call parameters. Required. To specify no
|
7672
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7673
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7674
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7675
|
+
#
|
7676
|
+
# @overload create_connected_site_tag(property: nil, connected_site_tag: nil)
|
7677
|
+
# Pass arguments to `create_connected_site_tag` via keyword arguments. Note that at
|
7678
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7679
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7680
|
+
#
|
7681
|
+
# @param property [::String]
|
7682
|
+
# The Universal Analytics property to create connected site tags for.
|
7683
|
+
# This API does not support GA4 properties.
|
7684
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
7685
|
+
# Example: properties/1234
|
7686
|
+
# @param connected_site_tag [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag, ::Hash]
|
7687
|
+
# Required. The tag to add to the Universal Analytics property
|
7688
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7689
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
|
7690
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7691
|
+
#
|
7692
|
+
# @return [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
|
7693
|
+
#
|
7694
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7695
|
+
def create_connected_site_tag request, options = nil
|
7696
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7697
|
+
|
7698
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest
|
7699
|
+
|
7700
|
+
# Converts hash and nil to an options object
|
7701
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7702
|
+
|
7703
|
+
# Customize the options with defaults
|
7704
|
+
call_metadata = @config.rpcs.create_connected_site_tag.metadata.to_h
|
7705
|
+
|
7706
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7707
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7708
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7709
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7710
|
+
transports_version_send: [:rest]
|
7711
|
+
|
7712
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7713
|
+
|
7714
|
+
options.apply_defaults timeout: @config.rpcs.create_connected_site_tag.timeout,
|
7715
|
+
metadata: call_metadata,
|
7716
|
+
retry_policy: @config.rpcs.create_connected_site_tag.retry_policy
|
7717
|
+
|
7718
|
+
options.apply_defaults timeout: @config.timeout,
|
7719
|
+
metadata: @config.metadata,
|
7720
|
+
retry_policy: @config.retry_policy
|
7721
|
+
|
7722
|
+
@analytics_admin_service_stub.create_connected_site_tag request, options do |result, operation|
|
7723
|
+
yield result, operation if block_given?
|
7724
|
+
return result
|
7725
|
+
end
|
7726
|
+
rescue ::Gapic::Rest::Error => e
|
7727
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7728
|
+
end
|
7729
|
+
|
7730
|
+
##
|
7731
|
+
# Deletes a connected site tag for a Universal Analytics property.
|
7732
|
+
# Note: this has no effect on GA4 properties.
|
7733
|
+
#
|
7734
|
+
# @overload delete_connected_site_tag(request, options = nil)
|
7735
|
+
# Pass arguments to `delete_connected_site_tag` via a request object, either of type
|
7736
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest} or an equivalent Hash.
|
7737
|
+
#
|
7738
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::Hash]
|
7739
|
+
# A request object representing the call parameters. Required. To specify no
|
7740
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7741
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7742
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7743
|
+
#
|
7744
|
+
# @overload delete_connected_site_tag(property: nil, tag_id: nil)
|
7745
|
+
# Pass arguments to `delete_connected_site_tag` via keyword arguments. Note that at
|
7746
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7747
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7748
|
+
#
|
7749
|
+
# @param property [::String]
|
7750
|
+
# The Universal Analytics property to delete connected site tags for.
|
7751
|
+
# This API does not support GA4 properties.
|
7752
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
7753
|
+
# Example: properties/1234
|
7754
|
+
# @param tag_id [::String]
|
7755
|
+
# Tag ID to forward events to. Also known as the Measurement ID, or the
|
7756
|
+
# "G-ID" (For example: G-12345).
|
7757
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7758
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
7759
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7760
|
+
#
|
7761
|
+
# @return [::Google::Protobuf::Empty]
|
7762
|
+
#
|
7763
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7764
|
+
def delete_connected_site_tag request, options = nil
|
7765
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7766
|
+
|
7767
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest
|
7768
|
+
|
7769
|
+
# Converts hash and nil to an options object
|
7770
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7771
|
+
|
7772
|
+
# Customize the options with defaults
|
7773
|
+
call_metadata = @config.rpcs.delete_connected_site_tag.metadata.to_h
|
7774
|
+
|
7775
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7776
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7777
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7778
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7779
|
+
transports_version_send: [:rest]
|
7780
|
+
|
7781
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7782
|
+
|
7783
|
+
options.apply_defaults timeout: @config.rpcs.delete_connected_site_tag.timeout,
|
7784
|
+
metadata: call_metadata,
|
7785
|
+
retry_policy: @config.rpcs.delete_connected_site_tag.retry_policy
|
7786
|
+
|
7787
|
+
options.apply_defaults timeout: @config.timeout,
|
7788
|
+
metadata: @config.metadata,
|
7789
|
+
retry_policy: @config.retry_policy
|
7790
|
+
|
7791
|
+
@analytics_admin_service_stub.delete_connected_site_tag request, options do |result, operation|
|
7792
|
+
yield result, operation if block_given?
|
7793
|
+
return result
|
7794
|
+
end
|
7795
|
+
rescue ::Gapic::Rest::Error => e
|
7796
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7797
|
+
end
|
7798
|
+
|
7799
|
+
##
|
7800
|
+
# Lists the connected site tags for a Universal Analytics property. A maximum
|
7801
|
+
# of 20 connected site tags will be returned. Note: this has no effect on GA4
|
7802
|
+
# property.
|
7803
|
+
#
|
7804
|
+
# @overload list_connected_site_tags(request, options = nil)
|
7805
|
+
# Pass arguments to `list_connected_site_tags` via a request object, either of type
|
7806
|
+
# {::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest} or an equivalent Hash.
|
7807
|
+
#
|
7808
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::Hash]
|
7809
|
+
# A request object representing the call parameters. Required. To specify no
|
7810
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7811
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7812
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7813
|
+
#
|
7814
|
+
# @overload list_connected_site_tags(property: nil)
|
7815
|
+
# Pass arguments to `list_connected_site_tags` via keyword arguments. Note that at
|
7816
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7817
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7818
|
+
#
|
7819
|
+
# @param property [::String]
|
7820
|
+
# The Universal Analytics property to fetch connected site tags for.
|
7821
|
+
# This does not work on GA4 properties. A maximum of 20 connected site tags
|
7822
|
+
# will be returned.
|
7823
|
+
# Example Format: `properties/1234`
|
7824
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7825
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
|
7826
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7827
|
+
#
|
7828
|
+
# @return [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
|
7829
|
+
#
|
7830
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7831
|
+
def list_connected_site_tags request, options = nil
|
7832
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7833
|
+
|
7834
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest
|
7835
|
+
|
7836
|
+
# Converts hash and nil to an options object
|
7837
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7838
|
+
|
7839
|
+
# Customize the options with defaults
|
7840
|
+
call_metadata = @config.rpcs.list_connected_site_tags.metadata.to_h
|
7841
|
+
|
7842
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7843
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7844
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7845
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7846
|
+
transports_version_send: [:rest]
|
7847
|
+
|
7848
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7849
|
+
|
7850
|
+
options.apply_defaults timeout: @config.rpcs.list_connected_site_tags.timeout,
|
7851
|
+
metadata: call_metadata,
|
7852
|
+
retry_policy: @config.rpcs.list_connected_site_tags.retry_policy
|
7853
|
+
|
7854
|
+
options.apply_defaults timeout: @config.timeout,
|
7855
|
+
metadata: @config.metadata,
|
7856
|
+
retry_policy: @config.retry_policy
|
7857
|
+
|
7858
|
+
@analytics_admin_service_stub.list_connected_site_tags request, options do |result, operation|
|
7859
|
+
yield result, operation if block_given?
|
7860
|
+
return result
|
7861
|
+
end
|
7862
|
+
rescue ::Gapic::Rest::Error => e
|
7863
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7864
|
+
end
|
7865
|
+
|
7866
|
+
##
|
7867
|
+
# Given a specified UA property, looks up the GA4 property connected to it.
|
7868
|
+
# Note: this cannot be used with GA4 properties.
|
7869
|
+
#
|
7870
|
+
# @overload fetch_connected_ga4_property(request, options = nil)
|
7871
|
+
# Pass arguments to `fetch_connected_ga4_property` via a request object, either of type
|
7872
|
+
# {::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest} or an equivalent Hash.
|
7873
|
+
#
|
7874
|
+
# @param request [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest, ::Hash]
|
7875
|
+
# A request object representing the call parameters. Required. To specify no
|
7876
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7877
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7878
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7879
|
+
#
|
7880
|
+
# @overload fetch_connected_ga4_property(property: nil)
|
7881
|
+
# Pass arguments to `fetch_connected_ga4_property` via keyword arguments. Note that at
|
7882
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7883
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7884
|
+
#
|
7885
|
+
# @param property [::String]
|
7886
|
+
# Required. The UA property for which to look up the connected GA4 property.
|
7887
|
+
# Note this request uses the
|
7888
|
+
# internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
7889
|
+
# Format: properties/\\{internal_web_property_id}
|
7890
|
+
# Example: properties/1234
|
7891
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7892
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
|
7893
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7894
|
+
#
|
7895
|
+
# @return [::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse]
|
7896
|
+
#
|
7897
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7898
|
+
def fetch_connected_ga4_property request, options = nil
|
7899
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7900
|
+
|
7901
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest
|
7902
|
+
|
7903
|
+
# Converts hash and nil to an options object
|
7904
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7905
|
+
|
7906
|
+
# Customize the options with defaults
|
7907
|
+
call_metadata = @config.rpcs.fetch_connected_ga4_property.metadata.to_h
|
7908
|
+
|
7909
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7910
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7911
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7912
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7913
|
+
transports_version_send: [:rest]
|
7914
|
+
|
7915
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7916
|
+
|
7917
|
+
options.apply_defaults timeout: @config.rpcs.fetch_connected_ga4_property.timeout,
|
7918
|
+
metadata: call_metadata,
|
7919
|
+
retry_policy: @config.rpcs.fetch_connected_ga4_property.retry_policy
|
7920
|
+
|
7921
|
+
options.apply_defaults timeout: @config.timeout,
|
7922
|
+
metadata: @config.metadata,
|
7923
|
+
retry_policy: @config.retry_policy
|
7924
|
+
|
7925
|
+
@analytics_admin_service_stub.fetch_connected_ga4_property request, options do |result, operation|
|
7926
|
+
yield result, operation if block_given?
|
7927
|
+
return result
|
7928
|
+
end
|
7929
|
+
rescue ::Gapic::Rest::Error => e
|
7930
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7931
|
+
end
|
7932
|
+
|
7933
|
+
##
|
7934
|
+
# Configuration class for the AnalyticsAdminService REST API.
|
7935
|
+
#
|
7936
|
+
# This class represents the configuration for AnalyticsAdminService REST,
|
7937
|
+
# providing control over timeouts, retry behavior, logging, transport
|
7938
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
7939
|
+
# applied individually to specific RPCs. See
|
7186
7940
|
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::Client::Configuration::Rpcs}
|
7187
7941
|
# for a list of RPCs that can be configured independently.
|
7188
7942
|
#
|
@@ -7214,9 +7968,9 @@ module Google
|
|
7214
7968
|
# * (`String`) The path to a service account key file in JSON format
|
7215
7969
|
# * (`Hash`) A service account key as a Hash
|
7216
7970
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
7217
|
-
# (see the [googleauth docs](https://
|
7971
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
7218
7972
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
7219
|
-
# (see the [signet docs](https://
|
7973
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
7220
7974
|
# * (`nil`) indicating no credentials
|
7221
7975
|
# @return [::Object]
|
7222
7976
|
# @!attribute [rw] scope
|
@@ -7790,6 +8544,31 @@ module Google
|
|
7790
8544
|
#
|
7791
8545
|
attr_reader :delete_expanded_data_set
|
7792
8546
|
##
|
8547
|
+
# RPC-specific configuration for `get_channel_group`
|
8548
|
+
# @return [::Gapic::Config::Method]
|
8549
|
+
#
|
8550
|
+
attr_reader :get_channel_group
|
8551
|
+
##
|
8552
|
+
# RPC-specific configuration for `list_channel_groups`
|
8553
|
+
# @return [::Gapic::Config::Method]
|
8554
|
+
#
|
8555
|
+
attr_reader :list_channel_groups
|
8556
|
+
##
|
8557
|
+
# RPC-specific configuration for `create_channel_group`
|
8558
|
+
# @return [::Gapic::Config::Method]
|
8559
|
+
#
|
8560
|
+
attr_reader :create_channel_group
|
8561
|
+
##
|
8562
|
+
# RPC-specific configuration for `update_channel_group`
|
8563
|
+
# @return [::Gapic::Config::Method]
|
8564
|
+
#
|
8565
|
+
attr_reader :update_channel_group
|
8566
|
+
##
|
8567
|
+
# RPC-specific configuration for `delete_channel_group`
|
8568
|
+
# @return [::Gapic::Config::Method]
|
8569
|
+
#
|
8570
|
+
attr_reader :delete_channel_group
|
8571
|
+
##
|
7793
8572
|
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
7794
8573
|
# @return [::Gapic::Config::Method]
|
7795
8574
|
#
|
@@ -7809,6 +8588,36 @@ module Google
|
|
7809
8588
|
# @return [::Gapic::Config::Method]
|
7810
8589
|
#
|
7811
8590
|
attr_reader :list_big_query_links
|
8591
|
+
##
|
8592
|
+
# RPC-specific configuration for `get_enhanced_measurement_settings`
|
8593
|
+
# @return [::Gapic::Config::Method]
|
8594
|
+
#
|
8595
|
+
attr_reader :get_enhanced_measurement_settings
|
8596
|
+
##
|
8597
|
+
# RPC-specific configuration for `update_enhanced_measurement_settings`
|
8598
|
+
# @return [::Gapic::Config::Method]
|
8599
|
+
#
|
8600
|
+
attr_reader :update_enhanced_measurement_settings
|
8601
|
+
##
|
8602
|
+
# RPC-specific configuration for `create_connected_site_tag`
|
8603
|
+
# @return [::Gapic::Config::Method]
|
8604
|
+
#
|
8605
|
+
attr_reader :create_connected_site_tag
|
8606
|
+
##
|
8607
|
+
# RPC-specific configuration for `delete_connected_site_tag`
|
8608
|
+
# @return [::Gapic::Config::Method]
|
8609
|
+
#
|
8610
|
+
attr_reader :delete_connected_site_tag
|
8611
|
+
##
|
8612
|
+
# RPC-specific configuration for `list_connected_site_tags`
|
8613
|
+
# @return [::Gapic::Config::Method]
|
8614
|
+
#
|
8615
|
+
attr_reader :list_connected_site_tags
|
8616
|
+
##
|
8617
|
+
# RPC-specific configuration for `fetch_connected_ga4_property`
|
8618
|
+
# @return [::Gapic::Config::Method]
|
8619
|
+
#
|
8620
|
+
attr_reader :fetch_connected_ga4_property
|
7812
8621
|
|
7813
8622
|
# @private
|
7814
8623
|
def initialize parent_rpcs = nil
|
@@ -8008,6 +8817,16 @@ module Google
|
|
8008
8817
|
@update_expanded_data_set = ::Gapic::Config::Method.new update_expanded_data_set_config
|
8009
8818
|
delete_expanded_data_set_config = parent_rpcs.delete_expanded_data_set if parent_rpcs.respond_to? :delete_expanded_data_set
|
8010
8819
|
@delete_expanded_data_set = ::Gapic::Config::Method.new delete_expanded_data_set_config
|
8820
|
+
get_channel_group_config = parent_rpcs.get_channel_group if parent_rpcs.respond_to? :get_channel_group
|
8821
|
+
@get_channel_group = ::Gapic::Config::Method.new get_channel_group_config
|
8822
|
+
list_channel_groups_config = parent_rpcs.list_channel_groups if parent_rpcs.respond_to? :list_channel_groups
|
8823
|
+
@list_channel_groups = ::Gapic::Config::Method.new list_channel_groups_config
|
8824
|
+
create_channel_group_config = parent_rpcs.create_channel_group if parent_rpcs.respond_to? :create_channel_group
|
8825
|
+
@create_channel_group = ::Gapic::Config::Method.new create_channel_group_config
|
8826
|
+
update_channel_group_config = parent_rpcs.update_channel_group if parent_rpcs.respond_to? :update_channel_group
|
8827
|
+
@update_channel_group = ::Gapic::Config::Method.new update_channel_group_config
|
8828
|
+
delete_channel_group_config = parent_rpcs.delete_channel_group if parent_rpcs.respond_to? :delete_channel_group
|
8829
|
+
@delete_channel_group = ::Gapic::Config::Method.new delete_channel_group_config
|
8011
8830
|
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
|
8012
8831
|
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
8013
8832
|
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
|
@@ -8016,6 +8835,18 @@ module Google
|
|
8016
8835
|
@get_big_query_link = ::Gapic::Config::Method.new get_big_query_link_config
|
8017
8836
|
list_big_query_links_config = parent_rpcs.list_big_query_links if parent_rpcs.respond_to? :list_big_query_links
|
8018
8837
|
@list_big_query_links = ::Gapic::Config::Method.new list_big_query_links_config
|
8838
|
+
get_enhanced_measurement_settings_config = parent_rpcs.get_enhanced_measurement_settings if parent_rpcs.respond_to? :get_enhanced_measurement_settings
|
8839
|
+
@get_enhanced_measurement_settings = ::Gapic::Config::Method.new get_enhanced_measurement_settings_config
|
8840
|
+
update_enhanced_measurement_settings_config = parent_rpcs.update_enhanced_measurement_settings if parent_rpcs.respond_to? :update_enhanced_measurement_settings
|
8841
|
+
@update_enhanced_measurement_settings = ::Gapic::Config::Method.new update_enhanced_measurement_settings_config
|
8842
|
+
create_connected_site_tag_config = parent_rpcs.create_connected_site_tag if parent_rpcs.respond_to? :create_connected_site_tag
|
8843
|
+
@create_connected_site_tag = ::Gapic::Config::Method.new create_connected_site_tag_config
|
8844
|
+
delete_connected_site_tag_config = parent_rpcs.delete_connected_site_tag if parent_rpcs.respond_to? :delete_connected_site_tag
|
8845
|
+
@delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
|
8846
|
+
list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
|
8847
|
+
@list_connected_site_tags = ::Gapic::Config::Method.new list_connected_site_tags_config
|
8848
|
+
fetch_connected_ga4_property_config = parent_rpcs.fetch_connected_ga4_property if parent_rpcs.respond_to? :fetch_connected_ga4_property
|
8849
|
+
@fetch_connected_ga4_property = ::Gapic::Config::Method.new fetch_connected_ga4_property_config
|
8019
8850
|
|
8020
8851
|
yield self if block_given?
|
8021
8852
|
end
|