google-analytics-admin-v1alpha 0.18.0 → 0.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/analytics/admin/v1alpha/access_report_pb.rb +24 -118
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +44 -574
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +883 -2
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +36 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/client.rb +668 -2
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +647 -113
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +18 -0
- data/lib/google/analytics/admin/v1alpha/audience_pb.rb +25 -122
- data/lib/google/analytics/admin/v1alpha/channel_group_pb.rb +24 -46
- data/lib/google/analytics/admin/v1alpha/event_create_and_edit_pb.rb +48 -0
- data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb +25 -41
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +33 -407
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +156 -0
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +15 -10
- data/proto_docs/google/analytics/admin/v1alpha/event_create_and_edit.rb +167 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +33 -0
- data/proto_docs/google/protobuf/timestamp.rb +1 -3
- metadata +6 -4
@@ -184,7 +184,7 @@ module Google
|
|
184
184
|
credentials = @config.credentials
|
185
185
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
186
186
|
# but only if the default endpoint does not have a region prefix.
|
187
|
-
enable_self_signed_jwt = @config.endpoint ==
|
187
|
+
enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
188
188
|
!@config.endpoint.split(".").first.include?("-")
|
189
189
|
credentials ||= Credentials.default scope: @config.scope,
|
190
190
|
enable_self_signed_jwt: enable_self_signed_jwt
|
@@ -7930,6 +7930,607 @@ module Google
|
|
7930
7930
|
raise ::Google::Cloud::Error.from_error(e)
|
7931
7931
|
end
|
7932
7932
|
|
7933
|
+
##
|
7934
|
+
# Looks up a single AdSenseLink.
|
7935
|
+
#
|
7936
|
+
# @overload get_ad_sense_link(request, options = nil)
|
7937
|
+
# Pass arguments to `get_ad_sense_link` via a request object, either of type
|
7938
|
+
# {::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest} or an equivalent Hash.
|
7939
|
+
#
|
7940
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest, ::Hash]
|
7941
|
+
# A request object representing the call parameters. Required. To specify no
|
7942
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7943
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7944
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
7945
|
+
#
|
7946
|
+
# @overload get_ad_sense_link(name: nil)
|
7947
|
+
# Pass arguments to `get_ad_sense_link` via keyword arguments. Note that at
|
7948
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7949
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7950
|
+
#
|
7951
|
+
# @param name [::String]
|
7952
|
+
# Required. Unique identifier for the AdSense Link requested.
|
7953
|
+
# Format: properties/\\{propertyId}/adSenseLinks/\\{linkId}
|
7954
|
+
# Example: properties/1234/adSenseLinks/5678
|
7955
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
7956
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
7957
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
7958
|
+
#
|
7959
|
+
# @return [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
7960
|
+
#
|
7961
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
7962
|
+
def get_ad_sense_link request, options = nil
|
7963
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7964
|
+
|
7965
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest
|
7966
|
+
|
7967
|
+
# Converts hash and nil to an options object
|
7968
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7969
|
+
|
7970
|
+
# Customize the options with defaults
|
7971
|
+
call_metadata = @config.rpcs.get_ad_sense_link.metadata.to_h
|
7972
|
+
|
7973
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7974
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7975
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7976
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
7977
|
+
transports_version_send: [:rest]
|
7978
|
+
|
7979
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7980
|
+
|
7981
|
+
options.apply_defaults timeout: @config.rpcs.get_ad_sense_link.timeout,
|
7982
|
+
metadata: call_metadata,
|
7983
|
+
retry_policy: @config.rpcs.get_ad_sense_link.retry_policy
|
7984
|
+
|
7985
|
+
options.apply_defaults timeout: @config.timeout,
|
7986
|
+
metadata: @config.metadata,
|
7987
|
+
retry_policy: @config.retry_policy
|
7988
|
+
|
7989
|
+
@analytics_admin_service_stub.get_ad_sense_link request, options do |result, operation|
|
7990
|
+
yield result, operation if block_given?
|
7991
|
+
return result
|
7992
|
+
end
|
7993
|
+
rescue ::Gapic::Rest::Error => e
|
7994
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7995
|
+
end
|
7996
|
+
|
7997
|
+
##
|
7998
|
+
# Creates an AdSenseLink.
|
7999
|
+
#
|
8000
|
+
# @overload create_ad_sense_link(request, options = nil)
|
8001
|
+
# Pass arguments to `create_ad_sense_link` via a request object, either of type
|
8002
|
+
# {::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest} or an equivalent Hash.
|
8003
|
+
#
|
8004
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest, ::Hash]
|
8005
|
+
# A request object representing the call parameters. Required. To specify no
|
8006
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8007
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8008
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8009
|
+
#
|
8010
|
+
# @overload create_ad_sense_link(parent: nil, adsense_link: nil)
|
8011
|
+
# Pass arguments to `create_ad_sense_link` via keyword arguments. Note that at
|
8012
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8013
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8014
|
+
#
|
8015
|
+
# @param parent [::String]
|
8016
|
+
# Required. The property for which to create an AdSense Link.
|
8017
|
+
# Format: properties/\\{propertyId}
|
8018
|
+
# Example: properties/1234
|
8019
|
+
# @param adsense_link [::Google::Analytics::Admin::V1alpha::AdSenseLink, ::Hash]
|
8020
|
+
# Required. The AdSense Link to create
|
8021
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8022
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
8023
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8024
|
+
#
|
8025
|
+
# @return [::Google::Analytics::Admin::V1alpha::AdSenseLink]
|
8026
|
+
#
|
8027
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8028
|
+
def create_ad_sense_link request, options = nil
|
8029
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8030
|
+
|
8031
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest
|
8032
|
+
|
8033
|
+
# Converts hash and nil to an options object
|
8034
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8035
|
+
|
8036
|
+
# Customize the options with defaults
|
8037
|
+
call_metadata = @config.rpcs.create_ad_sense_link.metadata.to_h
|
8038
|
+
|
8039
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8040
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8041
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8042
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8043
|
+
transports_version_send: [:rest]
|
8044
|
+
|
8045
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8046
|
+
|
8047
|
+
options.apply_defaults timeout: @config.rpcs.create_ad_sense_link.timeout,
|
8048
|
+
metadata: call_metadata,
|
8049
|
+
retry_policy: @config.rpcs.create_ad_sense_link.retry_policy
|
8050
|
+
|
8051
|
+
options.apply_defaults timeout: @config.timeout,
|
8052
|
+
metadata: @config.metadata,
|
8053
|
+
retry_policy: @config.retry_policy
|
8054
|
+
|
8055
|
+
@analytics_admin_service_stub.create_ad_sense_link request, options do |result, operation|
|
8056
|
+
yield result, operation if block_given?
|
8057
|
+
return result
|
8058
|
+
end
|
8059
|
+
rescue ::Gapic::Rest::Error => e
|
8060
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8061
|
+
end
|
8062
|
+
|
8063
|
+
##
|
8064
|
+
# Deletes an AdSenseLink.
|
8065
|
+
#
|
8066
|
+
# @overload delete_ad_sense_link(request, options = nil)
|
8067
|
+
# Pass arguments to `delete_ad_sense_link` via a request object, either of type
|
8068
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest} or an equivalent Hash.
|
8069
|
+
#
|
8070
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest, ::Hash]
|
8071
|
+
# A request object representing the call parameters. Required. To specify no
|
8072
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8073
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8074
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8075
|
+
#
|
8076
|
+
# @overload delete_ad_sense_link(name: nil)
|
8077
|
+
# Pass arguments to `delete_ad_sense_link` via keyword arguments. Note that at
|
8078
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8079
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8080
|
+
#
|
8081
|
+
# @param name [::String]
|
8082
|
+
# Required. Unique identifier for the AdSense Link to be deleted.
|
8083
|
+
# Format: properties/\\{propertyId}/adSenseLinks/\\{linkId}
|
8084
|
+
# Example: properties/1234/adSenseLinks/5678
|
8085
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8086
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
8087
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8088
|
+
#
|
8089
|
+
# @return [::Google::Protobuf::Empty]
|
8090
|
+
#
|
8091
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8092
|
+
def delete_ad_sense_link request, options = nil
|
8093
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8094
|
+
|
8095
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest
|
8096
|
+
|
8097
|
+
# Converts hash and nil to an options object
|
8098
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8099
|
+
|
8100
|
+
# Customize the options with defaults
|
8101
|
+
call_metadata = @config.rpcs.delete_ad_sense_link.metadata.to_h
|
8102
|
+
|
8103
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8104
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8105
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8106
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8107
|
+
transports_version_send: [:rest]
|
8108
|
+
|
8109
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8110
|
+
|
8111
|
+
options.apply_defaults timeout: @config.rpcs.delete_ad_sense_link.timeout,
|
8112
|
+
metadata: call_metadata,
|
8113
|
+
retry_policy: @config.rpcs.delete_ad_sense_link.retry_policy
|
8114
|
+
|
8115
|
+
options.apply_defaults timeout: @config.timeout,
|
8116
|
+
metadata: @config.metadata,
|
8117
|
+
retry_policy: @config.retry_policy
|
8118
|
+
|
8119
|
+
@analytics_admin_service_stub.delete_ad_sense_link request, options do |result, operation|
|
8120
|
+
yield result, operation if block_given?
|
8121
|
+
return result
|
8122
|
+
end
|
8123
|
+
rescue ::Gapic::Rest::Error => e
|
8124
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8125
|
+
end
|
8126
|
+
|
8127
|
+
##
|
8128
|
+
# Lists AdSenseLinks on a property.
|
8129
|
+
#
|
8130
|
+
# @overload list_ad_sense_links(request, options = nil)
|
8131
|
+
# Pass arguments to `list_ad_sense_links` via a request object, either of type
|
8132
|
+
# {::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest} or an equivalent Hash.
|
8133
|
+
#
|
8134
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest, ::Hash]
|
8135
|
+
# A request object representing the call parameters. Required. To specify no
|
8136
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8137
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8138
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8139
|
+
#
|
8140
|
+
# @overload list_ad_sense_links(parent: nil, page_size: nil, page_token: nil)
|
8141
|
+
# Pass arguments to `list_ad_sense_links` via keyword arguments. Note that at
|
8142
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8143
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8144
|
+
#
|
8145
|
+
# @param parent [::String]
|
8146
|
+
# Required. Resource name of the parent property.
|
8147
|
+
# Format: properties/\\{propertyId}
|
8148
|
+
# Example: properties/1234
|
8149
|
+
# @param page_size [::Integer]
|
8150
|
+
# The maximum number of resources to return.
|
8151
|
+
# If unspecified, at most 50 resources will be returned.
|
8152
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
8153
|
+
# @param page_token [::String]
|
8154
|
+
# A page token received from a previous `ListAdSenseLinks` call.
|
8155
|
+
# Provide this to retrieve the subsequent page.
|
8156
|
+
#
|
8157
|
+
# When paginating, all other parameters provided to `ListAdSenseLinks` must
|
8158
|
+
# match the call that provided the page token.
|
8159
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8160
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>]
|
8161
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8162
|
+
#
|
8163
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>]
|
8164
|
+
#
|
8165
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8166
|
+
def list_ad_sense_links request, options = nil
|
8167
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8168
|
+
|
8169
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest
|
8170
|
+
|
8171
|
+
# Converts hash and nil to an options object
|
8172
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8173
|
+
|
8174
|
+
# Customize the options with defaults
|
8175
|
+
call_metadata = @config.rpcs.list_ad_sense_links.metadata.to_h
|
8176
|
+
|
8177
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8178
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8179
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8180
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8181
|
+
transports_version_send: [:rest]
|
8182
|
+
|
8183
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8184
|
+
|
8185
|
+
options.apply_defaults timeout: @config.rpcs.list_ad_sense_links.timeout,
|
8186
|
+
metadata: call_metadata,
|
8187
|
+
retry_policy: @config.rpcs.list_ad_sense_links.retry_policy
|
8188
|
+
|
8189
|
+
options.apply_defaults timeout: @config.timeout,
|
8190
|
+
metadata: @config.metadata,
|
8191
|
+
retry_policy: @config.retry_policy
|
8192
|
+
|
8193
|
+
@analytics_admin_service_stub.list_ad_sense_links request, options do |result, operation|
|
8194
|
+
result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_ad_sense_links, "adsense_links", request, result, options
|
8195
|
+
yield result, operation if block_given?
|
8196
|
+
return result
|
8197
|
+
end
|
8198
|
+
rescue ::Gapic::Rest::Error => e
|
8199
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8200
|
+
end
|
8201
|
+
|
8202
|
+
##
|
8203
|
+
# Lookup for a single EventCreateRule.
|
8204
|
+
#
|
8205
|
+
# @overload get_event_create_rule(request, options = nil)
|
8206
|
+
# Pass arguments to `get_event_create_rule` via a request object, either of type
|
8207
|
+
# {::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest} or an equivalent Hash.
|
8208
|
+
#
|
8209
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest, ::Hash]
|
8210
|
+
# A request object representing the call parameters. Required. To specify no
|
8211
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8212
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8213
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8214
|
+
#
|
8215
|
+
# @overload get_event_create_rule(name: nil)
|
8216
|
+
# Pass arguments to `get_event_create_rule` via keyword arguments. Note that at
|
8217
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8218
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8219
|
+
#
|
8220
|
+
# @param name [::String]
|
8221
|
+
# Required. The name of the EventCreateRule to get.
|
8222
|
+
# Example format: properties/123/dataStreams/456/eventCreateRules/789
|
8223
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8224
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
8225
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8226
|
+
#
|
8227
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
8228
|
+
#
|
8229
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8230
|
+
def get_event_create_rule request, options = nil
|
8231
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8232
|
+
|
8233
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest
|
8234
|
+
|
8235
|
+
# Converts hash and nil to an options object
|
8236
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8237
|
+
|
8238
|
+
# Customize the options with defaults
|
8239
|
+
call_metadata = @config.rpcs.get_event_create_rule.metadata.to_h
|
8240
|
+
|
8241
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8242
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8243
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8244
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8245
|
+
transports_version_send: [:rest]
|
8246
|
+
|
8247
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8248
|
+
|
8249
|
+
options.apply_defaults timeout: @config.rpcs.get_event_create_rule.timeout,
|
8250
|
+
metadata: call_metadata,
|
8251
|
+
retry_policy: @config.rpcs.get_event_create_rule.retry_policy
|
8252
|
+
|
8253
|
+
options.apply_defaults timeout: @config.timeout,
|
8254
|
+
metadata: @config.metadata,
|
8255
|
+
retry_policy: @config.retry_policy
|
8256
|
+
|
8257
|
+
@analytics_admin_service_stub.get_event_create_rule request, options do |result, operation|
|
8258
|
+
yield result, operation if block_given?
|
8259
|
+
return result
|
8260
|
+
end
|
8261
|
+
rescue ::Gapic::Rest::Error => e
|
8262
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8263
|
+
end
|
8264
|
+
|
8265
|
+
##
|
8266
|
+
# Lists EventCreateRules on a web data stream.
|
8267
|
+
#
|
8268
|
+
# @overload list_event_create_rules(request, options = nil)
|
8269
|
+
# Pass arguments to `list_event_create_rules` via a request object, either of type
|
8270
|
+
# {::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest} or an equivalent Hash.
|
8271
|
+
#
|
8272
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest, ::Hash]
|
8273
|
+
# A request object representing the call parameters. Required. To specify no
|
8274
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8275
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8276
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8277
|
+
#
|
8278
|
+
# @overload list_event_create_rules(parent: nil, page_size: nil, page_token: nil)
|
8279
|
+
# Pass arguments to `list_event_create_rules` via keyword arguments. Note that at
|
8280
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8281
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8282
|
+
#
|
8283
|
+
# @param parent [::String]
|
8284
|
+
# Required. Example format: properties/123/dataStreams/456
|
8285
|
+
# @param page_size [::Integer]
|
8286
|
+
# The maximum number of resources to return.
|
8287
|
+
# If unspecified, at most 50 resources will be returned.
|
8288
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
8289
|
+
# @param page_token [::String]
|
8290
|
+
# A page token, received from a previous `ListEventCreateRules` call. Provide
|
8291
|
+
# this to retrieve the subsequent page.
|
8292
|
+
#
|
8293
|
+
# When paginating, all other parameters provided to `ListEventCreateRules`
|
8294
|
+
# must match the call that provided the page token.
|
8295
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8296
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>]
|
8297
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8298
|
+
#
|
8299
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>]
|
8300
|
+
#
|
8301
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8302
|
+
def list_event_create_rules request, options = nil
|
8303
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8304
|
+
|
8305
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest
|
8306
|
+
|
8307
|
+
# Converts hash and nil to an options object
|
8308
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8309
|
+
|
8310
|
+
# Customize the options with defaults
|
8311
|
+
call_metadata = @config.rpcs.list_event_create_rules.metadata.to_h
|
8312
|
+
|
8313
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8314
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8315
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8316
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8317
|
+
transports_version_send: [:rest]
|
8318
|
+
|
8319
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8320
|
+
|
8321
|
+
options.apply_defaults timeout: @config.rpcs.list_event_create_rules.timeout,
|
8322
|
+
metadata: call_metadata,
|
8323
|
+
retry_policy: @config.rpcs.list_event_create_rules.retry_policy
|
8324
|
+
|
8325
|
+
options.apply_defaults timeout: @config.timeout,
|
8326
|
+
metadata: @config.metadata,
|
8327
|
+
retry_policy: @config.retry_policy
|
8328
|
+
|
8329
|
+
@analytics_admin_service_stub.list_event_create_rules request, options do |result, operation|
|
8330
|
+
result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_event_create_rules, "event_create_rules", request, result, options
|
8331
|
+
yield result, operation if block_given?
|
8332
|
+
return result
|
8333
|
+
end
|
8334
|
+
rescue ::Gapic::Rest::Error => e
|
8335
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8336
|
+
end
|
8337
|
+
|
8338
|
+
##
|
8339
|
+
# Creates an EventCreateRule.
|
8340
|
+
#
|
8341
|
+
# @overload create_event_create_rule(request, options = nil)
|
8342
|
+
# Pass arguments to `create_event_create_rule` via a request object, either of type
|
8343
|
+
# {::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest} or an equivalent Hash.
|
8344
|
+
#
|
8345
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest, ::Hash]
|
8346
|
+
# A request object representing the call parameters. Required. To specify no
|
8347
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8348
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8349
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8350
|
+
#
|
8351
|
+
# @overload create_event_create_rule(parent: nil, event_create_rule: nil)
|
8352
|
+
# Pass arguments to `create_event_create_rule` via keyword arguments. Note that at
|
8353
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8354
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8355
|
+
#
|
8356
|
+
# @param parent [::String]
|
8357
|
+
# Required. Example format: properties/123/dataStreams/456
|
8358
|
+
# @param event_create_rule [::Google::Analytics::Admin::V1alpha::EventCreateRule, ::Hash]
|
8359
|
+
# Required. The EventCreateRule to create.
|
8360
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8361
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
8362
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8363
|
+
#
|
8364
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
8365
|
+
#
|
8366
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8367
|
+
def create_event_create_rule request, options = nil
|
8368
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8369
|
+
|
8370
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest
|
8371
|
+
|
8372
|
+
# Converts hash and nil to an options object
|
8373
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8374
|
+
|
8375
|
+
# Customize the options with defaults
|
8376
|
+
call_metadata = @config.rpcs.create_event_create_rule.metadata.to_h
|
8377
|
+
|
8378
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8379
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8380
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8381
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8382
|
+
transports_version_send: [:rest]
|
8383
|
+
|
8384
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8385
|
+
|
8386
|
+
options.apply_defaults timeout: @config.rpcs.create_event_create_rule.timeout,
|
8387
|
+
metadata: call_metadata,
|
8388
|
+
retry_policy: @config.rpcs.create_event_create_rule.retry_policy
|
8389
|
+
|
8390
|
+
options.apply_defaults timeout: @config.timeout,
|
8391
|
+
metadata: @config.metadata,
|
8392
|
+
retry_policy: @config.retry_policy
|
8393
|
+
|
8394
|
+
@analytics_admin_service_stub.create_event_create_rule request, options do |result, operation|
|
8395
|
+
yield result, operation if block_given?
|
8396
|
+
return result
|
8397
|
+
end
|
8398
|
+
rescue ::Gapic::Rest::Error => e
|
8399
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8400
|
+
end
|
8401
|
+
|
8402
|
+
##
|
8403
|
+
# Updates an EventCreateRule.
|
8404
|
+
#
|
8405
|
+
# @overload update_event_create_rule(request, options = nil)
|
8406
|
+
# Pass arguments to `update_event_create_rule` via a request object, either of type
|
8407
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest} or an equivalent Hash.
|
8408
|
+
#
|
8409
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest, ::Hash]
|
8410
|
+
# A request object representing the call parameters. Required. To specify no
|
8411
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8412
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8413
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8414
|
+
#
|
8415
|
+
# @overload update_event_create_rule(event_create_rule: nil, update_mask: nil)
|
8416
|
+
# Pass arguments to `update_event_create_rule` via keyword arguments. Note that at
|
8417
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8418
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8419
|
+
#
|
8420
|
+
# @param event_create_rule [::Google::Analytics::Admin::V1alpha::EventCreateRule, ::Hash]
|
8421
|
+
# Required. The EventCreateRule to update.
|
8422
|
+
# The resource's `name` field is used to identify the EventCreateRule to be
|
8423
|
+
# updated.
|
8424
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
8425
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
8426
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
8427
|
+
# replace the entire entity, use one path with the string "*" to match all
|
8428
|
+
# fields.
|
8429
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8430
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
8431
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8432
|
+
#
|
8433
|
+
# @return [::Google::Analytics::Admin::V1alpha::EventCreateRule]
|
8434
|
+
#
|
8435
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8436
|
+
def update_event_create_rule request, options = nil
|
8437
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8438
|
+
|
8439
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest
|
8440
|
+
|
8441
|
+
# Converts hash and nil to an options object
|
8442
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8443
|
+
|
8444
|
+
# Customize the options with defaults
|
8445
|
+
call_metadata = @config.rpcs.update_event_create_rule.metadata.to_h
|
8446
|
+
|
8447
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8448
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8449
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8450
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8451
|
+
transports_version_send: [:rest]
|
8452
|
+
|
8453
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8454
|
+
|
8455
|
+
options.apply_defaults timeout: @config.rpcs.update_event_create_rule.timeout,
|
8456
|
+
metadata: call_metadata,
|
8457
|
+
retry_policy: @config.rpcs.update_event_create_rule.retry_policy
|
8458
|
+
|
8459
|
+
options.apply_defaults timeout: @config.timeout,
|
8460
|
+
metadata: @config.metadata,
|
8461
|
+
retry_policy: @config.retry_policy
|
8462
|
+
|
8463
|
+
@analytics_admin_service_stub.update_event_create_rule request, options do |result, operation|
|
8464
|
+
yield result, operation if block_given?
|
8465
|
+
return result
|
8466
|
+
end
|
8467
|
+
rescue ::Gapic::Rest::Error => e
|
8468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8469
|
+
end
|
8470
|
+
|
8471
|
+
##
|
8472
|
+
# Deletes an EventCreateRule.
|
8473
|
+
#
|
8474
|
+
# @overload delete_event_create_rule(request, options = nil)
|
8475
|
+
# Pass arguments to `delete_event_create_rule` via a request object, either of type
|
8476
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest} or an equivalent Hash.
|
8477
|
+
#
|
8478
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest, ::Hash]
|
8479
|
+
# A request object representing the call parameters. Required. To specify no
|
8480
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8481
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8482
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
8483
|
+
#
|
8484
|
+
# @overload delete_event_create_rule(name: nil)
|
8485
|
+
# Pass arguments to `delete_event_create_rule` via keyword arguments. Note that at
|
8486
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8487
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8488
|
+
#
|
8489
|
+
# @param name [::String]
|
8490
|
+
# Required. Example format:
|
8491
|
+
# properties/123/dataStreams/456/eventCreateRules/789
|
8492
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
8493
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
8494
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
8495
|
+
#
|
8496
|
+
# @return [::Google::Protobuf::Empty]
|
8497
|
+
#
|
8498
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
8499
|
+
def delete_event_create_rule request, options = nil
|
8500
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8501
|
+
|
8502
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest
|
8503
|
+
|
8504
|
+
# Converts hash and nil to an options object
|
8505
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8506
|
+
|
8507
|
+
# Customize the options with defaults
|
8508
|
+
call_metadata = @config.rpcs.delete_event_create_rule.metadata.to_h
|
8509
|
+
|
8510
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8511
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8512
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8513
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION,
|
8514
|
+
transports_version_send: [:rest]
|
8515
|
+
|
8516
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8517
|
+
|
8518
|
+
options.apply_defaults timeout: @config.rpcs.delete_event_create_rule.timeout,
|
8519
|
+
metadata: call_metadata,
|
8520
|
+
retry_policy: @config.rpcs.delete_event_create_rule.retry_policy
|
8521
|
+
|
8522
|
+
options.apply_defaults timeout: @config.timeout,
|
8523
|
+
metadata: @config.metadata,
|
8524
|
+
retry_policy: @config.retry_policy
|
8525
|
+
|
8526
|
+
@analytics_admin_service_stub.delete_event_create_rule request, options do |result, operation|
|
8527
|
+
yield result, operation if block_given?
|
8528
|
+
return result
|
8529
|
+
end
|
8530
|
+
rescue ::Gapic::Rest::Error => e
|
8531
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8532
|
+
end
|
8533
|
+
|
7933
8534
|
##
|
7934
8535
|
# Configuration class for the AnalyticsAdminService REST API.
|
7935
8536
|
#
|
@@ -8003,7 +8604,9 @@ module Google
|
|
8003
8604
|
class Configuration
|
8004
8605
|
extend ::Gapic::Config
|
8005
8606
|
|
8006
|
-
|
8607
|
+
DEFAULT_ENDPOINT = "analyticsadmin.googleapis.com"
|
8608
|
+
|
8609
|
+
config_attr :endpoint, DEFAULT_ENDPOINT, ::String
|
8007
8610
|
config_attr :credentials, nil do |value|
|
8008
8611
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
8009
8612
|
allowed.any? { |klass| klass === value }
|
@@ -8618,6 +9221,51 @@ module Google
|
|
8618
9221
|
# @return [::Gapic::Config::Method]
|
8619
9222
|
#
|
8620
9223
|
attr_reader :fetch_connected_ga4_property
|
9224
|
+
##
|
9225
|
+
# RPC-specific configuration for `get_ad_sense_link`
|
9226
|
+
# @return [::Gapic::Config::Method]
|
9227
|
+
#
|
9228
|
+
attr_reader :get_ad_sense_link
|
9229
|
+
##
|
9230
|
+
# RPC-specific configuration for `create_ad_sense_link`
|
9231
|
+
# @return [::Gapic::Config::Method]
|
9232
|
+
#
|
9233
|
+
attr_reader :create_ad_sense_link
|
9234
|
+
##
|
9235
|
+
# RPC-specific configuration for `delete_ad_sense_link`
|
9236
|
+
# @return [::Gapic::Config::Method]
|
9237
|
+
#
|
9238
|
+
attr_reader :delete_ad_sense_link
|
9239
|
+
##
|
9240
|
+
# RPC-specific configuration for `list_ad_sense_links`
|
9241
|
+
# @return [::Gapic::Config::Method]
|
9242
|
+
#
|
9243
|
+
attr_reader :list_ad_sense_links
|
9244
|
+
##
|
9245
|
+
# RPC-specific configuration for `get_event_create_rule`
|
9246
|
+
# @return [::Gapic::Config::Method]
|
9247
|
+
#
|
9248
|
+
attr_reader :get_event_create_rule
|
9249
|
+
##
|
9250
|
+
# RPC-specific configuration for `list_event_create_rules`
|
9251
|
+
# @return [::Gapic::Config::Method]
|
9252
|
+
#
|
9253
|
+
attr_reader :list_event_create_rules
|
9254
|
+
##
|
9255
|
+
# RPC-specific configuration for `create_event_create_rule`
|
9256
|
+
# @return [::Gapic::Config::Method]
|
9257
|
+
#
|
9258
|
+
attr_reader :create_event_create_rule
|
9259
|
+
##
|
9260
|
+
# RPC-specific configuration for `update_event_create_rule`
|
9261
|
+
# @return [::Gapic::Config::Method]
|
9262
|
+
#
|
9263
|
+
attr_reader :update_event_create_rule
|
9264
|
+
##
|
9265
|
+
# RPC-specific configuration for `delete_event_create_rule`
|
9266
|
+
# @return [::Gapic::Config::Method]
|
9267
|
+
#
|
9268
|
+
attr_reader :delete_event_create_rule
|
8621
9269
|
|
8622
9270
|
# @private
|
8623
9271
|
def initialize parent_rpcs = nil
|
@@ -8847,6 +9495,24 @@ module Google
|
|
8847
9495
|
@list_connected_site_tags = ::Gapic::Config::Method.new list_connected_site_tags_config
|
8848
9496
|
fetch_connected_ga4_property_config = parent_rpcs.fetch_connected_ga4_property if parent_rpcs.respond_to? :fetch_connected_ga4_property
|
8849
9497
|
@fetch_connected_ga4_property = ::Gapic::Config::Method.new fetch_connected_ga4_property_config
|
9498
|
+
get_ad_sense_link_config = parent_rpcs.get_ad_sense_link if parent_rpcs.respond_to? :get_ad_sense_link
|
9499
|
+
@get_ad_sense_link = ::Gapic::Config::Method.new get_ad_sense_link_config
|
9500
|
+
create_ad_sense_link_config = parent_rpcs.create_ad_sense_link if parent_rpcs.respond_to? :create_ad_sense_link
|
9501
|
+
@create_ad_sense_link = ::Gapic::Config::Method.new create_ad_sense_link_config
|
9502
|
+
delete_ad_sense_link_config = parent_rpcs.delete_ad_sense_link if parent_rpcs.respond_to? :delete_ad_sense_link
|
9503
|
+
@delete_ad_sense_link = ::Gapic::Config::Method.new delete_ad_sense_link_config
|
9504
|
+
list_ad_sense_links_config = parent_rpcs.list_ad_sense_links if parent_rpcs.respond_to? :list_ad_sense_links
|
9505
|
+
@list_ad_sense_links = ::Gapic::Config::Method.new list_ad_sense_links_config
|
9506
|
+
get_event_create_rule_config = parent_rpcs.get_event_create_rule if parent_rpcs.respond_to? :get_event_create_rule
|
9507
|
+
@get_event_create_rule = ::Gapic::Config::Method.new get_event_create_rule_config
|
9508
|
+
list_event_create_rules_config = parent_rpcs.list_event_create_rules if parent_rpcs.respond_to? :list_event_create_rules
|
9509
|
+
@list_event_create_rules = ::Gapic::Config::Method.new list_event_create_rules_config
|
9510
|
+
create_event_create_rule_config = parent_rpcs.create_event_create_rule if parent_rpcs.respond_to? :create_event_create_rule
|
9511
|
+
@create_event_create_rule = ::Gapic::Config::Method.new create_event_create_rule_config
|
9512
|
+
update_event_create_rule_config = parent_rpcs.update_event_create_rule if parent_rpcs.respond_to? :update_event_create_rule
|
9513
|
+
@update_event_create_rule = ::Gapic::Config::Method.new update_event_create_rule_config
|
9514
|
+
delete_event_create_rule_config = parent_rpcs.delete_event_create_rule if parent_rpcs.respond_to? :delete_event_create_rule
|
9515
|
+
@delete_event_create_rule = ::Gapic::Config::Method.new delete_event_create_rule_config
|
8850
9516
|
|
8851
9517
|
yield self if block_given?
|
8852
9518
|
end
|