google-analytics-admin-v1alpha 0.16.0 → 0.17.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 +30 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +490 -11
- 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 +399 -11
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/rest/service_stub.rb +301 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +19 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +22 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +105 -10
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +84 -6
- data/proto_docs/google/api/client.rb +9 -3
- metadata +2 -2
@@ -3916,6 +3916,196 @@ module Google
|
|
3916
3916
|
result
|
3917
3917
|
end
|
3918
3918
|
|
3919
|
+
##
|
3920
|
+
# Baseline implementation for the get_enhanced_measurement_settings REST call
|
3921
|
+
#
|
3922
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest]
|
3923
|
+
# A request object representing the call parameters. Required.
|
3924
|
+
# @param options [::Gapic::CallOptions]
|
3925
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
3926
|
+
#
|
3927
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
3928
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3929
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
3930
|
+
#
|
3931
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3932
|
+
# A result object deserialized from the server's reply
|
3933
|
+
def get_enhanced_measurement_settings request_pb, options = nil
|
3934
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
3935
|
+
|
3936
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_get_enhanced_measurement_settings_request request_pb
|
3937
|
+
query_string_params = if query_string_params.any?
|
3938
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
3939
|
+
else
|
3940
|
+
{}
|
3941
|
+
end
|
3942
|
+
|
3943
|
+
response = @client_stub.make_http_request(
|
3944
|
+
verb,
|
3945
|
+
uri: uri,
|
3946
|
+
body: body || "",
|
3947
|
+
params: query_string_params,
|
3948
|
+
options: options
|
3949
|
+
)
|
3950
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
3951
|
+
result = ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.decode_json response.body, ignore_unknown_fields: true
|
3952
|
+
|
3953
|
+
yield result, operation if block_given?
|
3954
|
+
result
|
3955
|
+
end
|
3956
|
+
|
3957
|
+
##
|
3958
|
+
# Baseline implementation for the update_enhanced_measurement_settings REST call
|
3959
|
+
#
|
3960
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest]
|
3961
|
+
# A request object representing the call parameters. Required.
|
3962
|
+
# @param options [::Gapic::CallOptions]
|
3963
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
3964
|
+
#
|
3965
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
3966
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3967
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
3968
|
+
#
|
3969
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
3970
|
+
# A result object deserialized from the server's reply
|
3971
|
+
def update_enhanced_measurement_settings request_pb, options = nil
|
3972
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
3973
|
+
|
3974
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_update_enhanced_measurement_settings_request request_pb
|
3975
|
+
query_string_params = if query_string_params.any?
|
3976
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
3977
|
+
else
|
3978
|
+
{}
|
3979
|
+
end
|
3980
|
+
|
3981
|
+
response = @client_stub.make_http_request(
|
3982
|
+
verb,
|
3983
|
+
uri: uri,
|
3984
|
+
body: body || "",
|
3985
|
+
params: query_string_params,
|
3986
|
+
options: options
|
3987
|
+
)
|
3988
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
3989
|
+
result = ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.decode_json response.body, ignore_unknown_fields: true
|
3990
|
+
|
3991
|
+
yield result, operation if block_given?
|
3992
|
+
result
|
3993
|
+
end
|
3994
|
+
|
3995
|
+
##
|
3996
|
+
# Baseline implementation for the create_connected_site_tag REST call
|
3997
|
+
#
|
3998
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest]
|
3999
|
+
# A request object representing the call parameters. Required.
|
4000
|
+
# @param options [::Gapic::CallOptions]
|
4001
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
4002
|
+
#
|
4003
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
4004
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
|
4005
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
4006
|
+
#
|
4007
|
+
# @return [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse]
|
4008
|
+
# A result object deserialized from the server's reply
|
4009
|
+
def create_connected_site_tag request_pb, options = nil
|
4010
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
4011
|
+
|
4012
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_create_connected_site_tag_request request_pb
|
4013
|
+
query_string_params = if query_string_params.any?
|
4014
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
4015
|
+
else
|
4016
|
+
{}
|
4017
|
+
end
|
4018
|
+
|
4019
|
+
response = @client_stub.make_http_request(
|
4020
|
+
verb,
|
4021
|
+
uri: uri,
|
4022
|
+
body: body || "",
|
4023
|
+
params: query_string_params,
|
4024
|
+
options: options
|
4025
|
+
)
|
4026
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
4027
|
+
result = ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse.decode_json response.body, ignore_unknown_fields: true
|
4028
|
+
|
4029
|
+
yield result, operation if block_given?
|
4030
|
+
result
|
4031
|
+
end
|
4032
|
+
|
4033
|
+
##
|
4034
|
+
# Baseline implementation for the delete_connected_site_tag REST call
|
4035
|
+
#
|
4036
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest]
|
4037
|
+
# A request object representing the call parameters. Required.
|
4038
|
+
# @param options [::Gapic::CallOptions]
|
4039
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
4040
|
+
#
|
4041
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
4042
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
4043
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
4044
|
+
#
|
4045
|
+
# @return [::Google::Protobuf::Empty]
|
4046
|
+
# A result object deserialized from the server's reply
|
4047
|
+
def delete_connected_site_tag request_pb, options = nil
|
4048
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
4049
|
+
|
4050
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_delete_connected_site_tag_request request_pb
|
4051
|
+
query_string_params = if query_string_params.any?
|
4052
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
4053
|
+
else
|
4054
|
+
{}
|
4055
|
+
end
|
4056
|
+
|
4057
|
+
response = @client_stub.make_http_request(
|
4058
|
+
verb,
|
4059
|
+
uri: uri,
|
4060
|
+
body: body || "",
|
4061
|
+
params: query_string_params,
|
4062
|
+
options: options
|
4063
|
+
)
|
4064
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
4065
|
+
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
4066
|
+
|
4067
|
+
yield result, operation if block_given?
|
4068
|
+
result
|
4069
|
+
end
|
4070
|
+
|
4071
|
+
##
|
4072
|
+
# Baseline implementation for the list_connected_site_tags REST call
|
4073
|
+
#
|
4074
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest]
|
4075
|
+
# A request object representing the call parameters. Required.
|
4076
|
+
# @param options [::Gapic::CallOptions]
|
4077
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
4078
|
+
#
|
4079
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
4080
|
+
# @yieldparam result [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
|
4081
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
4082
|
+
#
|
4083
|
+
# @return [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse]
|
4084
|
+
# A result object deserialized from the server's reply
|
4085
|
+
def list_connected_site_tags request_pb, options = nil
|
4086
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
4087
|
+
|
4088
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_list_connected_site_tags_request request_pb
|
4089
|
+
query_string_params = if query_string_params.any?
|
4090
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
4091
|
+
else
|
4092
|
+
{}
|
4093
|
+
end
|
4094
|
+
|
4095
|
+
response = @client_stub.make_http_request(
|
4096
|
+
verb,
|
4097
|
+
uri: uri,
|
4098
|
+
body: body || "",
|
4099
|
+
params: query_string_params,
|
4100
|
+
options: options
|
4101
|
+
)
|
4102
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
4103
|
+
result = ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse.decode_json response.body, ignore_unknown_fields: true
|
4104
|
+
|
4105
|
+
yield result, operation if block_given?
|
4106
|
+
result
|
4107
|
+
end
|
4108
|
+
|
3919
4109
|
##
|
3920
4110
|
# @private
|
3921
4111
|
#
|
@@ -5783,6 +5973,14 @@ module Google
|
|
5783
5973
|
["entity", %r{^properties/[^/]+/?$}, false]
|
5784
5974
|
]
|
5785
5975
|
)
|
5976
|
+
.with_bindings(
|
5977
|
+
uri_method: :post,
|
5978
|
+
uri_template: "/v1alpha/{entity}:runAccessReport",
|
5979
|
+
body: "*",
|
5980
|
+
matches: [
|
5981
|
+
["entity", %r{^accounts/[^/]+/?$}, false]
|
5982
|
+
]
|
5983
|
+
)
|
5786
5984
|
transcoder.transcode request_pb
|
5787
5985
|
end
|
5788
5986
|
|
@@ -6236,6 +6434,109 @@ module Google
|
|
6236
6434
|
)
|
6237
6435
|
transcoder.transcode request_pb
|
6238
6436
|
end
|
6437
|
+
|
6438
|
+
##
|
6439
|
+
# @private
|
6440
|
+
#
|
6441
|
+
# GRPC transcoding helper method for the get_enhanced_measurement_settings REST call
|
6442
|
+
#
|
6443
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest]
|
6444
|
+
# A request object representing the call parameters. Required.
|
6445
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
6446
|
+
# Uri, Body, Query string parameters
|
6447
|
+
def self.transcode_get_enhanced_measurement_settings_request request_pb
|
6448
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
6449
|
+
.with_bindings(
|
6450
|
+
uri_method: :get,
|
6451
|
+
uri_template: "/v1alpha/{name}",
|
6452
|
+
matches: [
|
6453
|
+
["name", %r{^properties/[^/]+/dataStreams/[^/]+/enhancedMeasurementSettings/?$}, false]
|
6454
|
+
]
|
6455
|
+
)
|
6456
|
+
transcoder.transcode request_pb
|
6457
|
+
end
|
6458
|
+
|
6459
|
+
##
|
6460
|
+
# @private
|
6461
|
+
#
|
6462
|
+
# GRPC transcoding helper method for the update_enhanced_measurement_settings REST call
|
6463
|
+
#
|
6464
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest]
|
6465
|
+
# A request object representing the call parameters. Required.
|
6466
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
6467
|
+
# Uri, Body, Query string parameters
|
6468
|
+
def self.transcode_update_enhanced_measurement_settings_request request_pb
|
6469
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
6470
|
+
.with_bindings(
|
6471
|
+
uri_method: :patch,
|
6472
|
+
uri_template: "/v1alpha/{enhanced_measurement_settings.name}",
|
6473
|
+
body: "enhanced_measurement_settings",
|
6474
|
+
matches: [
|
6475
|
+
["enhanced_measurement_settings.name", %r{^properties/[^/]+/dataStreams/[^/]+/enhancedMeasurementSettings/?$}, false]
|
6476
|
+
]
|
6477
|
+
)
|
6478
|
+
transcoder.transcode request_pb
|
6479
|
+
end
|
6480
|
+
|
6481
|
+
##
|
6482
|
+
# @private
|
6483
|
+
#
|
6484
|
+
# GRPC transcoding helper method for the create_connected_site_tag REST call
|
6485
|
+
#
|
6486
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest]
|
6487
|
+
# A request object representing the call parameters. Required.
|
6488
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
6489
|
+
# Uri, Body, Query string parameters
|
6490
|
+
def self.transcode_create_connected_site_tag_request request_pb
|
6491
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
6492
|
+
.with_bindings(
|
6493
|
+
uri_method: :post,
|
6494
|
+
uri_template: "/v1alpha/properties:createConnectedSiteTag",
|
6495
|
+
body: "*",
|
6496
|
+
matches: []
|
6497
|
+
)
|
6498
|
+
transcoder.transcode request_pb
|
6499
|
+
end
|
6500
|
+
|
6501
|
+
##
|
6502
|
+
# @private
|
6503
|
+
#
|
6504
|
+
# GRPC transcoding helper method for the delete_connected_site_tag REST call
|
6505
|
+
#
|
6506
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest]
|
6507
|
+
# A request object representing the call parameters. Required.
|
6508
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
6509
|
+
# Uri, Body, Query string parameters
|
6510
|
+
def self.transcode_delete_connected_site_tag_request request_pb
|
6511
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
6512
|
+
.with_bindings(
|
6513
|
+
uri_method: :post,
|
6514
|
+
uri_template: "/v1alpha/properties:deleteConnectedSiteTag",
|
6515
|
+
body: "*",
|
6516
|
+
matches: []
|
6517
|
+
)
|
6518
|
+
transcoder.transcode request_pb
|
6519
|
+
end
|
6520
|
+
|
6521
|
+
##
|
6522
|
+
# @private
|
6523
|
+
#
|
6524
|
+
# GRPC transcoding helper method for the list_connected_site_tags REST call
|
6525
|
+
#
|
6526
|
+
# @param request_pb [::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest]
|
6527
|
+
# A request object representing the call parameters. Required.
|
6528
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
6529
|
+
# Uri, Body, Query string parameters
|
6530
|
+
def self.transcode_list_connected_site_tags_request request_pb
|
6531
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
6532
|
+
.with_bindings(
|
6533
|
+
uri_method: :post,
|
6534
|
+
uri_template: "/v1alpha/properties:listConnectedSiteTags",
|
6535
|
+
body: "*",
|
6536
|
+
matches: []
|
6537
|
+
)
|
6538
|
+
transcoder.transcode request_pb
|
6539
|
+
end
|
6239
6540
|
end
|
6240
6541
|
end
|
6241
6542
|
end
|
@@ -330,6 +330,25 @@ module Google
|
|
330
330
|
rpc :GetBigQueryLink, ::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::Google::Analytics::Admin::V1alpha::BigQueryLink
|
331
331
|
# Lists BigQuery Links on a property.
|
332
332
|
rpc :ListBigQueryLinks, ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksResponse
|
333
|
+
# Returns the enhanced measurement settings for this data stream.
|
334
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
335
|
+
# take effect.
|
336
|
+
rpc :GetEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
|
337
|
+
# Updates the enhanced measurement settings for this data stream.
|
338
|
+
# Note that the stream must enable enhanced measurement for these settings to
|
339
|
+
# take effect.
|
340
|
+
rpc :UpdateEnhancedMeasurementSettings, ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
|
341
|
+
# Creates a connected site tag for a Universal Analytics property. You can
|
342
|
+
# create a maximum of 20 connected site tags per property.
|
343
|
+
# Note: This API cannot be used on GA4 properties.
|
344
|
+
rpc :CreateConnectedSiteTag, ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse
|
345
|
+
# Deletes a connected site tag for a Universal Analytics property.
|
346
|
+
# Note: this has no effect on GA4 properties.
|
347
|
+
rpc :DeleteConnectedSiteTag, ::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::Google::Protobuf::Empty
|
348
|
+
# Lists the connected site tags for a Universal Analytics property. A maximum
|
349
|
+
# of 20 connected site tags will be returned. Note: this has no effect on GA4
|
350
|
+
# property.
|
351
|
+
rpc :ListConnectedSiteTags, ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse
|
333
352
|
end
|
334
353
|
|
335
354
|
Stub = Service.rpc_stub_class
|
@@ -152,6 +152,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
152
152
|
optional :attribution_settings, :message, 20, "google.analytics.admin.v1alpha.AttributionSettings"
|
153
153
|
optional :expanded_data_set, :message, 21, "google.analytics.admin.v1alpha.ExpandedDataSet"
|
154
154
|
optional :bigquery_link, :message, 23, "google.analytics.admin.v1alpha.BigQueryLink"
|
155
|
+
optional :enhanced_measurement_settings, :message, 24, "google.analytics.admin.v1alpha.EnhancedMeasurementSettings"
|
155
156
|
end
|
156
157
|
end
|
157
158
|
add_message "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink" do
|
@@ -295,10 +296,28 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
295
296
|
optional :create_time, :message, 3, "google.protobuf.Timestamp"
|
296
297
|
optional :daily_export_enabled, :bool, 4
|
297
298
|
optional :streaming_export_enabled, :bool, 5
|
299
|
+
optional :intraday_export_enabled, :bool, 9
|
298
300
|
optional :include_advertising_id, :bool, 6
|
299
301
|
repeated :export_streams, :string, 7
|
300
302
|
repeated :excluded_events, :string, 8
|
301
303
|
end
|
304
|
+
add_message "google.analytics.admin.v1alpha.EnhancedMeasurementSettings" do
|
305
|
+
optional :name, :string, 1
|
306
|
+
optional :stream_enabled, :bool, 2
|
307
|
+
optional :scrolls_enabled, :bool, 3
|
308
|
+
optional :outbound_clicks_enabled, :bool, 4
|
309
|
+
optional :site_search_enabled, :bool, 5
|
310
|
+
optional :video_engagement_enabled, :bool, 6
|
311
|
+
optional :file_downloads_enabled, :bool, 7
|
312
|
+
optional :page_changes_enabled, :bool, 8
|
313
|
+
optional :form_interactions_enabled, :bool, 9
|
314
|
+
optional :search_query_parameter, :string, 10
|
315
|
+
optional :uri_query_parameter, :string, 11
|
316
|
+
end
|
317
|
+
add_message "google.analytics.admin.v1alpha.ConnectedSiteTag" do
|
318
|
+
optional :display_name, :string, 1
|
319
|
+
optional :tag_id, :string, 2
|
320
|
+
end
|
302
321
|
add_enum "google.analytics.admin.v1alpha.IndustryCategory" do
|
303
322
|
value :INDUSTRY_CATEGORY_UNSPECIFIED, 0
|
304
323
|
value :AUTOMOTIVE, 1
|
@@ -364,6 +383,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
364
383
|
value :ATTRIBUTION_SETTINGS, 20
|
365
384
|
value :EXPANDED_DATA_SET, 21
|
366
385
|
value :CHANNEL_GROUP, 22
|
386
|
+
value :ENHANCED_MEASUREMENT_SETTINGS, 24
|
367
387
|
end
|
368
388
|
add_enum "google.analytics.admin.v1alpha.GoogleSignalsState" do
|
369
389
|
value :GOOGLE_SIGNALS_STATE_UNSPECIFIED, 0
|
@@ -441,6 +461,8 @@ module Google
|
|
441
461
|
AttributionSettings::ReportingAttributionModel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AttributionSettings.ReportingAttributionModel").enummodule
|
442
462
|
AccessBinding = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AccessBinding").msgclass
|
443
463
|
BigQueryLink = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.BigQueryLink").msgclass
|
464
|
+
EnhancedMeasurementSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.EnhancedMeasurementSettings").msgclass
|
465
|
+
ConnectedSiteTag = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ConnectedSiteTag").msgclass
|
444
466
|
IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
|
445
467
|
ServiceLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ServiceLevel").enummodule
|
446
468
|
ActorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ActorType").enummodule
|
@@ -24,9 +24,14 @@ module Google
|
|
24
24
|
# The request for a Data Access Record Report.
|
25
25
|
# @!attribute [rw] entity
|
26
26
|
# @return [::String]
|
27
|
-
# The Data Access Report
|
28
|
-
#
|
29
|
-
#
|
27
|
+
# The Data Access Report supports requesting at the property level or account
|
28
|
+
# level. If requested at the account level, Data Access Reports include all
|
29
|
+
# access for all properties under that account.
|
30
|
+
#
|
31
|
+
# To request at the property level, entity should be for example
|
32
|
+
# 'properties/123' if "123" is your GA4 property ID. To request at the
|
33
|
+
# account level, entity should be for example 'accounts/1234' if "1234" is
|
34
|
+
# your GA4 Account ID.
|
30
35
|
# @!attribute [rw] dimensions
|
31
36
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>]
|
32
37
|
# The dimensions requested and displayed in the response. Requests are
|
@@ -92,7 +97,8 @@ module Google
|
|
92
97
|
# @!attribute [rw] return_entity_quota
|
93
98
|
# @return [::Boolean]
|
94
99
|
# Toggles whether to return the current state of this Analytics Property's
|
95
|
-
# quota. Quota is returned in [AccessQuota](#AccessQuota).
|
100
|
+
# quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level
|
101
|
+
# requests, this field must be false.
|
96
102
|
class RunAccessReportRequest
|
97
103
|
include ::Google::Protobuf::MessageExts
|
98
104
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -124,7 +130,8 @@ module Google
|
|
124
130
|
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
125
131
|
# @!attribute [rw] quota
|
126
132
|
# @return [::Google::Analytics::Admin::V1alpha::AccessQuota]
|
127
|
-
# The quota state for this Analytics property including this request.
|
133
|
+
# The quota state for this Analytics property including this request. This
|
134
|
+
# field doesn't work with account-level requests.
|
128
135
|
class RunAccessReportResponse
|
129
136
|
include ::Google::Protobuf::MessageExts
|
130
137
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,7 +218,7 @@ module Google
|
|
211
218
|
# @!attribute [rw] redirect_uri
|
212
219
|
# @return [::String]
|
213
220
|
# Redirect URI where the user will be sent after accepting Terms of Service.
|
214
|
-
# Must be configured in
|
221
|
+
# Must be configured in Cloud Console as a Redirect URI.
|
215
222
|
class ProvisionAccountTicketRequest
|
216
223
|
include ::Google::Protobuf::MessageExts
|
217
224
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1755,8 +1762,9 @@ module Google
|
|
1755
1762
|
# @!attribute [rw] parent
|
1756
1763
|
# @return [::String]
|
1757
1764
|
# Required. The account or property that owns the access bindings. The parent
|
1758
|
-
#
|
1759
|
-
# match this field.
|
1765
|
+
# of all provided AccessBinding in UpdateAccessBindingRequest messages must
|
1766
|
+
# match this field.
|
1767
|
+
# Formats:
|
1760
1768
|
# - accounts/\\{account}
|
1761
1769
|
# - properties/\\{property}
|
1762
1770
|
# @!attribute [rw] requests
|
@@ -1792,8 +1800,8 @@ module Google
|
|
1792
1800
|
# @!attribute [rw] parent
|
1793
1801
|
# @return [::String]
|
1794
1802
|
# Required. The account or property that owns the access bindings. The parent
|
1795
|
-
#
|
1796
|
-
# match this field. Formats:
|
1803
|
+
# of all provided values for the 'names' field in DeleteAccessBindingRequest
|
1804
|
+
# messages must match this field. Formats:
|
1797
1805
|
# - accounts/\\{account}
|
1798
1806
|
# - properties/\\{property}
|
1799
1807
|
# @!attribute [rw] requests
|
@@ -1978,6 +1986,93 @@ module Google
|
|
1978
1986
|
include ::Google::Protobuf::MessageExts
|
1979
1987
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1980
1988
|
end
|
1989
|
+
|
1990
|
+
# Request message for GetEnhancedMeasurementSettings RPC.
|
1991
|
+
# @!attribute [rw] name
|
1992
|
+
# @return [::String]
|
1993
|
+
# Required. The name of the settings to lookup.
|
1994
|
+
# Format:
|
1995
|
+
# properties/\\{property}/dataStreams/\\{data_stream}/enhancedMeasurementSettings
|
1996
|
+
# Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
1997
|
+
class GetEnhancedMeasurementSettingsRequest
|
1998
|
+
include ::Google::Protobuf::MessageExts
|
1999
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2000
|
+
end
|
2001
|
+
|
2002
|
+
# Request message for UpdateEnhancedMeasurementSettings RPC.
|
2003
|
+
# @!attribute [rw] enhanced_measurement_settings
|
2004
|
+
# @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
2005
|
+
# Required. The settings to update.
|
2006
|
+
# The `name` field is used to identify the settings to be updated.
|
2007
|
+
# @!attribute [rw] update_mask
|
2008
|
+
# @return [::Google::Protobuf::FieldMask]
|
2009
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
2010
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
2011
|
+
# replace the entire entity, use one path with the string "*" to match all
|
2012
|
+
# fields.
|
2013
|
+
class UpdateEnhancedMeasurementSettingsRequest
|
2014
|
+
include ::Google::Protobuf::MessageExts
|
2015
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2016
|
+
end
|
2017
|
+
|
2018
|
+
# Request message for CreateConnectedSiteTag RPC.
|
2019
|
+
# @!attribute [rw] property
|
2020
|
+
# @return [::String]
|
2021
|
+
# The Universal Analytics property to create connected site tags for.
|
2022
|
+
# This API does not support GA4 properties.
|
2023
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
2024
|
+
# Example: properties/1234
|
2025
|
+
# @!attribute [rw] connected_site_tag
|
2026
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConnectedSiteTag]
|
2027
|
+
# Required. The tag to add to the Universal Analytics property
|
2028
|
+
class CreateConnectedSiteTagRequest
|
2029
|
+
include ::Google::Protobuf::MessageExts
|
2030
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2031
|
+
end
|
2032
|
+
|
2033
|
+
# Response message for CreateConnectedSiteTag RPC.
|
2034
|
+
class CreateConnectedSiteTagResponse
|
2035
|
+
include ::Google::Protobuf::MessageExts
|
2036
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2037
|
+
end
|
2038
|
+
|
2039
|
+
# Request message for DeleteConnectedSiteTag RPC.
|
2040
|
+
# @!attribute [rw] property
|
2041
|
+
# @return [::String]
|
2042
|
+
# The Universal Analytics property to delete connected site tags for.
|
2043
|
+
# This API does not support GA4 properties.
|
2044
|
+
# Format: properties/\\{universalAnalyticsPropertyId}
|
2045
|
+
# Example: properties/1234
|
2046
|
+
# @!attribute [rw] tag_id
|
2047
|
+
# @return [::String]
|
2048
|
+
# Tag ID to forward events to. Also known as the Measurement ID, or the
|
2049
|
+
# "G-ID" (For example: G-12345).
|
2050
|
+
class DeleteConnectedSiteTagRequest
|
2051
|
+
include ::Google::Protobuf::MessageExts
|
2052
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2053
|
+
end
|
2054
|
+
|
2055
|
+
# Request message for ListConnectedSiteTags RPC.
|
2056
|
+
# @!attribute [rw] property
|
2057
|
+
# @return [::String]
|
2058
|
+
# The Universal Analytics property to fetch connected site tags for.
|
2059
|
+
# This does not work on GA4 properties. A maximum of 20 connected site tags
|
2060
|
+
# will be returned.
|
2061
|
+
# Example Format: `properties/1234`
|
2062
|
+
class ListConnectedSiteTagsRequest
|
2063
|
+
include ::Google::Protobuf::MessageExts
|
2064
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2065
|
+
end
|
2066
|
+
|
2067
|
+
# Response message for ListConnectedSiteTags RPC.
|
2068
|
+
# @!attribute [rw] connected_site_tags
|
2069
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ConnectedSiteTag>]
|
2070
|
+
# The site tags for the Universal Analytics property. A maximum of 20
|
2071
|
+
# connected site tags will be returned.
|
2072
|
+
class ListConnectedSiteTagsResponse
|
2073
|
+
include ::Google::Protobuf::MessageExts
|
2074
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
2075
|
+
end
|
1981
2076
|
end
|
1982
2077
|
end
|
1983
2078
|
end
|