google-analytics-admin-v1alpha 0.6.0 → 0.8.2
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/AUTHENTICATION.md +8 -8
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +137 -10
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +2017 -336
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +78 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +49 -21
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +139 -1
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +399 -26
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +403 -9
- data/proto_docs/google/api/field_behavior.rb +7 -1
- metadata +13 -7
@@ -55,6 +55,51 @@ module Google
|
|
55
55
|
"properties/#{property}/androidAppDataStreams/#{android_app_data_stream}"
|
56
56
|
end
|
57
57
|
|
58
|
+
##
|
59
|
+
# Create a fully-qualified ConversionEvent resource string.
|
60
|
+
#
|
61
|
+
# The resource will be in the following format:
|
62
|
+
#
|
63
|
+
# `properties/{property}/conversionEvents/{conversion_event}`
|
64
|
+
#
|
65
|
+
# @param property [String]
|
66
|
+
# @param conversion_event [String]
|
67
|
+
#
|
68
|
+
# @return [::String]
|
69
|
+
def conversion_event_path property:, conversion_event:
|
70
|
+
raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
|
71
|
+
|
72
|
+
"properties/#{property}/conversionEvents/#{conversion_event}"
|
73
|
+
end
|
74
|
+
|
75
|
+
##
|
76
|
+
# Create a fully-qualified CustomDimension resource string.
|
77
|
+
#
|
78
|
+
# The resource will be in the following format:
|
79
|
+
#
|
80
|
+
# `properties/{property}/customDimensions`
|
81
|
+
#
|
82
|
+
# @param property [String]
|
83
|
+
#
|
84
|
+
# @return [::String]
|
85
|
+
def custom_dimension_path property:
|
86
|
+
"properties/#{property}/customDimensions"
|
87
|
+
end
|
88
|
+
|
89
|
+
##
|
90
|
+
# Create a fully-qualified CustomMetric resource string.
|
91
|
+
#
|
92
|
+
# The resource will be in the following format:
|
93
|
+
#
|
94
|
+
# `properties/{property}/customMetrics`
|
95
|
+
#
|
96
|
+
# @param property [String]
|
97
|
+
#
|
98
|
+
# @return [::String]
|
99
|
+
def custom_metric_path property:
|
100
|
+
"properties/#{property}/customMetrics"
|
101
|
+
end
|
102
|
+
|
58
103
|
##
|
59
104
|
# Create a fully-qualified DataSharingSettings resource string.
|
60
105
|
#
|
@@ -134,6 +179,20 @@ module Google
|
|
134
179
|
"properties/#{property}/googleAdsLinks/#{google_ads_link}"
|
135
180
|
end
|
136
181
|
|
182
|
+
##
|
183
|
+
# Create a fully-qualified GoogleSignalsSettings resource string.
|
184
|
+
#
|
185
|
+
# The resource will be in the following format:
|
186
|
+
#
|
187
|
+
# `properties/{property}/googleSignalsSettings`
|
188
|
+
#
|
189
|
+
# @param property [String]
|
190
|
+
#
|
191
|
+
# @return [::String]
|
192
|
+
def google_signals_settings_path property:
|
193
|
+
"properties/#{property}/googleSignalsSettings"
|
194
|
+
end
|
195
|
+
|
137
196
|
##
|
138
197
|
# Create a fully-qualified IosAppDataStream resource string.
|
139
198
|
#
|
@@ -151,6 +210,25 @@ module Google
|
|
151
210
|
"properties/#{property}/iosAppDataStreams/#{ios_app_data_stream}"
|
152
211
|
end
|
153
212
|
|
213
|
+
##
|
214
|
+
# Create a fully-qualified MeasurementProtocolSecret resource string.
|
215
|
+
#
|
216
|
+
# The resource will be in the following format:
|
217
|
+
#
|
218
|
+
# `properties/{property}/webDataStreams/{web_data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}`
|
219
|
+
#
|
220
|
+
# @param property [String]
|
221
|
+
# @param web_data_stream [String]
|
222
|
+
# @param measurement_protocol_secret [String]
|
223
|
+
#
|
224
|
+
# @return [::String]
|
225
|
+
def measurement_protocol_secret_path property:, web_data_stream:, measurement_protocol_secret:
|
226
|
+
raise ::ArgumentError, "property cannot contain /" if property.to_s.include? "/"
|
227
|
+
raise ::ArgumentError, "web_data_stream cannot contain /" if web_data_stream.to_s.include? "/"
|
228
|
+
|
229
|
+
"properties/#{property}/webDataStreams/#{web_data_stream}/measurementProtocolSecrets/#{measurement_protocol_secret}"
|
230
|
+
end
|
231
|
+
|
154
232
|
##
|
155
233
|
# Create a fully-qualified Property resource string.
|
156
234
|
#
|
@@ -81,7 +81,7 @@ module Google
|
|
81
81
|
# https://support.google.com/analytics/answer/6154772
|
82
82
|
#
|
83
83
|
# Returns an error if the target is not found, or is not an GA4 Property.
|
84
|
-
rpc :DeleteProperty, ::Google::Analytics::Admin::V1alpha::DeletePropertyRequest, ::Google::
|
84
|
+
rpc :DeleteProperty, ::Google::Analytics::Admin::V1alpha::DeletePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
|
85
85
|
# Updates a property.
|
86
86
|
rpc :UpdateProperty, ::Google::Analytics::Admin::V1alpha::UpdatePropertyRequest, ::Google::Analytics::Admin::V1alpha::Property
|
87
87
|
# Gets information about a user's link to an account or property.
|
@@ -138,16 +138,6 @@ module Google
|
|
138
138
|
rpc :DeleteIosAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, ::Google::Protobuf::Empty
|
139
139
|
# Updates an iOS app stream on a property.
|
140
140
|
rpc :UpdateIosAppDataStream, ::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
|
141
|
-
# Creates an iOS app stream with the specified location and attributes.
|
142
|
-
#
|
143
|
-
# Note that an iOS app stream must be linked to a Firebase app to receive
|
144
|
-
# traffic.
|
145
|
-
#
|
146
|
-
# To create a working app stream, make sure your property is linked to a
|
147
|
-
# Firebase project. Then, use the Firebase API to create a Firebase app,
|
148
|
-
# which will also create an appropriate data stream in Analytics (may take up
|
149
|
-
# to 24 hours).
|
150
|
-
rpc :CreateIosAppDataStream, ::Google::Analytics::Admin::V1alpha::CreateIosAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::IosAppDataStream
|
151
141
|
# Returns child iOS app data streams under the specified parent property.
|
152
142
|
#
|
153
143
|
# iOS app data streams will be excluded if the caller does not have access.
|
@@ -159,16 +149,6 @@ module Google
|
|
159
149
|
rpc :DeleteAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, ::Google::Protobuf::Empty
|
160
150
|
# Updates an android app stream on a property.
|
161
151
|
rpc :UpdateAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
|
162
|
-
# Creates an Android app stream with the specified location and attributes.
|
163
|
-
#
|
164
|
-
# Note that an Android app stream must be linked to a Firebase app to receive
|
165
|
-
# traffic.
|
166
|
-
#
|
167
|
-
# To create a working app stream, make sure your property is linked to a
|
168
|
-
# Firebase project. Then, use the Firebase API to create a Firebase app,
|
169
|
-
# which will also create an appropriate data stream in Analytics (may take up
|
170
|
-
# to 24 hours).
|
171
|
-
rpc :CreateAndroidAppDataStream, ::Google::Analytics::Admin::V1alpha::CreateAndroidAppDataStreamRequest, ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
|
172
152
|
# Returns child android app streams under the specified parent property.
|
173
153
|
#
|
174
154
|
# Android app streams will be excluded if the caller does not have access.
|
@@ -207,6 +187,54 @@ module Google
|
|
207
187
|
# Get data sharing settings on an account.
|
208
188
|
# Data sharing settings are singletons.
|
209
189
|
rpc :GetDataSharingSettings, ::Google::Analytics::Admin::V1alpha::GetDataSharingSettingsRequest, ::Google::Analytics::Admin::V1alpha::DataSharingSettings
|
190
|
+
# Lookup for a single "GA4" MeasurementProtocolSecret.
|
191
|
+
rpc :GetMeasurementProtocolSecret, ::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest, ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
|
192
|
+
# Returns child MeasurementProtocolSecrets under the specified parent
|
193
|
+
# Property.
|
194
|
+
rpc :ListMeasurementProtocolSecrets, ::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest, ::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsResponse
|
195
|
+
# Creates a measurement protocol secret.
|
196
|
+
rpc :CreateMeasurementProtocolSecret, ::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest, ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
|
197
|
+
# Deletes target MeasurementProtocolSecret.
|
198
|
+
rpc :DeleteMeasurementProtocolSecret, ::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest, ::Google::Protobuf::Empty
|
199
|
+
# Updates a measurement protocol secret.
|
200
|
+
rpc :UpdateMeasurementProtocolSecret, ::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest, ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
|
201
|
+
# Searches through all changes to an account or its children given the
|
202
|
+
# specified set of filters.
|
203
|
+
rpc :SearchChangeHistoryEvents, ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsResponse
|
204
|
+
# Lookup for Google Signals settings for a property.
|
205
|
+
rpc :GetGoogleSignalsSettings, ::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest, ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings
|
206
|
+
# Updates Google Signals settings for a property.
|
207
|
+
rpc :UpdateGoogleSignalsSettings, ::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest, ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings
|
208
|
+
# Creates a conversion event with the specified attributes.
|
209
|
+
rpc :CreateConversionEvent, ::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest, ::Google::Analytics::Admin::V1alpha::ConversionEvent
|
210
|
+
# Retrieve a single conversion event.
|
211
|
+
rpc :GetConversionEvent, ::Google::Analytics::Admin::V1alpha::GetConversionEventRequest, ::Google::Analytics::Admin::V1alpha::ConversionEvent
|
212
|
+
# Deletes a conversion event in a property.
|
213
|
+
rpc :DeleteConversionEvent, ::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest, ::Google::Protobuf::Empty
|
214
|
+
# Returns a list of conversion events in the specified parent property.
|
215
|
+
#
|
216
|
+
# Returns an empty list if no conversion events are found.
|
217
|
+
rpc :ListConversionEvents, ::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest, ::Google::Analytics::Admin::V1alpha::ListConversionEventsResponse
|
218
|
+
# Creates a CustomDimension.
|
219
|
+
rpc :CreateCustomDimension, ::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest, ::Google::Analytics::Admin::V1alpha::CustomDimension
|
220
|
+
# Updates a CustomDimension on a property.
|
221
|
+
rpc :UpdateCustomDimension, ::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest, ::Google::Analytics::Admin::V1alpha::CustomDimension
|
222
|
+
# Lists CustomDimensions on a property.
|
223
|
+
rpc :ListCustomDimensions, ::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest, ::Google::Analytics::Admin::V1alpha::ListCustomDimensionsResponse
|
224
|
+
# Archives a CustomDimension on a property.
|
225
|
+
rpc :ArchiveCustomDimension, ::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest, ::Google::Protobuf::Empty
|
226
|
+
# Lookup for a single CustomDimension.
|
227
|
+
rpc :GetCustomDimension, ::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest, ::Google::Analytics::Admin::V1alpha::CustomDimension
|
228
|
+
# Creates a CustomMetric.
|
229
|
+
rpc :CreateCustomMetric, ::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest, ::Google::Analytics::Admin::V1alpha::CustomMetric
|
230
|
+
# Updates a CustomMetric on a property.
|
231
|
+
rpc :UpdateCustomMetric, ::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest, ::Google::Analytics::Admin::V1alpha::CustomMetric
|
232
|
+
# Lists CustomMetrics on a property.
|
233
|
+
rpc :ListCustomMetrics, ::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest, ::Google::Analytics::Admin::V1alpha::ListCustomMetricsResponse
|
234
|
+
# Archives a CustomMetric on a property.
|
235
|
+
rpc :ArchiveCustomMetric, ::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest, ::Google::Protobuf::Empty
|
236
|
+
# Lookup for a single CustomMetric.
|
237
|
+
rpc :GetCustomMetric, ::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest, ::Google::Analytics::Admin::V1alpha::CustomMetric
|
210
238
|
end
|
211
239
|
|
212
240
|
Stub = Service.rpc_stub_class
|
@@ -26,7 +26,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
26
26
|
optional :industry_category, :enum, 6, "google.analytics.admin.v1alpha.IndustryCategory"
|
27
27
|
optional :time_zone, :string, 7
|
28
28
|
optional :currency_code, :string, 8
|
29
|
-
optional :
|
29
|
+
optional :delete_time, :message, 11, "google.protobuf.Timestamp"
|
30
|
+
optional :expire_time, :message, 12, "google.protobuf.Timestamp"
|
30
31
|
end
|
31
32
|
add_message "google.analytics.admin.v1alpha.AndroidAppDataStream" do
|
32
33
|
optional :name, :string, 1
|
@@ -115,6 +116,90 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
115
116
|
optional :property, :string, 1
|
116
117
|
optional :display_name, :string, 2
|
117
118
|
end
|
119
|
+
add_message "google.analytics.admin.v1alpha.MeasurementProtocolSecret" do
|
120
|
+
optional :name, :string, 1
|
121
|
+
optional :display_name, :string, 2
|
122
|
+
optional :secret_value, :string, 3
|
123
|
+
end
|
124
|
+
add_message "google.analytics.admin.v1alpha.ChangeHistoryEvent" do
|
125
|
+
optional :id, :string, 1
|
126
|
+
optional :change_time, :message, 2, "google.protobuf.Timestamp"
|
127
|
+
optional :actor_type, :enum, 3, "google.analytics.admin.v1alpha.ActorType"
|
128
|
+
optional :user_actor_email, :string, 4
|
129
|
+
optional :changes_filtered, :bool, 5
|
130
|
+
repeated :changes, :message, 6, "google.analytics.admin.v1alpha.ChangeHistoryChange"
|
131
|
+
end
|
132
|
+
add_message "google.analytics.admin.v1alpha.ChangeHistoryChange" do
|
133
|
+
optional :resource, :string, 1
|
134
|
+
optional :action, :enum, 2, "google.analytics.admin.v1alpha.ActionType"
|
135
|
+
optional :resource_before_change, :message, 3, "google.analytics.admin.v1alpha.ChangeHistoryChange.ChangeHistoryResource"
|
136
|
+
optional :resource_after_change, :message, 4, "google.analytics.admin.v1alpha.ChangeHistoryChange.ChangeHistoryResource"
|
137
|
+
end
|
138
|
+
add_message "google.analytics.admin.v1alpha.ChangeHistoryChange.ChangeHistoryResource" do
|
139
|
+
oneof :resource do
|
140
|
+
optional :account, :message, 1, "google.analytics.admin.v1alpha.Account"
|
141
|
+
optional :property, :message, 2, "google.analytics.admin.v1alpha.Property"
|
142
|
+
optional :web_data_stream, :message, 3, "google.analytics.admin.v1alpha.WebDataStream"
|
143
|
+
optional :android_app_data_stream, :message, 4, "google.analytics.admin.v1alpha.AndroidAppDataStream"
|
144
|
+
optional :ios_app_data_stream, :message, 5, "google.analytics.admin.v1alpha.IosAppDataStream"
|
145
|
+
optional :firebase_link, :message, 6, "google.analytics.admin.v1alpha.FirebaseLink"
|
146
|
+
optional :google_ads_link, :message, 7, "google.analytics.admin.v1alpha.GoogleAdsLink"
|
147
|
+
optional :google_signals_settings, :message, 8, "google.analytics.admin.v1alpha.GoogleSignalsSettings"
|
148
|
+
optional :conversion_event, :message, 11, "google.analytics.admin.v1alpha.ConversionEvent"
|
149
|
+
optional :measurement_protocol_secret, :message, 12, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
150
|
+
optional :custom_dimension, :message, 13, "google.analytics.admin.v1alpha.CustomDimension"
|
151
|
+
optional :custom_metric, :message, 14, "google.analytics.admin.v1alpha.CustomMetric"
|
152
|
+
end
|
153
|
+
end
|
154
|
+
add_message "google.analytics.admin.v1alpha.ConversionEvent" do
|
155
|
+
optional :name, :string, 1
|
156
|
+
optional :event_name, :string, 2
|
157
|
+
optional :create_time, :message, 3, "google.protobuf.Timestamp"
|
158
|
+
optional :is_deletable, :bool, 4
|
159
|
+
end
|
160
|
+
add_message "google.analytics.admin.v1alpha.GoogleSignalsSettings" do
|
161
|
+
optional :name, :string, 1
|
162
|
+
optional :state, :enum, 3, "google.analytics.admin.v1alpha.GoogleSignalsState"
|
163
|
+
optional :consent, :enum, 4, "google.analytics.admin.v1alpha.GoogleSignalsConsent"
|
164
|
+
end
|
165
|
+
add_message "google.analytics.admin.v1alpha.CustomDimension" do
|
166
|
+
optional :name, :string, 1
|
167
|
+
optional :parameter_name, :string, 2
|
168
|
+
optional :display_name, :string, 3
|
169
|
+
optional :description, :string, 4
|
170
|
+
optional :scope, :enum, 5, "google.analytics.admin.v1alpha.CustomDimension.DimensionScope"
|
171
|
+
optional :disallow_ads_personalization, :bool, 6
|
172
|
+
end
|
173
|
+
add_enum "google.analytics.admin.v1alpha.CustomDimension.DimensionScope" do
|
174
|
+
value :DIMENSION_SCOPE_UNSPECIFIED, 0
|
175
|
+
value :EVENT, 1
|
176
|
+
value :USER, 2
|
177
|
+
end
|
178
|
+
add_message "google.analytics.admin.v1alpha.CustomMetric" do
|
179
|
+
optional :name, :string, 1
|
180
|
+
optional :parameter_name, :string, 2
|
181
|
+
optional :display_name, :string, 3
|
182
|
+
optional :description, :string, 4
|
183
|
+
optional :measurement_unit, :enum, 5, "google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit"
|
184
|
+
optional :scope, :enum, 6, "google.analytics.admin.v1alpha.CustomMetric.MetricScope"
|
185
|
+
end
|
186
|
+
add_enum "google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit" do
|
187
|
+
value :MEASUREMENT_UNIT_UNSPECIFIED, 0
|
188
|
+
value :STANDARD, 1
|
189
|
+
value :CURRENCY, 2
|
190
|
+
value :FEET, 3
|
191
|
+
value :METERS, 4
|
192
|
+
value :KILOMETERS, 5
|
193
|
+
value :MILES, 6
|
194
|
+
value :MILLISECONDS, 7
|
195
|
+
value :SECONDS, 8
|
196
|
+
value :MINUTES, 9
|
197
|
+
value :HOURS, 10
|
198
|
+
end
|
199
|
+
add_enum "google.analytics.admin.v1alpha.CustomMetric.MetricScope" do
|
200
|
+
value :METRIC_SCOPE_UNSPECIFIED, 0
|
201
|
+
value :EVENT, 1
|
202
|
+
end
|
118
203
|
add_enum "google.analytics.admin.v1alpha.MaximumUserAccess" do
|
119
204
|
value :MAXIMUM_USER_ACCESS_UNSPECIFIED, 0
|
120
205
|
value :NO_ACCESS, 1
|
@@ -151,6 +236,43 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
151
236
|
value :JOBS_AND_EDUCATION, 25
|
152
237
|
value :SHOPPING, 26
|
153
238
|
end
|
239
|
+
add_enum "google.analytics.admin.v1alpha.ActorType" do
|
240
|
+
value :ACTOR_TYPE_UNSPECIFIED, 0
|
241
|
+
value :USER, 1
|
242
|
+
value :SYSTEM, 2
|
243
|
+
value :SUPPORT, 3
|
244
|
+
end
|
245
|
+
add_enum "google.analytics.admin.v1alpha.ActionType" do
|
246
|
+
value :ACTION_TYPE_UNSPECIFIED, 0
|
247
|
+
value :CREATED, 1
|
248
|
+
value :UPDATED, 2
|
249
|
+
value :DELETED, 3
|
250
|
+
end
|
251
|
+
add_enum "google.analytics.admin.v1alpha.ChangeHistoryResourceType" do
|
252
|
+
value :CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED, 0
|
253
|
+
value :ACCOUNT, 1
|
254
|
+
value :PROPERTY, 2
|
255
|
+
value :WEB_DATA_STREAM, 3
|
256
|
+
value :ANDROID_APP_DATA_STREAM, 4
|
257
|
+
value :IOS_APP_DATA_STREAM, 5
|
258
|
+
value :FIREBASE_LINK, 6
|
259
|
+
value :GOOGLE_ADS_LINK, 7
|
260
|
+
value :GOOGLE_SIGNALS_SETTINGS, 8
|
261
|
+
value :CONVERSION_EVENT, 9
|
262
|
+
value :MEASUREMENT_PROTOCOL_SECRET, 10
|
263
|
+
value :CUSTOM_DIMENSION, 11
|
264
|
+
value :CUSTOM_METRIC, 12
|
265
|
+
end
|
266
|
+
add_enum "google.analytics.admin.v1alpha.GoogleSignalsState" do
|
267
|
+
value :GOOGLE_SIGNALS_STATE_UNSPECIFIED, 0
|
268
|
+
value :GOOGLE_SIGNALS_ENABLED, 1
|
269
|
+
value :GOOGLE_SIGNALS_DISABLED, 2
|
270
|
+
end
|
271
|
+
add_enum "google.analytics.admin.v1alpha.GoogleSignalsConsent" do
|
272
|
+
value :GOOGLE_SIGNALS_CONSENT_UNSPECIFIED, 0
|
273
|
+
value :GOOGLE_SIGNALS_CONSENT_CONSENTED, 2
|
274
|
+
value :GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED, 1
|
275
|
+
end
|
154
276
|
end
|
155
277
|
end
|
156
278
|
|
@@ -172,8 +294,24 @@ module Google
|
|
172
294
|
DataSharingSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DataSharingSettings").msgclass
|
173
295
|
AccountSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.AccountSummary").msgclass
|
174
296
|
PropertySummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.PropertySummary").msgclass
|
297
|
+
MeasurementProtocolSecret = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.MeasurementProtocolSecret").msgclass
|
298
|
+
ChangeHistoryEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChangeHistoryEvent").msgclass
|
299
|
+
ChangeHistoryChange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChangeHistoryChange").msgclass
|
300
|
+
ChangeHistoryChange::ChangeHistoryResource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChangeHistoryChange.ChangeHistoryResource").msgclass
|
301
|
+
ConversionEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ConversionEvent").msgclass
|
302
|
+
GoogleSignalsSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GoogleSignalsSettings").msgclass
|
303
|
+
CustomDimension = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CustomDimension").msgclass
|
304
|
+
CustomDimension::DimensionScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CustomDimension.DimensionScope").enummodule
|
305
|
+
CustomMetric = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CustomMetric").msgclass
|
306
|
+
CustomMetric::MeasurementUnit = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit").enummodule
|
307
|
+
CustomMetric::MetricScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CustomMetric.MetricScope").enummodule
|
175
308
|
MaximumUserAccess = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.MaximumUserAccess").enummodule
|
176
309
|
IndustryCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.IndustryCategory").enummodule
|
310
|
+
ActorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ActorType").enummodule
|
311
|
+
ActionType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ActionType").enummodule
|
312
|
+
ChangeHistoryResourceType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ChangeHistoryResourceType").enummodule
|
313
|
+
GoogleSignalsState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GoogleSignalsState").enummodule
|
314
|
+
GoogleSignalsConsent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GoogleSignalsConsent").enummodule
|
177
315
|
end
|
178
316
|
end
|
179
317
|
end
|
@@ -553,19 +553,6 @@ module Google
|
|
553
553
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
554
554
|
end
|
555
555
|
|
556
|
-
# Request message for CreateIosAppDataStream RPC.
|
557
|
-
# @!attribute [rw] ios_app_data_stream
|
558
|
-
# @return [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
|
559
|
-
# Required. The iOS app data stream to create.
|
560
|
-
# @!attribute [rw] parent
|
561
|
-
# @return [::String]
|
562
|
-
# Required. The parent resource where this ios app data stream will be created.
|
563
|
-
# Format: properties/123
|
564
|
-
class CreateIosAppDataStreamRequest
|
565
|
-
include ::Google::Protobuf::MessageExts
|
566
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
567
|
-
end
|
568
|
-
|
569
556
|
# Request message for ListIosAppDataStreams RPC.
|
570
557
|
# @!attribute [rw] parent
|
571
558
|
# @return [::String]
|
@@ -638,19 +625,6 @@ module Google
|
|
638
625
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
639
626
|
end
|
640
627
|
|
641
|
-
# Request message for CreateAndroidAppDataStream RPC.
|
642
|
-
# @!attribute [rw] android_app_data_stream
|
643
|
-
# @return [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
|
644
|
-
# Required. The android app stream to create.
|
645
|
-
# @!attribute [rw] parent
|
646
|
-
# @return [::String]
|
647
|
-
# Required. The parent resource where this android app data stream will be created.
|
648
|
-
# Format: properties/123
|
649
|
-
class CreateAndroidAppDataStreamRequest
|
650
|
-
include ::Google::Protobuf::MessageExts
|
651
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
652
|
-
end
|
653
|
-
|
654
628
|
# Request message for ListAndroidAppDataStreams RPC.
|
655
629
|
# @!attribute [rw] parent
|
656
630
|
# @return [::String]
|
@@ -911,6 +885,405 @@ module Google
|
|
911
885
|
include ::Google::Protobuf::MessageExts
|
912
886
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
913
887
|
end
|
888
|
+
|
889
|
+
# Request message for SearchChangeHistoryEvents RPC.
|
890
|
+
# @!attribute [rw] account
|
891
|
+
# @return [::String]
|
892
|
+
# Required. The account resource for which to return change history resources.
|
893
|
+
# @!attribute [rw] property
|
894
|
+
# @return [::String]
|
895
|
+
# Optional. Resource name for a child property. If set, only return changes
|
896
|
+
# made to this property or its child resources.
|
897
|
+
# @!attribute [rw] resource_type
|
898
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
899
|
+
# Optional. If set, only return changes if they are for a resource that matches at
|
900
|
+
# least one of these types.
|
901
|
+
# @!attribute [rw] action
|
902
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
|
903
|
+
# Optional. If set, only return changes that match one or more of these types of
|
904
|
+
# actions.
|
905
|
+
# @!attribute [rw] actor_email
|
906
|
+
# @return [::Array<::String>]
|
907
|
+
# Optional. If set, only return changes if they are made by a user in this list.
|
908
|
+
# @!attribute [rw] earliest_change_time
|
909
|
+
# @return [::Google::Protobuf::Timestamp]
|
910
|
+
# Optional. If set, only return changes made after this time (inclusive).
|
911
|
+
# @!attribute [rw] latest_change_time
|
912
|
+
# @return [::Google::Protobuf::Timestamp]
|
913
|
+
# Optional. If set, only return changes made before this time (inclusive).
|
914
|
+
# @!attribute [rw] page_size
|
915
|
+
# @return [::Integer]
|
916
|
+
# Optional. The maximum number of ChangeHistoryEvent items to return.
|
917
|
+
# The service may return fewer than this value, even if there are additional
|
918
|
+
# pages. If unspecified, at most 50 items will be returned.
|
919
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
920
|
+
# @!attribute [rw] page_token
|
921
|
+
# @return [::String]
|
922
|
+
# Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
|
923
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
924
|
+
# parameters provided to `SearchChangeHistoryEvents` must match the call that
|
925
|
+
# provided the page token.
|
926
|
+
class SearchChangeHistoryEventsRequest
|
927
|
+
include ::Google::Protobuf::MessageExts
|
928
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
929
|
+
end
|
930
|
+
|
931
|
+
# Response message for SearchAccounts RPC.
|
932
|
+
# @!attribute [rw] change_history_events
|
933
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
|
934
|
+
# Results that were accessible to the caller.
|
935
|
+
# @!attribute [rw] next_page_token
|
936
|
+
# @return [::String]
|
937
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
938
|
+
# If this field is omitted, there are no subsequent pages.
|
939
|
+
class SearchChangeHistoryEventsResponse
|
940
|
+
include ::Google::Protobuf::MessageExts
|
941
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
942
|
+
end
|
943
|
+
|
944
|
+
# Request message for GetMeasurementProtocolSecret RPC.
|
945
|
+
# @!attribute [rw] name
|
946
|
+
# @return [::String]
|
947
|
+
# Required. The name of the measurement protocol secret to lookup.
|
948
|
+
# Format:
|
949
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
950
|
+
# Note: Any type of stream (WebDataStream, IosAppDataStream,
|
951
|
+
# AndroidAppDataStream) may be a parent.
|
952
|
+
class GetMeasurementProtocolSecretRequest
|
953
|
+
include ::Google::Protobuf::MessageExts
|
954
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
955
|
+
end
|
956
|
+
|
957
|
+
# Request message for CreateMeasurementProtocolSecret RPC
|
958
|
+
# @!attribute [rw] parent
|
959
|
+
# @return [::String]
|
960
|
+
# Required. The parent resource where this secret will be created.
|
961
|
+
# Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
|
962
|
+
# may be a parent.
|
963
|
+
# Format: properties/\\{property}/webDataStreams/\\{webDataStream}
|
964
|
+
# @!attribute [rw] measurement_protocol_secret
|
965
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
966
|
+
# Required. The measurement protocol secret to create.
|
967
|
+
class CreateMeasurementProtocolSecretRequest
|
968
|
+
include ::Google::Protobuf::MessageExts
|
969
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
970
|
+
end
|
971
|
+
|
972
|
+
# Request message for DeleteMeasurementProtocolSecret RPC
|
973
|
+
# @!attribute [rw] name
|
974
|
+
# @return [::String]
|
975
|
+
# Required. The name of the MeasurementProtocolSecret to delete.
|
976
|
+
# Format:
|
977
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
978
|
+
# Note: Any type of stream (WebDataStream, IosAppDataStream,
|
979
|
+
# AndroidAppDataStream) may be a parent.
|
980
|
+
class DeleteMeasurementProtocolSecretRequest
|
981
|
+
include ::Google::Protobuf::MessageExts
|
982
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
983
|
+
end
|
984
|
+
|
985
|
+
# Request message for UpdateMeasurementProtocolSecret RPC
|
986
|
+
# @!attribute [rw] measurement_protocol_secret
|
987
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
988
|
+
# Required. The measurement protocol secret to update.
|
989
|
+
# @!attribute [rw] update_mask
|
990
|
+
# @return [::Google::Protobuf::FieldMask]
|
991
|
+
# The list of fields to be updated. Omitted fields will not be updated.
|
992
|
+
class UpdateMeasurementProtocolSecretRequest
|
993
|
+
include ::Google::Protobuf::MessageExts
|
994
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
995
|
+
end
|
996
|
+
|
997
|
+
# Request message for ListMeasurementProtocolSecret RPC
|
998
|
+
# @!attribute [rw] parent
|
999
|
+
# @return [::String]
|
1000
|
+
# Required. The resource name of the parent stream.
|
1001
|
+
# Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
|
1002
|
+
# may be a parent.
|
1003
|
+
# Format:
|
1004
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets
|
1005
|
+
# @!attribute [rw] page_size
|
1006
|
+
# @return [::Integer]
|
1007
|
+
# The maximum number of resources to return.
|
1008
|
+
# If unspecified, at most 10 resources will be returned.
|
1009
|
+
# The maximum value is 10. Higher values will be coerced to the maximum.
|
1010
|
+
# @!attribute [rw] page_token
|
1011
|
+
# @return [::String]
|
1012
|
+
# A page token, received from a previous `ListMeasurementProtocolSecrets`
|
1013
|
+
# call. Provide this to retrieve the subsequent page. When paginating, all
|
1014
|
+
# other parameters provided to `ListMeasurementProtocolSecrets` must match
|
1015
|
+
# the call that provided the page token.
|
1016
|
+
class ListMeasurementProtocolSecretsRequest
|
1017
|
+
include ::Google::Protobuf::MessageExts
|
1018
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
# Response message for ListMeasurementProtocolSecret RPC
|
1022
|
+
# @!attribute [rw] measurement_protocol_secrets
|
1023
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
|
1024
|
+
# A list of secrets for the parent stream specified in the request.
|
1025
|
+
# @!attribute [rw] next_page_token
|
1026
|
+
# @return [::String]
|
1027
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1028
|
+
# If this field is omitted, there are no subsequent pages.
|
1029
|
+
class ListMeasurementProtocolSecretsResponse
|
1030
|
+
include ::Google::Protobuf::MessageExts
|
1031
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# Request message for GetGoogleSignalsSettings RPC
|
1035
|
+
# @!attribute [rw] name
|
1036
|
+
# @return [::String]
|
1037
|
+
# Required. The name of the google signals settings to retrieve.
|
1038
|
+
# Format: properties/\\{property}/googleSignalsSettings
|
1039
|
+
class GetGoogleSignalsSettingsRequest
|
1040
|
+
include ::Google::Protobuf::MessageExts
|
1041
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
# Request message for UpdateGoogleSignalsSettings RPC
|
1045
|
+
# @!attribute [rw] google_signals_settings
|
1046
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
1047
|
+
# Required. The settings to update.
|
1048
|
+
# The `name` field is used to identify the settings to be updated.
|
1049
|
+
# @!attribute [rw] update_mask
|
1050
|
+
# @return [::Google::Protobuf::FieldMask]
|
1051
|
+
# Required. The list of fields to be updated. Field names must be in snake case
|
1052
|
+
# (e.g., "field_to_update"). Omitted fields will not be updated. To replace
|
1053
|
+
# the entire entity, use one path with the string "*" to match all fields.
|
1054
|
+
class UpdateGoogleSignalsSettingsRequest
|
1055
|
+
include ::Google::Protobuf::MessageExts
|
1056
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1057
|
+
end
|
1058
|
+
|
1059
|
+
# Request message for CreateConversionEvent RPC
|
1060
|
+
# @!attribute [rw] conversion_event
|
1061
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
1062
|
+
# Required. The conversion event to create.
|
1063
|
+
# @!attribute [rw] parent
|
1064
|
+
# @return [::String]
|
1065
|
+
# Required. The resource name of the parent property where this conversion event will
|
1066
|
+
# be created. Format: properties/123
|
1067
|
+
class CreateConversionEventRequest
|
1068
|
+
include ::Google::Protobuf::MessageExts
|
1069
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Request message for GetConversionEvent RPC
|
1073
|
+
# @!attribute [rw] name
|
1074
|
+
# @return [::String]
|
1075
|
+
# Required. The resource name of the conversion event to retrieve.
|
1076
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
1077
|
+
# Example: "properties/123/conversionEvents/456"
|
1078
|
+
class GetConversionEventRequest
|
1079
|
+
include ::Google::Protobuf::MessageExts
|
1080
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# Request message for DeleteConversionEvent RPC
|
1084
|
+
# @!attribute [rw] name
|
1085
|
+
# @return [::String]
|
1086
|
+
# Required. The resource name of the conversion event to delete.
|
1087
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
1088
|
+
# Example: "properties/123/conversionEvents/456"
|
1089
|
+
class DeleteConversionEventRequest
|
1090
|
+
include ::Google::Protobuf::MessageExts
|
1091
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
# Request message for ListConversionEvents RPC
|
1095
|
+
# @!attribute [rw] parent
|
1096
|
+
# @return [::String]
|
1097
|
+
# Required. The resource name of the parent property.
|
1098
|
+
# Example: 'properties/123'
|
1099
|
+
# @!attribute [rw] page_size
|
1100
|
+
# @return [::Integer]
|
1101
|
+
# The maximum number of resources to return.
|
1102
|
+
# If unspecified, at most 50 resources will be returned.
|
1103
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
1104
|
+
# @!attribute [rw] page_token
|
1105
|
+
# @return [::String]
|
1106
|
+
# A page token, received from a previous `ListConversionEvents` call.
|
1107
|
+
# Provide this to retrieve the subsequent page.
|
1108
|
+
# When paginating, all other parameters provided to `ListConversionEvents`
|
1109
|
+
# must match the call that provided the page token.
|
1110
|
+
class ListConversionEventsRequest
|
1111
|
+
include ::Google::Protobuf::MessageExts
|
1112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
# Response message for ListConversionEvents RPC.
|
1116
|
+
# @!attribute [rw] conversion_events
|
1117
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
|
1118
|
+
# The requested conversion events
|
1119
|
+
# @!attribute [rw] next_page_token
|
1120
|
+
# @return [::String]
|
1121
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1122
|
+
# If this field is omitted, there are no subsequent pages.
|
1123
|
+
class ListConversionEventsResponse
|
1124
|
+
include ::Google::Protobuf::MessageExts
|
1125
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
# Request message for CreateCustomDimension RPC.
|
1129
|
+
# @!attribute [rw] parent
|
1130
|
+
# @return [::String]
|
1131
|
+
# Required. Example format: properties/1234
|
1132
|
+
# @!attribute [rw] custom_dimension
|
1133
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
1134
|
+
# Required. The CustomDimension to create.
|
1135
|
+
class CreateCustomDimensionRequest
|
1136
|
+
include ::Google::Protobuf::MessageExts
|
1137
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# Request message for UpdateCustomDimension RPC.
|
1141
|
+
# @!attribute [rw] custom_dimension
|
1142
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
1143
|
+
# The CustomDimension to update
|
1144
|
+
# @!attribute [rw] update_mask
|
1145
|
+
# @return [::Google::Protobuf::FieldMask]
|
1146
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1147
|
+
# To replace the entire entity, use one path with the string "*" to match
|
1148
|
+
# all fields.
|
1149
|
+
class UpdateCustomDimensionRequest
|
1150
|
+
include ::Google::Protobuf::MessageExts
|
1151
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1152
|
+
end
|
1153
|
+
|
1154
|
+
# Request message for ListCustomDimensions RPC.
|
1155
|
+
# @!attribute [rw] parent
|
1156
|
+
# @return [::String]
|
1157
|
+
# Required. Example format: properties/1234
|
1158
|
+
# @!attribute [rw] page_size
|
1159
|
+
# @return [::Integer]
|
1160
|
+
# The maximum number of resources to return.
|
1161
|
+
# If unspecified, at most 50 resources will be returned.
|
1162
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
1163
|
+
# @!attribute [rw] page_token
|
1164
|
+
# @return [::String]
|
1165
|
+
# A page token, received from a previous `ListCustomDimensions` call.
|
1166
|
+
# Provide this to retrieve the subsequent page.
|
1167
|
+
#
|
1168
|
+
# When paginating, all other parameters provided to `ListCustomDimensions`
|
1169
|
+
# must match the call that provided the page token.
|
1170
|
+
class ListCustomDimensionsRequest
|
1171
|
+
include ::Google::Protobuf::MessageExts
|
1172
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
# Response message for ListCustomDimensions RPC.
|
1176
|
+
# @!attribute [rw] custom_dimensions
|
1177
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::CustomDimension>]
|
1178
|
+
# List of CustomDimensions.
|
1179
|
+
# @!attribute [rw] next_page_token
|
1180
|
+
# @return [::String]
|
1181
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1182
|
+
# If this field is omitted, there are no subsequent pages.
|
1183
|
+
class ListCustomDimensionsResponse
|
1184
|
+
include ::Google::Protobuf::MessageExts
|
1185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1186
|
+
end
|
1187
|
+
|
1188
|
+
# Request message for ArchiveCustomDimension RPC.
|
1189
|
+
# @!attribute [rw] name
|
1190
|
+
# @return [::String]
|
1191
|
+
# Required. The name of the CustomDimension to archive.
|
1192
|
+
# Example format: properties/1234/customDimensions/5678
|
1193
|
+
class ArchiveCustomDimensionRequest
|
1194
|
+
include ::Google::Protobuf::MessageExts
|
1195
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# Request message for GetCustomDimension RPC.
|
1199
|
+
# @!attribute [rw] name
|
1200
|
+
# @return [::String]
|
1201
|
+
# Required. The name of the CustomDimension to get.
|
1202
|
+
# Example format: properties/1234/customDimensions/5678
|
1203
|
+
class GetCustomDimensionRequest
|
1204
|
+
include ::Google::Protobuf::MessageExts
|
1205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1206
|
+
end
|
1207
|
+
|
1208
|
+
# Request message for CreateCustomMetric RPC.
|
1209
|
+
# @!attribute [rw] parent
|
1210
|
+
# @return [::String]
|
1211
|
+
# Required. Example format: properties/1234
|
1212
|
+
# @!attribute [rw] custom_metric
|
1213
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
1214
|
+
# Required. The CustomMetric to create.
|
1215
|
+
class CreateCustomMetricRequest
|
1216
|
+
include ::Google::Protobuf::MessageExts
|
1217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# Request message for UpdateCustomMetric RPC.
|
1221
|
+
# @!attribute [rw] custom_metric
|
1222
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
1223
|
+
# The CustomMetric to update
|
1224
|
+
# @!attribute [rw] update_mask
|
1225
|
+
# @return [::Google::Protobuf::FieldMask]
|
1226
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1227
|
+
# To replace the entire entity, use one path with the string "*" to match
|
1228
|
+
# all fields.
|
1229
|
+
class UpdateCustomMetricRequest
|
1230
|
+
include ::Google::Protobuf::MessageExts
|
1231
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# Request message for ListCustomMetrics RPC.
|
1235
|
+
# @!attribute [rw] parent
|
1236
|
+
# @return [::String]
|
1237
|
+
# Required. Example format: properties/1234
|
1238
|
+
# @!attribute [rw] page_size
|
1239
|
+
# @return [::Integer]
|
1240
|
+
# The maximum number of resources to return.
|
1241
|
+
# If unspecified, at most 50 resources will be returned.
|
1242
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
1243
|
+
# @!attribute [rw] page_token
|
1244
|
+
# @return [::String]
|
1245
|
+
# A page token, received from a previous `ListCustomMetrics` call.
|
1246
|
+
# Provide this to retrieve the subsequent page.
|
1247
|
+
#
|
1248
|
+
# When paginating, all other parameters provided to `ListCustomMetrics` must
|
1249
|
+
# match the call that provided the page token.
|
1250
|
+
class ListCustomMetricsRequest
|
1251
|
+
include ::Google::Protobuf::MessageExts
|
1252
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1253
|
+
end
|
1254
|
+
|
1255
|
+
# Response message for ListCustomMetrics RPC.
|
1256
|
+
# @!attribute [rw] custom_metrics
|
1257
|
+
# @return [::Array<::Google::Analytics::Admin::V1alpha::CustomMetric>]
|
1258
|
+
# List of CustomMetrics.
|
1259
|
+
# @!attribute [rw] next_page_token
|
1260
|
+
# @return [::String]
|
1261
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1262
|
+
# If this field is omitted, there are no subsequent pages.
|
1263
|
+
class ListCustomMetricsResponse
|
1264
|
+
include ::Google::Protobuf::MessageExts
|
1265
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# Request message for ArchiveCustomMetric RPC.
|
1269
|
+
# @!attribute [rw] name
|
1270
|
+
# @return [::String]
|
1271
|
+
# Required. The name of the CustomMetric to archive.
|
1272
|
+
# Example format: properties/1234/customMetrics/5678
|
1273
|
+
class ArchiveCustomMetricRequest
|
1274
|
+
include ::Google::Protobuf::MessageExts
|
1275
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1276
|
+
end
|
1277
|
+
|
1278
|
+
# Request message for GetCustomMetric RPC.
|
1279
|
+
# @!attribute [rw] name
|
1280
|
+
# @return [::String]
|
1281
|
+
# Required. The name of the CustomMetric to get.
|
1282
|
+
# Example format: properties/1234/customMetrics/5678
|
1283
|
+
class GetCustomMetricRequest
|
1284
|
+
include ::Google::Protobuf::MessageExts
|
1285
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1286
|
+
end
|
914
1287
|
end
|
915
1288
|
end
|
916
1289
|
end
|