google-analytics-admin-v1alpha 0.3.0 → 0.4.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/analytics_admin_pb.rb +4 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +41 -27
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +0 -14
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +4 -11
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +44 -9
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +19 -51
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e32852bbcc1562112cba21edd419039aad815748490414587a1edbf580ab1771
|
4
|
+
data.tar.gz: 4fef8c3b9a2ac6c3c9d48f6ed513b412235e0b536d896db4dbcff5955ed5f7ba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 386b01797bd722053cbb321cd0720dc3e3ce9c3ffae0ad8c8595e3c5d628d15837abff83a04be9e33103c08eb61843dfa7cc19713d7977b62af26797ff83ac79
|
7
|
+
data.tar.gz: 4214abd44d02bd59db7670c98f5383d3ce127b61b7c90b0eaa7b74d377531140f151157392c75959e4637e04981c652ec8261e4c4befd74dcb61795622f63260
|
@@ -10,6 +10,7 @@ require 'google/api/field_behavior_pb'
|
|
10
10
|
require 'google/api/resource_pb'
|
11
11
|
require 'google/protobuf/empty_pb'
|
12
12
|
require 'google/protobuf/field_mask_pb'
|
13
|
+
require 'google/protobuf/timestamp_pb'
|
13
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
15
|
add_file("google/analytics/admin/v1alpha/analytics_admin.proto", :syntax => :proto3) do
|
15
16
|
add_message "google.analytics.admin.v1alpha.GetAccountRequest" do
|
@@ -208,9 +209,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
208
209
|
end
|
209
210
|
add_message "google.analytics.admin.v1alpha.ListFirebaseLinksRequest" do
|
210
211
|
optional :parent, :string, 1
|
212
|
+
optional :page_size, :int32, 2
|
213
|
+
optional :page_token, :string, 3
|
211
214
|
end
|
212
215
|
add_message "google.analytics.admin.v1alpha.ListFirebaseLinksResponse" do
|
213
216
|
repeated :firebase_links, :message, 1, "google.analytics.admin.v1alpha.FirebaseLink"
|
217
|
+
optional :next_page_token, :string, 2
|
214
218
|
end
|
215
219
|
add_message "google.analytics.admin.v1alpha.GetGlobalSiteTagRequest" do
|
216
220
|
optional :name, :string, 1
|
@@ -244,8 +244,6 @@ module Google
|
|
244
244
|
|
245
245
|
##
|
246
246
|
# Lookup for a single Account.
|
247
|
-
# Throws "Target not found" if no such account found, or if caller does not
|
248
|
-
# have permissions to access it.
|
249
247
|
#
|
250
248
|
# @overload get_account(request, options = nil)
|
251
249
|
# Pass arguments to `get_account` via a request object, either of type
|
@@ -489,7 +487,9 @@ module Google
|
|
489
487
|
# Required. The account to update.
|
490
488
|
# The account's `name` field is used to identify the account.
|
491
489
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
492
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
490
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
491
|
+
# To replace the entire entity, use one path with the string "*" to match
|
492
|
+
# all fields.
|
493
493
|
#
|
494
494
|
# @yield [response, operation] Access the result along with the RPC operation
|
495
495
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Account]
|
@@ -671,9 +671,6 @@ module Google
|
|
671
671
|
##
|
672
672
|
# Lookup for a single "GA4" Property.
|
673
673
|
#
|
674
|
-
# Throws "Target not found" if no such property found, if property is not
|
675
|
-
# of the type "GA4", or if caller does not have permissions to access it.
|
676
|
-
#
|
677
674
|
# @overload get_property(request, options = nil)
|
678
675
|
# Pass arguments to `get_property` via a request object, either of type
|
679
676
|
# {::Google::Analytics::Admin::V1alpha::GetPropertyRequest} or an equivalent Hash.
|
@@ -769,11 +766,13 @@ module Google
|
|
769
766
|
# `firebase_project:`(The id or number of the linked firebase project).
|
770
767
|
# Some examples of filters:
|
771
768
|
#
|
769
|
+
# ```
|
772
770
|
# | Filter | Description |
|
773
771
|
# |-----------------------------|-------------------------------------------|
|
774
772
|
# | parent:accounts/123 | The account with account id: 123. |
|
775
773
|
# | firebase_project:project-id | The firebase project with id: project-id. |
|
776
774
|
# | firebase_project:123 | The firebase project with number: 123. |
|
775
|
+
# ```
|
777
776
|
# @param page_size [::Integer]
|
778
777
|
# The maximum number of resources to return. The service may return
|
779
778
|
# fewer than this value, even if there are additional pages.
|
@@ -991,7 +990,9 @@ module Google
|
|
991
990
|
# The property's `name` field is used to identify the property to be
|
992
991
|
# updated.
|
993
992
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
994
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
993
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
994
|
+
# To replace the entire entity, use one path with the string "*" to match
|
995
|
+
# all fields.
|
995
996
|
#
|
996
997
|
# @yield [response, operation] Access the result along with the RPC operation
|
997
998
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Property]
|
@@ -1772,9 +1773,6 @@ module Google
|
|
1772
1773
|
##
|
1773
1774
|
# Lookup for a single WebDataStream
|
1774
1775
|
#
|
1775
|
-
# Throws "Target not found" if no such web data stream found, or if the
|
1776
|
-
# caller does not have permissions to access it.
|
1777
|
-
#
|
1778
1776
|
# @overload get_web_data_stream(request, options = nil)
|
1779
1777
|
# Pass arguments to `get_web_data_stream` via a request object, either of type
|
1780
1778
|
# {::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest} or an equivalent Hash.
|
@@ -1930,7 +1928,9 @@ module Google
|
|
1930
1928
|
# Required. The web stream to update.
|
1931
1929
|
# The `name` field is used to identify the web stream to be updated.
|
1932
1930
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1933
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
1931
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1932
|
+
# To replace the entire entity, use one path with the string "*" to match
|
1933
|
+
# all fields.
|
1934
1934
|
#
|
1935
1935
|
# @yield [response, operation] Access the result along with the RPC operation
|
1936
1936
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::WebDataStream]
|
@@ -2130,9 +2130,6 @@ module Google
|
|
2130
2130
|
##
|
2131
2131
|
# Lookup for a single IosAppDataStream
|
2132
2132
|
#
|
2133
|
-
# Throws "Target not found" if no such iOS app data stream found, or if the
|
2134
|
-
# caller does not have permissions to access it.
|
2135
|
-
#
|
2136
2133
|
# @overload get_ios_app_data_stream(request, options = nil)
|
2137
2134
|
# Pass arguments to `get_ios_app_data_stream` via a request object, either of type
|
2138
2135
|
# {::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest} or an equivalent Hash.
|
@@ -2288,7 +2285,9 @@ module Google
|
|
2288
2285
|
# Required. The iOS app stream to update.
|
2289
2286
|
# The `name` field is used to identify the iOS app stream to be updated.
|
2290
2287
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2291
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
2288
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
2289
|
+
# To replace the entire entity, use one path with the string "*" to match
|
2290
|
+
# all fields.
|
2292
2291
|
#
|
2293
2292
|
# @yield [response, operation] Access the result along with the RPC operation
|
2294
2293
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
|
@@ -2488,9 +2487,6 @@ module Google
|
|
2488
2487
|
##
|
2489
2488
|
# Lookup for a single AndroidAppDataStream
|
2490
2489
|
#
|
2491
|
-
# Throws "Target not found" if no such android app data stream found, or if
|
2492
|
-
# the caller does not have permissions to access it.
|
2493
|
-
#
|
2494
2490
|
# @overload get_android_app_data_stream(request, options = nil)
|
2495
2491
|
# Pass arguments to `get_android_app_data_stream` via a request object, either of type
|
2496
2492
|
# {::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest} or an equivalent Hash.
|
@@ -2646,7 +2642,9 @@ module Google
|
|
2646
2642
|
# Required. The android app stream to update.
|
2647
2643
|
# The `name` field is used to identify the android app stream to be updated.
|
2648
2644
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2649
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
2645
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
2646
|
+
# To replace the entire entity, use one path with the string "*" to match
|
2647
|
+
# all fields.
|
2650
2648
|
#
|
2651
2649
|
# @yield [response, operation] Access the result along with the RPC operation
|
2652
2650
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
|
@@ -2868,7 +2866,6 @@ module Google
|
|
2868
2866
|
# @param name [::String]
|
2869
2867
|
# Required. The name of the settings to lookup.
|
2870
2868
|
# Format:
|
2871
|
-
#
|
2872
2869
|
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
2873
2870
|
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
2874
2871
|
#
|
@@ -2941,7 +2938,9 @@ module Google
|
|
2941
2938
|
# Required. The settings to update.
|
2942
2939
|
# The `name` field is used to identify the settings to be updated.
|
2943
2940
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2944
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
2941
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
2942
|
+
# To replace the entire entity, use one path with the string "*" to match
|
2943
|
+
# all fields.
|
2945
2944
|
#
|
2946
2945
|
# @yield [response, operation] Access the result along with the RPC operation
|
2947
2946
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
|
@@ -3080,7 +3079,9 @@ module Google
|
|
3080
3079
|
# @param firebase_link [::Google::Analytics::Admin::V1alpha::FirebaseLink, ::Hash]
|
3081
3080
|
# Required. The Firebase link to update.
|
3082
3081
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
3083
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
3082
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
3083
|
+
# To replace the entire entity, use one path with the string "*" to match
|
3084
|
+
# all fields.
|
3084
3085
|
#
|
3085
3086
|
# @yield [response, operation] Access the result along with the RPC operation
|
3086
3087
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::FirebaseLink]
|
@@ -3208,7 +3209,7 @@ module Google
|
|
3208
3209
|
# @param options [::Gapic::CallOptions, ::Hash]
|
3209
3210
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3210
3211
|
#
|
3211
|
-
# @overload list_firebase_links(parent: nil)
|
3212
|
+
# @overload list_firebase_links(parent: nil, page_size: nil, page_token: nil)
|
3212
3213
|
# Pass arguments to `list_firebase_links` via keyword arguments. Note that at
|
3213
3214
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
3214
3215
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -3216,12 +3217,22 @@ module Google
|
|
3216
3217
|
# @param parent [::String]
|
3217
3218
|
# Required. Format: properties/\\{property_id}
|
3218
3219
|
# Example: properties/1234
|
3220
|
+
# @param page_size [::Integer]
|
3221
|
+
# The maximum number of resources to return. The service may return
|
3222
|
+
# fewer than this value, even if there are additional pages.
|
3223
|
+
# If unspecified, at most 50 resources will be returned.
|
3224
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
3225
|
+
# @param page_token [::String]
|
3226
|
+
# A page token, received from a previous `ListFirebaseLinks` call.
|
3227
|
+
# Provide this to retrieve the subsequent page.
|
3228
|
+
# When paginating, all other parameters provided to `ListProperties` must
|
3229
|
+
# match the call that provided the page token.
|
3219
3230
|
#
|
3220
3231
|
# @yield [response, operation] Access the result along with the RPC operation
|
3221
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
3232
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>]
|
3222
3233
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3223
3234
|
#
|
3224
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
3235
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>]
|
3225
3236
|
#
|
3226
3237
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3227
3238
|
#
|
@@ -3255,6 +3266,7 @@ module Google
|
|
3255
3266
|
retry_policy: @config.retry_policy
|
3256
3267
|
|
3257
3268
|
@analytics_admin_service_stub.call_rpc :list_firebase_links, request, options: options do |response, operation|
|
3269
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_firebase_links, request, response, operation, options
|
3258
3270
|
yield response, operation if block_given?
|
3259
3271
|
return response
|
3260
3272
|
end
|
@@ -3421,7 +3433,9 @@ module Google
|
|
3421
3433
|
# @param google_ads_link [::Google::Analytics::Admin::V1alpha::GoogleAdsLink, ::Hash]
|
3422
3434
|
# The GoogleAdsLink to update
|
3423
3435
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
3424
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
3436
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
3437
|
+
# To replace the entire entity, use one path with the string "*" to match
|
3438
|
+
# all fields.
|
3425
3439
|
#
|
3426
3440
|
# @yield [response, operation] Access the result along with the RPC operation
|
3427
3441
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
|
@@ -3805,7 +3819,7 @@ module Google
|
|
3805
3819
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
3806
3820
|
# the following configuration fields:
|
3807
3821
|
#
|
3808
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
3822
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
3809
3823
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
3810
3824
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
3811
3825
|
# include the following keys:
|
@@ -34,8 +34,6 @@ module Google
|
|
34
34
|
self.service_name = 'google.analytics.admin.v1alpha.AnalyticsAdminService'
|
35
35
|
|
36
36
|
# Lookup for a single Account.
|
37
|
-
# Throws "Target not found" if no such account found, or if caller does not
|
38
|
-
# have permissions to access it.
|
39
37
|
rpc :GetAccount, ::Google::Analytics::Admin::V1alpha::GetAccountRequest, ::Google::Analytics::Admin::V1alpha::Account
|
40
38
|
# Returns all accounts accessible by the caller.
|
41
39
|
#
|
@@ -62,9 +60,6 @@ module Google
|
|
62
60
|
# Returns summaries of all accounts accessible by the caller.
|
63
61
|
rpc :ListAccountSummaries, ::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest, ::Google::Analytics::Admin::V1alpha::ListAccountSummariesResponse
|
64
62
|
# Lookup for a single "GA4" Property.
|
65
|
-
#
|
66
|
-
# Throws "Target not found" if no such property found, if property is not
|
67
|
-
# of the type "GA4", or if caller does not have permissions to access it.
|
68
63
|
rpc :GetProperty, ::Google::Analytics::Admin::V1alpha::GetPropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
|
69
64
|
# Returns child Properties under the specified parent Account.
|
70
65
|
#
|
@@ -125,9 +120,6 @@ module Google
|
|
125
120
|
# Deletes information about multiple users' links to an account or property.
|
126
121
|
rpc :BatchDeleteUserLinks, ::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, ::Google::Protobuf::Empty
|
127
122
|
# Lookup for a single WebDataStream
|
128
|
-
#
|
129
|
-
# Throws "Target not found" if no such web data stream found, or if the
|
130
|
-
# caller does not have permissions to access it.
|
131
123
|
rpc :GetWebDataStream, ::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest, ::Google::Analytics::Admin::V1alpha::WebDataStream
|
132
124
|
# Deletes a web stream on a property.
|
133
125
|
rpc :DeleteWebDataStream, ::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest, ::Google::Protobuf::Empty
|
@@ -141,9 +133,6 @@ module Google
|
|
141
133
|
# Returns an empty list if no relevant web data streams are found.
|
142
134
|
rpc :ListWebDataStreams, ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsResponse
|
143
135
|
# Lookup for a single IosAppDataStream
|
144
|
-
#
|
145
|
-
# Throws "Target not found" if no such iOS app data stream found, or if the
|
146
|
-
# caller does not have permissions to access it.
|
147
136
|
rpc :GetIosAppDataStream, ::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
|
148
137
|
# Deletes an iOS app stream on a property.
|
149
138
|
rpc :DeleteIosAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, ::Google::Protobuf::Empty
|
@@ -157,9 +146,6 @@ module Google
|
|
157
146
|
# Returns an empty list if no relevant iOS app data streams are found.
|
158
147
|
rpc :ListIosAppDataStreams, ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest, ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsResponse
|
159
148
|
# Lookup for a single AndroidAppDataStream
|
160
|
-
#
|
161
|
-
# Throws "Target not found" if no such android app data stream found, or if
|
162
|
-
# the caller does not have permissions to access it.
|
163
149
|
rpc :GetAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
|
164
150
|
# Deletes an android app stream on a property.
|
165
151
|
rpc :DeleteAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, ::Google::Protobuf::Empty
|
@@ -14,7 +14,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
14
14
|
optional :create_time, :message, 2, "google.protobuf.Timestamp"
|
15
15
|
optional :update_time, :message, 3, "google.protobuf.Timestamp"
|
16
16
|
optional :display_name, :string, 4
|
17
|
-
optional :
|
17
|
+
optional :region_code, :string, 5
|
18
18
|
optional :deleted, :bool, 6
|
19
19
|
end
|
20
20
|
add_message "google.analytics.admin.v1alpha.Property" do
|
@@ -70,19 +70,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
70
70
|
optional :page_views_enabled, :bool, 3
|
71
71
|
optional :scrolls_enabled, :bool, 4
|
72
72
|
optional :outbound_clicks_enabled, :bool, 5
|
73
|
-
optional :content_views_enabled, :bool, 6
|
74
73
|
optional :site_search_enabled, :bool, 7
|
75
|
-
optional :form_interactions_enabled, :bool, 8
|
76
74
|
optional :video_engagement_enabled, :bool, 9
|
77
75
|
optional :file_downloads_enabled, :bool, 10
|
78
|
-
optional :data_tagged_element_clicks_enabled, :bool, 11
|
79
76
|
optional :page_loads_enabled, :bool, 12
|
80
77
|
optional :page_changes_enabled, :bool, 13
|
81
|
-
optional :articles_and_blogs_enabled, :bool, 14
|
82
|
-
optional :products_and_ecommerce_enabled, :bool, 15
|
83
78
|
optional :search_query_parameter, :string, 16
|
84
|
-
optional :
|
85
|
-
optional :excluded_domains, :string, 18
|
79
|
+
optional :uri_query_parameter, :string, 17
|
86
80
|
end
|
87
81
|
add_message "google.analytics.admin.v1alpha.FirebaseLink" do
|
88
82
|
optional :name, :string, 1
|
@@ -91,12 +85,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
91
85
|
optional :maximum_user_access, :enum, 4, "google.analytics.admin.v1alpha.MaximumUserAccess"
|
92
86
|
end
|
93
87
|
add_message "google.analytics.admin.v1alpha.GlobalSiteTag" do
|
94
|
-
optional :
|
95
|
-
optional :
|
88
|
+
optional :name, :string, 1
|
89
|
+
optional :snippet, :string, 2
|
96
90
|
end
|
97
91
|
add_message "google.analytics.admin.v1alpha.GoogleAdsLink" do
|
98
92
|
optional :name, :string, 1
|
99
|
-
optional :parent, :string, 2
|
100
93
|
optional :customer_id, :string, 3
|
101
94
|
optional :can_manage_clients, :bool, 4
|
102
95
|
optional :ads_personalization_enabled, :message, 5, "google.protobuf.BoolValue"
|
@@ -86,7 +86,9 @@ module Google
|
|
86
86
|
# The account's `name` field is used to identify the account.
|
87
87
|
# @!attribute [rw] update_mask
|
88
88
|
# @return [::Google::Protobuf::FieldMask]
|
89
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
89
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
90
|
+
# To replace the entire entity, use one path with the string "*" to match
|
91
|
+
# all fields.
|
90
92
|
class UpdateAccountRequest
|
91
93
|
include ::Google::Protobuf::MessageExts
|
92
94
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -134,11 +136,13 @@ module Google
|
|
134
136
|
# `firebase_project:`(The id or number of the linked firebase project).
|
135
137
|
# Some examples of filters:
|
136
138
|
#
|
139
|
+
# ```
|
137
140
|
# | Filter | Description |
|
138
141
|
# |-----------------------------|-------------------------------------------|
|
139
142
|
# | parent:accounts/123 | The account with account id: 123. |
|
140
143
|
# | firebase_project:project-id | The firebase project with id: project-id. |
|
141
144
|
# | firebase_project:123 | The firebase project with number: 123. |
|
145
|
+
# ```
|
142
146
|
# @!attribute [rw] page_size
|
143
147
|
# @return [::Integer]
|
144
148
|
# The maximum number of resources to return. The service may return
|
@@ -182,7 +186,9 @@ module Google
|
|
182
186
|
# updated.
|
183
187
|
# @!attribute [rw] update_mask
|
184
188
|
# @return [::Google::Protobuf::FieldMask]
|
185
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
189
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
190
|
+
# To replace the entire entity, use one path with the string "*" to match
|
191
|
+
# all fields.
|
186
192
|
class UpdatePropertyRequest
|
187
193
|
include ::Google::Protobuf::MessageExts
|
188
194
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -454,7 +460,9 @@ module Google
|
|
454
460
|
# The `name` field is used to identify the web stream to be updated.
|
455
461
|
# @!attribute [rw] update_mask
|
456
462
|
# @return [::Google::Protobuf::FieldMask]
|
457
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
463
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
464
|
+
# To replace the entire entity, use one path with the string "*" to match
|
465
|
+
# all fields.
|
458
466
|
class UpdateWebDataStreamRequest
|
459
467
|
include ::Google::Protobuf::MessageExts
|
460
468
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -537,7 +545,9 @@ module Google
|
|
537
545
|
# The `name` field is used to identify the iOS app stream to be updated.
|
538
546
|
# @!attribute [rw] update_mask
|
539
547
|
# @return [::Google::Protobuf::FieldMask]
|
540
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
548
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
549
|
+
# To replace the entire entity, use one path with the string "*" to match
|
550
|
+
# all fields.
|
541
551
|
class UpdateIosAppDataStreamRequest
|
542
552
|
include ::Google::Protobuf::MessageExts
|
543
553
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -620,7 +630,9 @@ module Google
|
|
620
630
|
# The `name` field is used to identify the android app stream to be updated.
|
621
631
|
# @!attribute [rw] update_mask
|
622
632
|
# @return [::Google::Protobuf::FieldMask]
|
623
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
633
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
634
|
+
# To replace the entire entity, use one path with the string "*" to match
|
635
|
+
# all fields.
|
624
636
|
class UpdateAndroidAppDataStreamRequest
|
625
637
|
include ::Google::Protobuf::MessageExts
|
626
638
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -681,7 +693,6 @@ module Google
|
|
681
693
|
# @return [::String]
|
682
694
|
# Required. The name of the settings to lookup.
|
683
695
|
# Format:
|
684
|
-
#
|
685
696
|
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
686
697
|
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
687
698
|
class GetEnhancedMeasurementSettingsRequest
|
@@ -696,7 +707,9 @@ module Google
|
|
696
707
|
# The `name` field is used to identify the settings to be updated.
|
697
708
|
# @!attribute [rw] update_mask
|
698
709
|
# @return [::Google::Protobuf::FieldMask]
|
699
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
710
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
711
|
+
# To replace the entire entity, use one path with the string "*" to match
|
712
|
+
# all fields.
|
700
713
|
class UpdateEnhancedMeasurementSettingsRequest
|
701
714
|
include ::Google::Protobuf::MessageExts
|
702
715
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -721,7 +734,9 @@ module Google
|
|
721
734
|
# Required. The Firebase link to update.
|
722
735
|
# @!attribute [rw] update_mask
|
723
736
|
# @return [::Google::Protobuf::FieldMask]
|
724
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
737
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
738
|
+
# To replace the entire entity, use one path with the string "*" to match
|
739
|
+
# all fields.
|
725
740
|
class UpdateFirebaseLinkRequest
|
726
741
|
include ::Google::Protobuf::MessageExts
|
727
742
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -742,6 +757,18 @@ module Google
|
|
742
757
|
# @return [::String]
|
743
758
|
# Required. Format: properties/\\{property_id}
|
744
759
|
# Example: properties/1234
|
760
|
+
# @!attribute [rw] page_size
|
761
|
+
# @return [::Integer]
|
762
|
+
# The maximum number of resources to return. The service may return
|
763
|
+
# fewer than this value, even if there are additional pages.
|
764
|
+
# If unspecified, at most 50 resources will be returned.
|
765
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
766
|
+
# @!attribute [rw] page_token
|
767
|
+
# @return [::String]
|
768
|
+
# A page token, received from a previous `ListFirebaseLinks` call.
|
769
|
+
# Provide this to retrieve the subsequent page.
|
770
|
+
# When paginating, all other parameters provided to `ListProperties` must
|
771
|
+
# match the call that provided the page token.
|
745
772
|
class ListFirebaseLinksRequest
|
746
773
|
include ::Google::Protobuf::MessageExts
|
747
774
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -751,6 +778,12 @@ module Google
|
|
751
778
|
# @!attribute [rw] firebase_links
|
752
779
|
# @return [::Array<::Google::Analytics::Admin::V1alpha::FirebaseLink>]
|
753
780
|
# List of FirebaseLinks. This will have at most one value.
|
781
|
+
# @!attribute [rw] next_page_token
|
782
|
+
# @return [::String]
|
783
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
784
|
+
# If this field is omitted, there are no subsequent pages.
|
785
|
+
# Currently, Google Analytics supports only one FirebaseLink per property,
|
786
|
+
# so this will never be populated.
|
754
787
|
class ListFirebaseLinksResponse
|
755
788
|
include ::Google::Protobuf::MessageExts
|
756
789
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -786,7 +819,9 @@ module Google
|
|
786
819
|
# The GoogleAdsLink to update
|
787
820
|
# @!attribute [rw] update_mask
|
788
821
|
# @return [::Google::Protobuf::FieldMask]
|
789
|
-
# The list of fields to be updated. Omitted fields will not be updated.
|
822
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
823
|
+
# To replace the entire entity, use one path with the string "*" to match
|
824
|
+
# all fields.
|
790
825
|
class UpdateGoogleAdsLinkRequest
|
791
826
|
include ::Google::Protobuf::MessageExts
|
792
827
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -36,13 +36,9 @@ module Google
|
|
36
36
|
# @!attribute [rw] display_name
|
37
37
|
# @return [::String]
|
38
38
|
# Required. Human-readable display name for this account.
|
39
|
-
# @!attribute [rw]
|
39
|
+
# @!attribute [rw] region_code
|
40
40
|
# @return [::String]
|
41
|
-
# Country of business. Must be a
|
42
|
-
#
|
43
|
-
# https:
|
44
|
-
# //unicode.org/cldr/charts/latest/supplem
|
45
|
-
# // ental/territory_containment_un_m_49.html
|
41
|
+
# Country of business. Must be a Unicode CLDR region code.
|
46
42
|
# @!attribute [r] deleted
|
47
43
|
# @return [::Boolean]
|
48
44
|
# Output only. Indicates whether this Account is soft-deleted or not. Deleted
|
@@ -100,9 +96,8 @@ module Google
|
|
100
96
|
# Examples: "USD", "EUR", "JPY"
|
101
97
|
# @!attribute [r] deleted
|
102
98
|
# @return [::Boolean]
|
103
|
-
# Output only. Indicates whether this Property is soft-deleted or not.
|
104
|
-
#
|
105
|
-
# requested.
|
99
|
+
# Output only. Indicates whether this Property is soft-deleted or not. Deleted properties
|
100
|
+
# are excluded from List results unless specifically requested.
|
106
101
|
class Property
|
107
102
|
include ::Google::Protobuf::MessageExts
|
108
103
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -262,7 +257,6 @@ module Google
|
|
262
257
|
# @return [::String]
|
263
258
|
# Output only. Resource name of this Data Stream.
|
264
259
|
# Format:
|
265
|
-
#
|
266
260
|
# properties/\\{property_id}/webDataStreams/\\{stream_id}/enhancedMeasurementSettings
|
267
261
|
# Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
268
262
|
# @!attribute [rw] stream_enabled
|
@@ -274,8 +268,8 @@ module Google
|
|
274
268
|
# whether they are respected.
|
275
269
|
# @!attribute [r] page_views_enabled
|
276
270
|
# @return [::Boolean]
|
277
|
-
# Output only. If enabled, capture a page view event each time a page loads
|
278
|
-
#
|
271
|
+
# Output only. If enabled, capture a page view event each time a page loads or the
|
272
|
+
# website changes the browser history state.
|
279
273
|
# @!attribute [rw] scrolls_enabled
|
280
274
|
# @return [::Boolean]
|
281
275
|
# If enabled, capture scroll events each time a visitor gets to the bottom of
|
@@ -284,18 +278,10 @@ module Google
|
|
284
278
|
# @return [::Boolean]
|
285
279
|
# If enabled, capture an outbound click event each time a visitor clicks a
|
286
280
|
# link that leads them away from your domain.
|
287
|
-
# @!attribute [rw] content_views_enabled
|
288
|
-
# @return [::Boolean]
|
289
|
-
# Capture events when your visitors view content on your site that has
|
290
|
-
# structured data (eg, articles, blog posts, product details screens, etc.).
|
291
281
|
# @!attribute [rw] site_search_enabled
|
292
282
|
# @return [::Boolean]
|
293
283
|
# If enabled, capture a view search results event each time a visitor
|
294
284
|
# performs a search on your site (based on a query parameter).
|
295
|
-
# @!attribute [rw] form_interactions_enabled
|
296
|
-
# @return [::Boolean]
|
297
|
-
# If enabled, capture a view search results event each time a visitor
|
298
|
-
# interacts with a form on your site.
|
299
285
|
# @!attribute [rw] video_engagement_enabled
|
300
286
|
# @return [::Boolean]
|
301
287
|
# If enabled, capture video play, progress, and complete events as visitors
|
@@ -304,36 +290,21 @@ module Google
|
|
304
290
|
# @return [::Boolean]
|
305
291
|
# If enabled, capture a file download event each time a link is clicked with
|
306
292
|
# a common document, compressed file, application, video, or audio extension.
|
307
|
-
# @!attribute [
|
308
|
-
# @return [::Boolean]
|
309
|
-
# If enabled, capture a click event each time a visitor clicks a link or
|
310
|
-
# element that has data attributes beginning with "data-ga".
|
311
|
-
# @!attribute [rw] page_loads_enabled
|
293
|
+
# @!attribute [r] page_loads_enabled
|
312
294
|
# @return [::Boolean]
|
313
|
-
# If enabled, capture a page view event each time a page loads.
|
295
|
+
# Output only. If enabled, capture a page view event each time a page loads.
|
314
296
|
# @!attribute [rw] page_changes_enabled
|
315
297
|
# @return [::Boolean]
|
316
298
|
# If enabled, capture a page view event each time the website changes the
|
317
299
|
# browser history state.
|
318
|
-
# @!attribute [rw] articles_and_blogs_enabled
|
319
|
-
# @return [::Boolean]
|
320
|
-
# Capture events when your visitors view content on your site that has
|
321
|
-
# articles or blog posts.
|
322
|
-
# @!attribute [rw] products_and_ecommerce_enabled
|
323
|
-
# @return [::Boolean]
|
324
|
-
# Capture events when your visitors view content on your site that has
|
325
|
-
# product details screens, etc.
|
326
300
|
# @!attribute [rw] search_query_parameter
|
327
301
|
# @return [::String]
|
328
302
|
# Required. URL query parameters to interpret as site search parameters.
|
329
303
|
# Max length is 1024 characters. Must not be empty.
|
330
|
-
# @!attribute [rw]
|
304
|
+
# @!attribute [rw] uri_query_parameter
|
331
305
|
# @return [::String]
|
332
306
|
# Additional URL query parameters.
|
333
307
|
# Max length is 1024 characters.
|
334
|
-
# @!attribute [rw] excluded_domains
|
335
|
-
# @return [::String]
|
336
|
-
# Domains to exclude from measurement. Max length is 1024 characters.
|
337
308
|
class EnhancedMeasurementSettings
|
338
309
|
include ::Google::Protobuf::MessageExts
|
339
310
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -345,9 +316,9 @@ module Google
|
|
345
316
|
# Output only. Example format: properties/1234/firebaseLinks/5678
|
346
317
|
# @!attribute [rw] project
|
347
318
|
# @return [::String]
|
348
|
-
# Immutable. Firebase project resource name. When creating a FirebaseLink,
|
349
|
-
#
|
350
|
-
#
|
319
|
+
# Immutable. Firebase project resource name. When creating a FirebaseLink, you may
|
320
|
+
# provide this resource name using either a project number or project ID.
|
321
|
+
# Once this resource has been created, returned FirebaseLinks will always
|
351
322
|
# have a project_name that contains a project number.
|
352
323
|
#
|
353
324
|
# Format: 'projects/\\{project number}'
|
@@ -366,13 +337,14 @@ module Google
|
|
366
337
|
|
367
338
|
# Read-only resource with the tag for sending data from a website to a
|
368
339
|
# WebDataStream.
|
369
|
-
# @!attribute [
|
340
|
+
# @!attribute [r] name
|
370
341
|
# @return [::String]
|
371
|
-
#
|
372
|
-
#
|
373
|
-
# @!attribute [rw]
|
342
|
+
# Output only. Resource name for this GlobalSiteTag resource.
|
343
|
+
# Format: properties/\\{propertyId}/globalSiteTag
|
344
|
+
# @!attribute [rw] snippet
|
374
345
|
# @return [::String]
|
375
|
-
#
|
346
|
+
# Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
|
347
|
+
# every webpage to measure.
|
376
348
|
class GlobalSiteTag
|
377
349
|
include ::Google::Protobuf::MessageExts
|
378
350
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -381,13 +353,9 @@ module Google
|
|
381
353
|
# A link between an GA4 property and a Google Ads account.
|
382
354
|
# @!attribute [r] name
|
383
355
|
# @return [::String]
|
384
|
-
# Output only. Format:
|
385
|
-
# properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
|
356
|
+
# Output only. Format: properties/\\{propertyId}/googleAdsLinks/\\{googleAdsLinkId}
|
386
357
|
#
|
387
358
|
# Note: googleAdsLinkId is not the Google Ads customer ID.
|
388
|
-
# @!attribute [rw] parent
|
389
|
-
# @return [::String]
|
390
|
-
# Immutable. Format: properties/\\{propertyId}
|
391
359
|
# @!attribute [rw] customer_id
|
392
360
|
# @return [::String]
|
393
361
|
# Immutable. Google Ads customer ID.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-analytics-admin-v1alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-01-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
200
200
|
- !ruby/object:Gem::Version
|
201
201
|
version: '0'
|
202
202
|
requirements: []
|
203
|
-
rubygems_version: 3.
|
203
|
+
rubygems_version: 3.2.6
|
204
204
|
signing_key:
|
205
205
|
specification_version: 4
|
206
206
|
summary: API Client library for the Google Analytics Admin V1alpha API
|