google-analytics-admin-v1alpha 0.17.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +38 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +578 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +17 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +444 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +354 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +13 -0
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +74 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +3 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +112 -1
- data/proto_docs/google/analytics/admin/v1alpha/channel_group.rb +158 -0
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +9 -0
- data/proto_docs/google/api/client.rb +58 -1
- metadata +4 -2
@@ -6600,7 +6600,7 @@ module Google
|
|
6600
6600
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
6601
6601
|
#
|
6602
6602
|
# @param name [::String]
|
6603
|
-
# Required. The name of the
|
6603
|
+
# Required. The name of the ExpandedDataSet to get.
|
6604
6604
|
# Example format: properties/1234/expandedDataSets/5678
|
6605
6605
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
6606
6606
|
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
|
@@ -6912,6 +6912,340 @@ module Google
|
|
6912
6912
|
raise ::Google::Cloud::Error.from_error(e)
|
6913
6913
|
end
|
6914
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
|
+
|
6915
7249
|
##
|
6916
7250
|
# Sets the opt out status for the automated GA4 setup process for a UA
|
6917
7251
|
# property.
|
@@ -7529,6 +7863,73 @@ module Google
|
|
7529
7863
|
raise ::Google::Cloud::Error.from_error(e)
|
7530
7864
|
end
|
7531
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
|
+
|
7532
7933
|
##
|
7533
7934
|
# Configuration class for the AnalyticsAdminService REST API.
|
7534
7935
|
#
|
@@ -8143,6 +8544,31 @@ module Google
|
|
8143
8544
|
#
|
8144
8545
|
attr_reader :delete_expanded_data_set
|
8145
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
|
+
##
|
8146
8572
|
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
8147
8573
|
# @return [::Gapic::Config::Method]
|
8148
8574
|
#
|
@@ -8187,6 +8613,11 @@ module Google
|
|
8187
8613
|
# @return [::Gapic::Config::Method]
|
8188
8614
|
#
|
8189
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
|
8190
8621
|
|
8191
8622
|
# @private
|
8192
8623
|
def initialize parent_rpcs = nil
|
@@ -8386,6 +8817,16 @@ module Google
|
|
8386
8817
|
@update_expanded_data_set = ::Gapic::Config::Method.new update_expanded_data_set_config
|
8387
8818
|
delete_expanded_data_set_config = parent_rpcs.delete_expanded_data_set if parent_rpcs.respond_to? :delete_expanded_data_set
|
8388
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
|
8389
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
|
8390
8831
|
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
8391
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
|
@@ -8404,6 +8845,8 @@ module Google
|
|
8404
8845
|
@delete_connected_site_tag = ::Gapic::Config::Method.new delete_connected_site_tag_config
|
8405
8846
|
list_connected_site_tags_config = parent_rpcs.list_connected_site_tags if parent_rpcs.respond_to? :list_connected_site_tags
|
8406
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
|
8407
8850
|
|
8408
8851
|
yield self if block_given?
|
8409
8852
|
end
|