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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 98bf9eaf0251076746553ccd1baed116de529ee3baf7ac30f9366139ca0cafbc
|
|
4
|
+
data.tar.gz: f159b7c45be71c28f1d12038e09790d216aa476dd3ce827d98a99161f865b888
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: eeda6d2e25f985011a08cb68aaff24636aa1d006c4a10d9571df5c7ffb1f42be25e9201eee24bad0f880906255ef0152452c63b51c3234deb0ee3eda9f6da1eb
|
|
7
|
+
data.tar.gz: 57069e5066982625a04be00a43dedf52ee052b68ee8b465267445c11061f075bf2bc649732c1b4d1261aeab8b360bc3c084f40be1616979eea3fd928b522f59e
|
data/AUTHENTICATION.md
CHANGED
|
@@ -66,11 +66,11 @@ The environment variables that google-analytics-admin-v1alpha
|
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
|
67
67
|
{::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Credentials}):
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
* `ANALYTICS_ADMIN_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `ANALYTICS_ADMIN_KEYFILE` - Path to JSON file, or JSON contents
|
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
74
74
|
|
|
75
75
|
```ruby
|
|
76
76
|
require "google/analytics/admin/v1alpha"
|
|
@@ -82,8 +82,8 @@ client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
|
|
82
82
|
|
|
83
83
|
### Configuration
|
|
84
84
|
|
|
85
|
-
The **Credentials JSON** can be configured instead of
|
|
86
|
-
environment
|
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
|
87
87
|
|
|
88
88
|
```ruby
|
|
89
89
|
require "google/analytics/admin/v1alpha"
|
|
@@ -93,7 +93,7 @@ client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
|
|
93
93
|
end
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
Or
|
|
96
|
+
Or globally for all clients:
|
|
97
97
|
|
|
98
98
|
```ruby
|
|
99
99
|
require "google/analytics/admin/v1alpha"
|
data/README.md
CHANGED
|
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
33
33
|
require "google/analytics/admin/v1alpha"
|
|
34
34
|
|
|
35
35
|
client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
|
36
|
-
request =
|
|
36
|
+
request = ::Google::Analytics::Admin::V1alpha::GetAccountRequest.new # (request fields as keyword arguments...)
|
|
37
37
|
response = client.get_account request
|
|
38
38
|
```
|
|
39
39
|
|
|
@@ -153,10 +153,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
153
153
|
optional :ios_app_data_stream, :message, 1, "google.analytics.admin.v1alpha.IosAppDataStream"
|
|
154
154
|
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
155
155
|
end
|
|
156
|
-
add_message "google.analytics.admin.v1alpha.CreateIosAppDataStreamRequest" do
|
|
157
|
-
optional :ios_app_data_stream, :message, 1, "google.analytics.admin.v1alpha.IosAppDataStream"
|
|
158
|
-
optional :parent, :string, 2
|
|
159
|
-
end
|
|
160
156
|
add_message "google.analytics.admin.v1alpha.ListIosAppDataStreamsRequest" do
|
|
161
157
|
optional :parent, :string, 1
|
|
162
158
|
optional :page_size, :int32, 2
|
|
@@ -176,10 +172,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
176
172
|
optional :android_app_data_stream, :message, 1, "google.analytics.admin.v1alpha.AndroidAppDataStream"
|
|
177
173
|
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
178
174
|
end
|
|
179
|
-
add_message "google.analytics.admin.v1alpha.CreateAndroidAppDataStreamRequest" do
|
|
180
|
-
optional :android_app_data_stream, :message, 1, "google.analytics.admin.v1alpha.AndroidAppDataStream"
|
|
181
|
-
optional :parent, :string, 2
|
|
182
|
-
end
|
|
183
175
|
add_message "google.analytics.admin.v1alpha.ListAndroidAppDataStreamsRequest" do
|
|
184
176
|
optional :parent, :string, 1
|
|
185
177
|
optional :page_size, :int32, 2
|
|
@@ -250,6 +242,116 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
250
242
|
repeated :account_summaries, :message, 1, "google.analytics.admin.v1alpha.AccountSummary"
|
|
251
243
|
optional :next_page_token, :string, 2
|
|
252
244
|
end
|
|
245
|
+
add_message "google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest" do
|
|
246
|
+
optional :account, :string, 1
|
|
247
|
+
optional :property, :string, 2
|
|
248
|
+
repeated :resource_type, :enum, 3, "google.analytics.admin.v1alpha.ChangeHistoryResourceType"
|
|
249
|
+
repeated :action, :enum, 4, "google.analytics.admin.v1alpha.ActionType"
|
|
250
|
+
repeated :actor_email, :string, 5
|
|
251
|
+
optional :earliest_change_time, :message, 6, "google.protobuf.Timestamp"
|
|
252
|
+
optional :latest_change_time, :message, 7, "google.protobuf.Timestamp"
|
|
253
|
+
optional :page_size, :int32, 8
|
|
254
|
+
optional :page_token, :string, 9
|
|
255
|
+
end
|
|
256
|
+
add_message "google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse" do
|
|
257
|
+
repeated :change_history_events, :message, 1, "google.analytics.admin.v1alpha.ChangeHistoryEvent"
|
|
258
|
+
optional :next_page_token, :string, 2
|
|
259
|
+
end
|
|
260
|
+
add_message "google.analytics.admin.v1alpha.GetMeasurementProtocolSecretRequest" do
|
|
261
|
+
optional :name, :string, 1
|
|
262
|
+
end
|
|
263
|
+
add_message "google.analytics.admin.v1alpha.CreateMeasurementProtocolSecretRequest" do
|
|
264
|
+
optional :parent, :string, 1
|
|
265
|
+
optional :measurement_protocol_secret, :message, 2, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
|
266
|
+
end
|
|
267
|
+
add_message "google.analytics.admin.v1alpha.DeleteMeasurementProtocolSecretRequest" do
|
|
268
|
+
optional :name, :string, 1
|
|
269
|
+
end
|
|
270
|
+
add_message "google.analytics.admin.v1alpha.UpdateMeasurementProtocolSecretRequest" do
|
|
271
|
+
optional :measurement_protocol_secret, :message, 1, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
|
272
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
273
|
+
end
|
|
274
|
+
add_message "google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsRequest" do
|
|
275
|
+
optional :parent, :string, 1
|
|
276
|
+
optional :page_size, :int32, 2
|
|
277
|
+
optional :page_token, :string, 3
|
|
278
|
+
end
|
|
279
|
+
add_message "google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsResponse" do
|
|
280
|
+
repeated :measurement_protocol_secrets, :message, 1, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
|
|
281
|
+
optional :next_page_token, :string, 2
|
|
282
|
+
end
|
|
283
|
+
add_message "google.analytics.admin.v1alpha.GetGoogleSignalsSettingsRequest" do
|
|
284
|
+
optional :name, :string, 1
|
|
285
|
+
end
|
|
286
|
+
add_message "google.analytics.admin.v1alpha.UpdateGoogleSignalsSettingsRequest" do
|
|
287
|
+
optional :google_signals_settings, :message, 1, "google.analytics.admin.v1alpha.GoogleSignalsSettings"
|
|
288
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
289
|
+
end
|
|
290
|
+
add_message "google.analytics.admin.v1alpha.CreateConversionEventRequest" do
|
|
291
|
+
optional :conversion_event, :message, 1, "google.analytics.admin.v1alpha.ConversionEvent"
|
|
292
|
+
optional :parent, :string, 2
|
|
293
|
+
end
|
|
294
|
+
add_message "google.analytics.admin.v1alpha.GetConversionEventRequest" do
|
|
295
|
+
optional :name, :string, 1
|
|
296
|
+
end
|
|
297
|
+
add_message "google.analytics.admin.v1alpha.DeleteConversionEventRequest" do
|
|
298
|
+
optional :name, :string, 1
|
|
299
|
+
end
|
|
300
|
+
add_message "google.analytics.admin.v1alpha.ListConversionEventsRequest" do
|
|
301
|
+
optional :parent, :string, 1
|
|
302
|
+
optional :page_size, :int32, 2
|
|
303
|
+
optional :page_token, :string, 3
|
|
304
|
+
end
|
|
305
|
+
add_message "google.analytics.admin.v1alpha.ListConversionEventsResponse" do
|
|
306
|
+
repeated :conversion_events, :message, 1, "google.analytics.admin.v1alpha.ConversionEvent"
|
|
307
|
+
optional :next_page_token, :string, 2
|
|
308
|
+
end
|
|
309
|
+
add_message "google.analytics.admin.v1alpha.CreateCustomDimensionRequest" do
|
|
310
|
+
optional :parent, :string, 1
|
|
311
|
+
optional :custom_dimension, :message, 2, "google.analytics.admin.v1alpha.CustomDimension"
|
|
312
|
+
end
|
|
313
|
+
add_message "google.analytics.admin.v1alpha.UpdateCustomDimensionRequest" do
|
|
314
|
+
optional :custom_dimension, :message, 1, "google.analytics.admin.v1alpha.CustomDimension"
|
|
315
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
316
|
+
end
|
|
317
|
+
add_message "google.analytics.admin.v1alpha.ListCustomDimensionsRequest" do
|
|
318
|
+
optional :parent, :string, 1
|
|
319
|
+
optional :page_size, :int32, 2
|
|
320
|
+
optional :page_token, :string, 3
|
|
321
|
+
end
|
|
322
|
+
add_message "google.analytics.admin.v1alpha.ListCustomDimensionsResponse" do
|
|
323
|
+
repeated :custom_dimensions, :message, 1, "google.analytics.admin.v1alpha.CustomDimension"
|
|
324
|
+
optional :next_page_token, :string, 2
|
|
325
|
+
end
|
|
326
|
+
add_message "google.analytics.admin.v1alpha.ArchiveCustomDimensionRequest" do
|
|
327
|
+
optional :name, :string, 1
|
|
328
|
+
end
|
|
329
|
+
add_message "google.analytics.admin.v1alpha.GetCustomDimensionRequest" do
|
|
330
|
+
optional :name, :string, 1
|
|
331
|
+
end
|
|
332
|
+
add_message "google.analytics.admin.v1alpha.CreateCustomMetricRequest" do
|
|
333
|
+
optional :parent, :string, 1
|
|
334
|
+
optional :custom_metric, :message, 2, "google.analytics.admin.v1alpha.CustomMetric"
|
|
335
|
+
end
|
|
336
|
+
add_message "google.analytics.admin.v1alpha.UpdateCustomMetricRequest" do
|
|
337
|
+
optional :custom_metric, :message, 1, "google.analytics.admin.v1alpha.CustomMetric"
|
|
338
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
339
|
+
end
|
|
340
|
+
add_message "google.analytics.admin.v1alpha.ListCustomMetricsRequest" do
|
|
341
|
+
optional :parent, :string, 1
|
|
342
|
+
optional :page_size, :int32, 2
|
|
343
|
+
optional :page_token, :string, 3
|
|
344
|
+
end
|
|
345
|
+
add_message "google.analytics.admin.v1alpha.ListCustomMetricsResponse" do
|
|
346
|
+
repeated :custom_metrics, :message, 1, "google.analytics.admin.v1alpha.CustomMetric"
|
|
347
|
+
optional :next_page_token, :string, 2
|
|
348
|
+
end
|
|
349
|
+
add_message "google.analytics.admin.v1alpha.ArchiveCustomMetricRequest" do
|
|
350
|
+
optional :name, :string, 1
|
|
351
|
+
end
|
|
352
|
+
add_message "google.analytics.admin.v1alpha.GetCustomMetricRequest" do
|
|
353
|
+
optional :name, :string, 1
|
|
354
|
+
end
|
|
253
355
|
end
|
|
254
356
|
end
|
|
255
357
|
|
|
@@ -294,13 +396,11 @@ module Google
|
|
|
294
396
|
GetIosAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetIosAppDataStreamRequest").msgclass
|
|
295
397
|
DeleteIosAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteIosAppDataStreamRequest").msgclass
|
|
296
398
|
UpdateIosAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateIosAppDataStreamRequest").msgclass
|
|
297
|
-
CreateIosAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateIosAppDataStreamRequest").msgclass
|
|
298
399
|
ListIosAppDataStreamsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListIosAppDataStreamsRequest").msgclass
|
|
299
400
|
ListIosAppDataStreamsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListIosAppDataStreamsResponse").msgclass
|
|
300
401
|
GetAndroidAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetAndroidAppDataStreamRequest").msgclass
|
|
301
402
|
DeleteAndroidAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteAndroidAppDataStreamRequest").msgclass
|
|
302
403
|
UpdateAndroidAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateAndroidAppDataStreamRequest").msgclass
|
|
303
|
-
CreateAndroidAppDataStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateAndroidAppDataStreamRequest").msgclass
|
|
304
404
|
ListAndroidAppDataStreamsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAndroidAppDataStreamsRequest").msgclass
|
|
305
405
|
ListAndroidAppDataStreamsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAndroidAppDataStreamsResponse").msgclass
|
|
306
406
|
GetEnhancedMeasurementSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetEnhancedMeasurementSettingsRequest").msgclass
|
|
@@ -319,6 +419,33 @@ module Google
|
|
|
319
419
|
GetDataSharingSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetDataSharingSettingsRequest").msgclass
|
|
320
420
|
ListAccountSummariesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAccountSummariesRequest").msgclass
|
|
321
421
|
ListAccountSummariesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAccountSummariesResponse").msgclass
|
|
422
|
+
SearchChangeHistoryEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest").msgclass
|
|
423
|
+
SearchChangeHistoryEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse").msgclass
|
|
424
|
+
GetMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetMeasurementProtocolSecretRequest").msgclass
|
|
425
|
+
CreateMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateMeasurementProtocolSecretRequest").msgclass
|
|
426
|
+
DeleteMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteMeasurementProtocolSecretRequest").msgclass
|
|
427
|
+
UpdateMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateMeasurementProtocolSecretRequest").msgclass
|
|
428
|
+
ListMeasurementProtocolSecretsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsRequest").msgclass
|
|
429
|
+
ListMeasurementProtocolSecretsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsResponse").msgclass
|
|
430
|
+
GetGoogleSignalsSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetGoogleSignalsSettingsRequest").msgclass
|
|
431
|
+
UpdateGoogleSignalsSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateGoogleSignalsSettingsRequest").msgclass
|
|
432
|
+
CreateConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateConversionEventRequest").msgclass
|
|
433
|
+
GetConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetConversionEventRequest").msgclass
|
|
434
|
+
DeleteConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteConversionEventRequest").msgclass
|
|
435
|
+
ListConversionEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListConversionEventsRequest").msgclass
|
|
436
|
+
ListConversionEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListConversionEventsResponse").msgclass
|
|
437
|
+
CreateCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateCustomDimensionRequest").msgclass
|
|
438
|
+
UpdateCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateCustomDimensionRequest").msgclass
|
|
439
|
+
ListCustomDimensionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomDimensionsRequest").msgclass
|
|
440
|
+
ListCustomDimensionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomDimensionsResponse").msgclass
|
|
441
|
+
ArchiveCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ArchiveCustomDimensionRequest").msgclass
|
|
442
|
+
GetCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetCustomDimensionRequest").msgclass
|
|
443
|
+
CreateCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateCustomMetricRequest").msgclass
|
|
444
|
+
UpdateCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateCustomMetricRequest").msgclass
|
|
445
|
+
ListCustomMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomMetricsRequest").msgclass
|
|
446
|
+
ListCustomMetricsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomMetricsResponse").msgclass
|
|
447
|
+
ArchiveCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ArchiveCustomMetricRequest").msgclass
|
|
448
|
+
GetCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetCustomMetricRequest").msgclass
|
|
322
449
|
end
|
|
323
450
|
end
|
|
324
451
|
end
|
|
@@ -41,13 +41,12 @@ module Google
|
|
|
41
41
|
# See {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration}
|
|
42
42
|
# for a description of the configuration fields.
|
|
43
43
|
#
|
|
44
|
-
#
|
|
44
|
+
# @example
|
|
45
45
|
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
# end
|
|
46
|
+
# # Modify the configuration for all AnalyticsAdminService clients
|
|
47
|
+
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
|
48
|
+
# config.timeout = 10.0
|
|
49
|
+
# end
|
|
51
50
|
#
|
|
52
51
|
# @yield [config] Configure the Client client.
|
|
53
52
|
# @yieldparam config [Client::Configuration]
|
|
@@ -67,10 +66,7 @@ module Google
|
|
|
67
66
|
|
|
68
67
|
default_config.timeout = 60.0
|
|
69
68
|
default_config.retry_policy = {
|
|
70
|
-
initial_delay: 1.0,
|
|
71
|
-
max_delay: 60.0,
|
|
72
|
-
multiplier: 1.3,
|
|
73
|
-
retry_codes: [14, 2]
|
|
69
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
|
|
74
70
|
}
|
|
75
71
|
|
|
76
72
|
default_config.rpcs.get_account.timeout = 60.0
|
|
@@ -127,8 +123,6 @@ module Google
|
|
|
127
123
|
|
|
128
124
|
default_config.rpcs.update_ios_app_data_stream.timeout = 60.0
|
|
129
125
|
|
|
130
|
-
default_config.rpcs.create_ios_app_data_stream.timeout = 60.0
|
|
131
|
-
|
|
132
126
|
default_config.rpcs.list_ios_app_data_streams.timeout = 60.0
|
|
133
127
|
|
|
134
128
|
default_config.rpcs.get_android_app_data_stream.timeout = 60.0
|
|
@@ -137,8 +131,6 @@ module Google
|
|
|
137
131
|
|
|
138
132
|
default_config.rpcs.update_android_app_data_stream.timeout = 60.0
|
|
139
133
|
|
|
140
|
-
default_config.rpcs.create_android_app_data_stream.timeout = 60.0
|
|
141
|
-
|
|
142
134
|
default_config.rpcs.list_android_app_data_streams.timeout = 60.0
|
|
143
135
|
|
|
144
136
|
default_config.rpcs.get_enhanced_measurement_settings.timeout = 60.0
|
|
@@ -192,19 +184,15 @@ module Google
|
|
|
192
184
|
##
|
|
193
185
|
# Create a new AnalyticsAdminService client object.
|
|
194
186
|
#
|
|
195
|
-
#
|
|
196
|
-
#
|
|
197
|
-
# To create a new AnalyticsAdminService client with the default
|
|
198
|
-
# configuration:
|
|
187
|
+
# @example
|
|
199
188
|
#
|
|
200
|
-
#
|
|
189
|
+
# # Create a client using the default configuration
|
|
190
|
+
# client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
|
201
191
|
#
|
|
202
|
-
#
|
|
203
|
-
#
|
|
204
|
-
#
|
|
205
|
-
#
|
|
206
|
-
# config.timeout = 10.0
|
|
207
|
-
# end
|
|
192
|
+
# # Create a client using a custom configuration
|
|
193
|
+
# client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
|
|
194
|
+
# config.timeout = 10.0
|
|
195
|
+
# end
|
|
208
196
|
#
|
|
209
197
|
# @yield [config] Configure the AnalyticsAdminService client.
|
|
210
198
|
# @yieldparam config [Client::Configuration]
|
|
@@ -224,14 +212,13 @@ module Google
|
|
|
224
212
|
|
|
225
213
|
# Create credentials
|
|
226
214
|
credentials = @config.credentials
|
|
227
|
-
# Use self-signed JWT if the
|
|
215
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
228
216
|
# but only if the default endpoint does not have a region prefix.
|
|
229
|
-
enable_self_signed_jwt = @config.
|
|
230
|
-
@config.endpoint == Client.configure.endpoint &&
|
|
217
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
|
231
218
|
!@config.endpoint.split(".").first.include?("-")
|
|
232
219
|
credentials ||= Credentials.default scope: @config.scope,
|
|
233
220
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
234
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
221
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
235
222
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
236
223
|
end
|
|
237
224
|
@quota_project_id = @config.quota_project
|
|
@@ -305,7 +292,9 @@ module Google
|
|
|
305
292
|
options.apply_defaults timeout: @config.rpcs.get_account.timeout,
|
|
306
293
|
metadata: metadata,
|
|
307
294
|
retry_policy: @config.rpcs.get_account.retry_policy
|
|
308
|
-
|
|
295
|
+
|
|
296
|
+
options.apply_defaults timeout: @config.timeout,
|
|
297
|
+
metadata: @config.metadata,
|
|
309
298
|
retry_policy: @config.retry_policy
|
|
310
299
|
|
|
311
300
|
@analytics_admin_service_stub.call_rpc :get_account, request, options: options do |response, operation|
|
|
@@ -381,7 +370,9 @@ module Google
|
|
|
381
370
|
options.apply_defaults timeout: @config.rpcs.list_accounts.timeout,
|
|
382
371
|
metadata: metadata,
|
|
383
372
|
retry_policy: @config.rpcs.list_accounts.retry_policy
|
|
384
|
-
|
|
373
|
+
|
|
374
|
+
options.apply_defaults timeout: @config.timeout,
|
|
375
|
+
metadata: @config.metadata,
|
|
385
376
|
retry_policy: @config.retry_policy
|
|
386
377
|
|
|
387
378
|
@analytics_admin_service_stub.call_rpc :list_accounts, request, options: options do |response, operation|
|
|
@@ -460,7 +451,9 @@ module Google
|
|
|
460
451
|
options.apply_defaults timeout: @config.rpcs.delete_account.timeout,
|
|
461
452
|
metadata: metadata,
|
|
462
453
|
retry_policy: @config.rpcs.delete_account.retry_policy
|
|
463
|
-
|
|
454
|
+
|
|
455
|
+
options.apply_defaults timeout: @config.timeout,
|
|
456
|
+
metadata: @config.metadata,
|
|
464
457
|
retry_policy: @config.retry_policy
|
|
465
458
|
|
|
466
459
|
@analytics_admin_service_stub.call_rpc :delete_account, request, options: options do |response, operation|
|
|
@@ -531,7 +524,9 @@ module Google
|
|
|
531
524
|
options.apply_defaults timeout: @config.rpcs.update_account.timeout,
|
|
532
525
|
metadata: metadata,
|
|
533
526
|
retry_policy: @config.rpcs.update_account.retry_policy
|
|
534
|
-
|
|
527
|
+
|
|
528
|
+
options.apply_defaults timeout: @config.timeout,
|
|
529
|
+
metadata: @config.metadata,
|
|
535
530
|
retry_policy: @config.retry_policy
|
|
536
531
|
|
|
537
532
|
@analytics_admin_service_stub.call_rpc :update_account, request, options: options do |response, operation|
|
|
@@ -594,7 +589,9 @@ module Google
|
|
|
594
589
|
options.apply_defaults timeout: @config.rpcs.provision_account_ticket.timeout,
|
|
595
590
|
metadata: metadata,
|
|
596
591
|
retry_policy: @config.rpcs.provision_account_ticket.retry_policy
|
|
597
|
-
|
|
592
|
+
|
|
593
|
+
options.apply_defaults timeout: @config.timeout,
|
|
594
|
+
metadata: @config.metadata,
|
|
598
595
|
retry_policy: @config.retry_policy
|
|
599
596
|
|
|
600
597
|
@analytics_admin_service_stub.call_rpc :provision_account_ticket, request, options: options do |response, operation|
|
|
@@ -662,7 +659,9 @@ module Google
|
|
|
662
659
|
options.apply_defaults timeout: @config.rpcs.list_account_summaries.timeout,
|
|
663
660
|
metadata: metadata,
|
|
664
661
|
retry_policy: @config.rpcs.list_account_summaries.retry_policy
|
|
665
|
-
|
|
662
|
+
|
|
663
|
+
options.apply_defaults timeout: @config.timeout,
|
|
664
|
+
metadata: @config.metadata,
|
|
666
665
|
retry_policy: @config.retry_policy
|
|
667
666
|
|
|
668
667
|
@analytics_admin_service_stub.call_rpc :list_account_summaries, request, options: options do |response, operation|
|
|
@@ -731,7 +730,9 @@ module Google
|
|
|
731
730
|
options.apply_defaults timeout: @config.rpcs.get_property.timeout,
|
|
732
731
|
metadata: metadata,
|
|
733
732
|
retry_policy: @config.rpcs.get_property.retry_policy
|
|
734
|
-
|
|
733
|
+
|
|
734
|
+
options.apply_defaults timeout: @config.timeout,
|
|
735
|
+
metadata: @config.metadata,
|
|
735
736
|
retry_policy: @config.retry_policy
|
|
736
737
|
|
|
737
738
|
@analytics_admin_service_stub.call_rpc :get_property, request, options: options do |response, operation|
|
|
@@ -822,7 +823,9 @@ module Google
|
|
|
822
823
|
options.apply_defaults timeout: @config.rpcs.list_properties.timeout,
|
|
823
824
|
metadata: metadata,
|
|
824
825
|
retry_policy: @config.rpcs.list_properties.retry_policy
|
|
825
|
-
|
|
826
|
+
|
|
827
|
+
options.apply_defaults timeout: @config.timeout,
|
|
828
|
+
metadata: @config.metadata,
|
|
826
829
|
retry_policy: @config.retry_policy
|
|
827
830
|
|
|
828
831
|
@analytics_admin_service_stub.call_rpc :list_properties, request, options: options do |response, operation|
|
|
@@ -884,7 +887,9 @@ module Google
|
|
|
884
887
|
options.apply_defaults timeout: @config.rpcs.create_property.timeout,
|
|
885
888
|
metadata: metadata,
|
|
886
889
|
retry_policy: @config.rpcs.create_property.retry_policy
|
|
887
|
-
|
|
890
|
+
|
|
891
|
+
options.apply_defaults timeout: @config.timeout,
|
|
892
|
+
metadata: @config.metadata,
|
|
888
893
|
retry_policy: @config.retry_policy
|
|
889
894
|
|
|
890
895
|
@analytics_admin_service_stub.call_rpc :create_property, request, options: options do |response, operation|
|
|
@@ -929,10 +934,10 @@ module Google
|
|
|
929
934
|
# Example: "properties/1000"
|
|
930
935
|
#
|
|
931
936
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
932
|
-
# @yieldparam response [::Google::
|
|
937
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Property]
|
|
933
938
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
934
939
|
#
|
|
935
|
-
# @return [::Google::
|
|
940
|
+
# @return [::Google::Analytics::Admin::V1alpha::Property]
|
|
936
941
|
#
|
|
937
942
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
938
943
|
#
|
|
@@ -962,7 +967,9 @@ module Google
|
|
|
962
967
|
options.apply_defaults timeout: @config.rpcs.delete_property.timeout,
|
|
963
968
|
metadata: metadata,
|
|
964
969
|
retry_policy: @config.rpcs.delete_property.retry_policy
|
|
965
|
-
|
|
970
|
+
|
|
971
|
+
options.apply_defaults timeout: @config.timeout,
|
|
972
|
+
metadata: @config.metadata,
|
|
966
973
|
retry_policy: @config.retry_policy
|
|
967
974
|
|
|
968
975
|
@analytics_admin_service_stub.call_rpc :delete_property, request, options: options do |response, operation|
|
|
@@ -1034,7 +1041,9 @@ module Google
|
|
|
1034
1041
|
options.apply_defaults timeout: @config.rpcs.update_property.timeout,
|
|
1035
1042
|
metadata: metadata,
|
|
1036
1043
|
retry_policy: @config.rpcs.update_property.retry_policy
|
|
1037
|
-
|
|
1044
|
+
|
|
1045
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1046
|
+
metadata: @config.metadata,
|
|
1038
1047
|
retry_policy: @config.retry_policy
|
|
1039
1048
|
|
|
1040
1049
|
@analytics_admin_service_stub.call_rpc :update_property, request, options: options do |response, operation|
|
|
@@ -1100,7 +1109,9 @@ module Google
|
|
|
1100
1109
|
options.apply_defaults timeout: @config.rpcs.get_user_link.timeout,
|
|
1101
1110
|
metadata: metadata,
|
|
1102
1111
|
retry_policy: @config.rpcs.get_user_link.retry_policy
|
|
1103
|
-
|
|
1112
|
+
|
|
1113
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1114
|
+
metadata: @config.metadata,
|
|
1104
1115
|
retry_policy: @config.retry_policy
|
|
1105
1116
|
|
|
1106
1117
|
@analytics_admin_service_stub.call_rpc :get_user_link, request, options: options do |response, operation|
|
|
@@ -1173,7 +1184,9 @@ module Google
|
|
|
1173
1184
|
options.apply_defaults timeout: @config.rpcs.batch_get_user_links.timeout,
|
|
1174
1185
|
metadata: metadata,
|
|
1175
1186
|
retry_policy: @config.rpcs.batch_get_user_links.retry_policy
|
|
1176
|
-
|
|
1187
|
+
|
|
1188
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1189
|
+
metadata: @config.metadata,
|
|
1177
1190
|
retry_policy: @config.retry_policy
|
|
1178
1191
|
|
|
1179
1192
|
@analytics_admin_service_stub.call_rpc :batch_get_user_links, request, options: options do |response, operation|
|
|
@@ -1249,7 +1262,9 @@ module Google
|
|
|
1249
1262
|
options.apply_defaults timeout: @config.rpcs.list_user_links.timeout,
|
|
1250
1263
|
metadata: metadata,
|
|
1251
1264
|
retry_policy: @config.rpcs.list_user_links.retry_policy
|
|
1252
|
-
|
|
1265
|
+
|
|
1266
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1267
|
+
metadata: @config.metadata,
|
|
1253
1268
|
retry_policy: @config.retry_policy
|
|
1254
1269
|
|
|
1255
1270
|
@analytics_admin_service_stub.call_rpc :list_user_links, request, options: options do |response, operation|
|
|
@@ -1334,7 +1349,9 @@ module Google
|
|
|
1334
1349
|
options.apply_defaults timeout: @config.rpcs.audit_user_links.timeout,
|
|
1335
1350
|
metadata: metadata,
|
|
1336
1351
|
retry_policy: @config.rpcs.audit_user_links.retry_policy
|
|
1337
|
-
|
|
1352
|
+
|
|
1353
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1354
|
+
metadata: @config.metadata,
|
|
1338
1355
|
retry_policy: @config.retry_policy
|
|
1339
1356
|
|
|
1340
1357
|
@analytics_admin_service_stub.call_rpc :audit_user_links, request, options: options do |response, operation|
|
|
@@ -1410,7 +1427,9 @@ module Google
|
|
|
1410
1427
|
options.apply_defaults timeout: @config.rpcs.create_user_link.timeout,
|
|
1411
1428
|
metadata: metadata,
|
|
1412
1429
|
retry_policy: @config.rpcs.create_user_link.retry_policy
|
|
1413
|
-
|
|
1430
|
+
|
|
1431
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1432
|
+
metadata: @config.metadata,
|
|
1414
1433
|
retry_policy: @config.retry_policy
|
|
1415
1434
|
|
|
1416
1435
|
@analytics_admin_service_stub.call_rpc :create_user_link, request, options: options do |response, operation|
|
|
@@ -1489,7 +1508,9 @@ module Google
|
|
|
1489
1508
|
options.apply_defaults timeout: @config.rpcs.batch_create_user_links.timeout,
|
|
1490
1509
|
metadata: metadata,
|
|
1491
1510
|
retry_policy: @config.rpcs.batch_create_user_links.retry_policy
|
|
1492
|
-
|
|
1511
|
+
|
|
1512
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1513
|
+
metadata: @config.metadata,
|
|
1493
1514
|
retry_policy: @config.retry_policy
|
|
1494
1515
|
|
|
1495
1516
|
@analytics_admin_service_stub.call_rpc :batch_create_user_links, request, options: options do |response, operation|
|
|
@@ -1555,7 +1576,9 @@ module Google
|
|
|
1555
1576
|
options.apply_defaults timeout: @config.rpcs.update_user_link.timeout,
|
|
1556
1577
|
metadata: metadata,
|
|
1557
1578
|
retry_policy: @config.rpcs.update_user_link.retry_policy
|
|
1558
|
-
|
|
1579
|
+
|
|
1580
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1581
|
+
metadata: @config.metadata,
|
|
1559
1582
|
retry_policy: @config.retry_policy
|
|
1560
1583
|
|
|
1561
1584
|
@analytics_admin_service_stub.call_rpc :update_user_link, request, options: options do |response, operation|
|
|
@@ -1627,7 +1650,9 @@ module Google
|
|
|
1627
1650
|
options.apply_defaults timeout: @config.rpcs.batch_update_user_links.timeout,
|
|
1628
1651
|
metadata: metadata,
|
|
1629
1652
|
retry_policy: @config.rpcs.batch_update_user_links.retry_policy
|
|
1630
|
-
|
|
1653
|
+
|
|
1654
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1655
|
+
metadata: @config.metadata,
|
|
1631
1656
|
retry_policy: @config.retry_policy
|
|
1632
1657
|
|
|
1633
1658
|
@analytics_admin_service_stub.call_rpc :batch_update_user_links, request, options: options do |response, operation|
|
|
@@ -1693,7 +1718,9 @@ module Google
|
|
|
1693
1718
|
options.apply_defaults timeout: @config.rpcs.delete_user_link.timeout,
|
|
1694
1719
|
metadata: metadata,
|
|
1695
1720
|
retry_policy: @config.rpcs.delete_user_link.retry_policy
|
|
1696
|
-
|
|
1721
|
+
|
|
1722
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1723
|
+
metadata: @config.metadata,
|
|
1697
1724
|
retry_policy: @config.retry_policy
|
|
1698
1725
|
|
|
1699
1726
|
@analytics_admin_service_stub.call_rpc :delete_user_link, request, options: options do |response, operation|
|
|
@@ -1765,7 +1792,9 @@ module Google
|
|
|
1765
1792
|
options.apply_defaults timeout: @config.rpcs.batch_delete_user_links.timeout,
|
|
1766
1793
|
metadata: metadata,
|
|
1767
1794
|
retry_policy: @config.rpcs.batch_delete_user_links.retry_policy
|
|
1768
|
-
|
|
1795
|
+
|
|
1796
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1797
|
+
metadata: @config.metadata,
|
|
1769
1798
|
retry_policy: @config.retry_policy
|
|
1770
1799
|
|
|
1771
1800
|
@analytics_admin_service_stub.call_rpc :batch_delete_user_links, request, options: options do |response, operation|
|
|
@@ -1833,7 +1862,9 @@ module Google
|
|
|
1833
1862
|
options.apply_defaults timeout: @config.rpcs.get_web_data_stream.timeout,
|
|
1834
1863
|
metadata: metadata,
|
|
1835
1864
|
retry_policy: @config.rpcs.get_web_data_stream.retry_policy
|
|
1836
|
-
|
|
1865
|
+
|
|
1866
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1867
|
+
metadata: @config.metadata,
|
|
1837
1868
|
retry_policy: @config.retry_policy
|
|
1838
1869
|
|
|
1839
1870
|
@analytics_admin_service_stub.call_rpc :get_web_data_stream, request, options: options do |response, operation|
|
|
@@ -1901,7 +1932,9 @@ module Google
|
|
|
1901
1932
|
options.apply_defaults timeout: @config.rpcs.delete_web_data_stream.timeout,
|
|
1902
1933
|
metadata: metadata,
|
|
1903
1934
|
retry_policy: @config.rpcs.delete_web_data_stream.retry_policy
|
|
1904
|
-
|
|
1935
|
+
|
|
1936
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1937
|
+
metadata: @config.metadata,
|
|
1905
1938
|
retry_policy: @config.retry_policy
|
|
1906
1939
|
|
|
1907
1940
|
@analytics_admin_service_stub.call_rpc :delete_web_data_stream, request, options: options do |response, operation|
|
|
@@ -1972,7 +2005,9 @@ module Google
|
|
|
1972
2005
|
options.apply_defaults timeout: @config.rpcs.update_web_data_stream.timeout,
|
|
1973
2006
|
metadata: metadata,
|
|
1974
2007
|
retry_policy: @config.rpcs.update_web_data_stream.retry_policy
|
|
1975
|
-
|
|
2008
|
+
|
|
2009
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2010
|
+
metadata: @config.metadata,
|
|
1976
2011
|
retry_policy: @config.retry_policy
|
|
1977
2012
|
|
|
1978
2013
|
@analytics_admin_service_stub.call_rpc :update_web_data_stream, request, options: options do |response, operation|
|
|
@@ -2041,7 +2076,9 @@ module Google
|
|
|
2041
2076
|
options.apply_defaults timeout: @config.rpcs.create_web_data_stream.timeout,
|
|
2042
2077
|
metadata: metadata,
|
|
2043
2078
|
retry_policy: @config.rpcs.create_web_data_stream.retry_policy
|
|
2044
|
-
|
|
2079
|
+
|
|
2080
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2081
|
+
metadata: @config.metadata,
|
|
2045
2082
|
retry_policy: @config.retry_policy
|
|
2046
2083
|
|
|
2047
2084
|
@analytics_admin_service_stub.call_rpc :create_web_data_stream, request, options: options do |response, operation|
|
|
@@ -2121,7 +2158,9 @@ module Google
|
|
|
2121
2158
|
options.apply_defaults timeout: @config.rpcs.list_web_data_streams.timeout,
|
|
2122
2159
|
metadata: metadata,
|
|
2123
2160
|
retry_policy: @config.rpcs.list_web_data_streams.retry_policy
|
|
2124
|
-
|
|
2161
|
+
|
|
2162
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2163
|
+
metadata: @config.metadata,
|
|
2125
2164
|
retry_policy: @config.retry_policy
|
|
2126
2165
|
|
|
2127
2166
|
@analytics_admin_service_stub.call_rpc :list_web_data_streams, request, options: options do |response, operation|
|
|
@@ -2190,7 +2229,9 @@ module Google
|
|
|
2190
2229
|
options.apply_defaults timeout: @config.rpcs.get_ios_app_data_stream.timeout,
|
|
2191
2230
|
metadata: metadata,
|
|
2192
2231
|
retry_policy: @config.rpcs.get_ios_app_data_stream.retry_policy
|
|
2193
|
-
|
|
2232
|
+
|
|
2233
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2234
|
+
metadata: @config.metadata,
|
|
2194
2235
|
retry_policy: @config.retry_policy
|
|
2195
2236
|
|
|
2196
2237
|
@analytics_admin_service_stub.call_rpc :get_ios_app_data_stream, request, options: options do |response, operation|
|
|
@@ -2258,7 +2299,9 @@ module Google
|
|
|
2258
2299
|
options.apply_defaults timeout: @config.rpcs.delete_ios_app_data_stream.timeout,
|
|
2259
2300
|
metadata: metadata,
|
|
2260
2301
|
retry_policy: @config.rpcs.delete_ios_app_data_stream.retry_policy
|
|
2261
|
-
|
|
2302
|
+
|
|
2303
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2304
|
+
metadata: @config.metadata,
|
|
2262
2305
|
retry_policy: @config.retry_policy
|
|
2263
2306
|
|
|
2264
2307
|
@analytics_admin_service_stub.call_rpc :delete_ios_app_data_stream, request, options: options do |response, operation|
|
|
@@ -2329,87 +2372,12 @@ module Google
|
|
|
2329
2372
|
options.apply_defaults timeout: @config.rpcs.update_ios_app_data_stream.timeout,
|
|
2330
2373
|
metadata: metadata,
|
|
2331
2374
|
retry_policy: @config.rpcs.update_ios_app_data_stream.retry_policy
|
|
2332
|
-
options.apply_defaults metadata: @config.metadata,
|
|
2333
|
-
retry_policy: @config.retry_policy
|
|
2334
|
-
|
|
2335
|
-
@analytics_admin_service_stub.call_rpc :update_ios_app_data_stream, request, options: options do |response, operation|
|
|
2336
|
-
yield response, operation if block_given?
|
|
2337
|
-
return response
|
|
2338
|
-
end
|
|
2339
|
-
rescue ::GRPC::BadStatus => e
|
|
2340
|
-
raise ::Google::Cloud::Error.from_error(e)
|
|
2341
|
-
end
|
|
2342
|
-
|
|
2343
|
-
##
|
|
2344
|
-
# Creates an iOS app stream with the specified location and attributes.
|
|
2345
|
-
#
|
|
2346
|
-
# Note that an iOS app stream must be linked to a Firebase app to receive
|
|
2347
|
-
# traffic.
|
|
2348
|
-
#
|
|
2349
|
-
# To create a working app stream, make sure your property is linked to a
|
|
2350
|
-
# Firebase project. Then, use the Firebase API to create a Firebase app,
|
|
2351
|
-
# which will also create an appropriate data stream in Analytics (may take up
|
|
2352
|
-
# to 24 hours).
|
|
2353
|
-
#
|
|
2354
|
-
# @overload create_ios_app_data_stream(request, options = nil)
|
|
2355
|
-
# Pass arguments to `create_ios_app_data_stream` via a request object, either of type
|
|
2356
|
-
# {::Google::Analytics::Admin::V1alpha::CreateIosAppDataStreamRequest} or an equivalent Hash.
|
|
2357
|
-
#
|
|
2358
|
-
# @param request [::Google::Analytics::Admin::V1alpha::CreateIosAppDataStreamRequest, ::Hash]
|
|
2359
|
-
# A request object representing the call parameters. Required. To specify no
|
|
2360
|
-
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2361
|
-
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2362
|
-
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2363
|
-
#
|
|
2364
|
-
# @overload create_ios_app_data_stream(ios_app_data_stream: nil, parent: nil)
|
|
2365
|
-
# Pass arguments to `create_ios_app_data_stream` via keyword arguments. Note that at
|
|
2366
|
-
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2367
|
-
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2368
|
-
#
|
|
2369
|
-
# @param ios_app_data_stream [::Google::Analytics::Admin::V1alpha::IosAppDataStream, ::Hash]
|
|
2370
|
-
# Required. The iOS app data stream to create.
|
|
2371
|
-
# @param parent [::String]
|
|
2372
|
-
# Required. The parent resource where this ios app data stream will be created.
|
|
2373
|
-
# Format: properties/123
|
|
2374
|
-
#
|
|
2375
|
-
# @yield [response, operation] Access the result along with the RPC operation
|
|
2376
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
|
|
2377
|
-
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2378
|
-
#
|
|
2379
|
-
# @return [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
|
|
2380
|
-
#
|
|
2381
|
-
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2382
|
-
#
|
|
2383
|
-
def create_ios_app_data_stream request, options = nil
|
|
2384
|
-
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2385
|
-
|
|
2386
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateIosAppDataStreamRequest
|
|
2387
|
-
|
|
2388
|
-
# Converts hash and nil to an options object
|
|
2389
|
-
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2390
|
-
|
|
2391
|
-
# Customize the options with defaults
|
|
2392
|
-
metadata = @config.rpcs.create_ios_app_data_stream.metadata.to_h
|
|
2393
|
-
|
|
2394
|
-
# Set x-goog-api-client and x-goog-user-project headers
|
|
2395
|
-
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2396
|
-
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2397
|
-
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
2398
|
-
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2399
|
-
|
|
2400
|
-
header_params = {
|
|
2401
|
-
"parent" => request.parent
|
|
2402
|
-
}
|
|
2403
|
-
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2404
|
-
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2405
2375
|
|
|
2406
|
-
options.apply_defaults timeout: @config.
|
|
2407
|
-
metadata: metadata,
|
|
2408
|
-
retry_policy: @config.rpcs.create_ios_app_data_stream.retry_policy
|
|
2409
|
-
options.apply_defaults metadata: @config.metadata,
|
|
2376
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2377
|
+
metadata: @config.metadata,
|
|
2410
2378
|
retry_policy: @config.retry_policy
|
|
2411
2379
|
|
|
2412
|
-
@analytics_admin_service_stub.call_rpc :
|
|
2380
|
+
@analytics_admin_service_stub.call_rpc :update_ios_app_data_stream, request, options: options do |response, operation|
|
|
2413
2381
|
yield response, operation if block_given?
|
|
2414
2382
|
return response
|
|
2415
2383
|
end
|
|
@@ -2486,7 +2454,9 @@ module Google
|
|
|
2486
2454
|
options.apply_defaults timeout: @config.rpcs.list_ios_app_data_streams.timeout,
|
|
2487
2455
|
metadata: metadata,
|
|
2488
2456
|
retry_policy: @config.rpcs.list_ios_app_data_streams.retry_policy
|
|
2489
|
-
|
|
2457
|
+
|
|
2458
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2459
|
+
metadata: @config.metadata,
|
|
2490
2460
|
retry_policy: @config.retry_policy
|
|
2491
2461
|
|
|
2492
2462
|
@analytics_admin_service_stub.call_rpc :list_ios_app_data_streams, request, options: options do |response, operation|
|
|
@@ -2555,7 +2525,9 @@ module Google
|
|
|
2555
2525
|
options.apply_defaults timeout: @config.rpcs.get_android_app_data_stream.timeout,
|
|
2556
2526
|
metadata: metadata,
|
|
2557
2527
|
retry_policy: @config.rpcs.get_android_app_data_stream.retry_policy
|
|
2558
|
-
|
|
2528
|
+
|
|
2529
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2530
|
+
metadata: @config.metadata,
|
|
2559
2531
|
retry_policy: @config.retry_policy
|
|
2560
2532
|
|
|
2561
2533
|
@analytics_admin_service_stub.call_rpc :get_android_app_data_stream, request, options: options do |response, operation|
|
|
@@ -2623,7 +2595,9 @@ module Google
|
|
|
2623
2595
|
options.apply_defaults timeout: @config.rpcs.delete_android_app_data_stream.timeout,
|
|
2624
2596
|
metadata: metadata,
|
|
2625
2597
|
retry_policy: @config.rpcs.delete_android_app_data_stream.retry_policy
|
|
2626
|
-
|
|
2598
|
+
|
|
2599
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2600
|
+
metadata: @config.metadata,
|
|
2627
2601
|
retry_policy: @config.retry_policy
|
|
2628
2602
|
|
|
2629
2603
|
@analytics_admin_service_stub.call_rpc :delete_android_app_data_stream, request, options: options do |response, operation|
|
|
@@ -2694,87 +2668,12 @@ module Google
|
|
|
2694
2668
|
options.apply_defaults timeout: @config.rpcs.update_android_app_data_stream.timeout,
|
|
2695
2669
|
metadata: metadata,
|
|
2696
2670
|
retry_policy: @config.rpcs.update_android_app_data_stream.retry_policy
|
|
2697
|
-
options.apply_defaults metadata: @config.metadata,
|
|
2698
|
-
retry_policy: @config.retry_policy
|
|
2699
|
-
|
|
2700
|
-
@analytics_admin_service_stub.call_rpc :update_android_app_data_stream, request, options: options do |response, operation|
|
|
2701
|
-
yield response, operation if block_given?
|
|
2702
|
-
return response
|
|
2703
|
-
end
|
|
2704
|
-
rescue ::GRPC::BadStatus => e
|
|
2705
|
-
raise ::Google::Cloud::Error.from_error(e)
|
|
2706
|
-
end
|
|
2707
|
-
|
|
2708
|
-
##
|
|
2709
|
-
# Creates an Android app stream with the specified location and attributes.
|
|
2710
|
-
#
|
|
2711
|
-
# Note that an Android app stream must be linked to a Firebase app to receive
|
|
2712
|
-
# traffic.
|
|
2713
|
-
#
|
|
2714
|
-
# To create a working app stream, make sure your property is linked to a
|
|
2715
|
-
# Firebase project. Then, use the Firebase API to create a Firebase app,
|
|
2716
|
-
# which will also create an appropriate data stream in Analytics (may take up
|
|
2717
|
-
# to 24 hours).
|
|
2718
|
-
#
|
|
2719
|
-
# @overload create_android_app_data_stream(request, options = nil)
|
|
2720
|
-
# Pass arguments to `create_android_app_data_stream` via a request object, either of type
|
|
2721
|
-
# {::Google::Analytics::Admin::V1alpha::CreateAndroidAppDataStreamRequest} or an equivalent Hash.
|
|
2722
|
-
#
|
|
2723
|
-
# @param request [::Google::Analytics::Admin::V1alpha::CreateAndroidAppDataStreamRequest, ::Hash]
|
|
2724
|
-
# A request object representing the call parameters. Required. To specify no
|
|
2725
|
-
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2726
|
-
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2727
|
-
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2728
|
-
#
|
|
2729
|
-
# @overload create_android_app_data_stream(android_app_data_stream: nil, parent: nil)
|
|
2730
|
-
# Pass arguments to `create_android_app_data_stream` via keyword arguments. Note that at
|
|
2731
|
-
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2732
|
-
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2733
|
-
#
|
|
2734
|
-
# @param android_app_data_stream [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream, ::Hash]
|
|
2735
|
-
# Required. The android app stream to create.
|
|
2736
|
-
# @param parent [::String]
|
|
2737
|
-
# Required. The parent resource where this android app data stream will be created.
|
|
2738
|
-
# Format: properties/123
|
|
2739
|
-
#
|
|
2740
|
-
# @yield [response, operation] Access the result along with the RPC operation
|
|
2741
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
|
|
2742
|
-
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2743
|
-
#
|
|
2744
|
-
# @return [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
|
|
2745
|
-
#
|
|
2746
|
-
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2747
|
-
#
|
|
2748
|
-
def create_android_app_data_stream request, options = nil
|
|
2749
|
-
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2750
|
-
|
|
2751
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateAndroidAppDataStreamRequest
|
|
2752
|
-
|
|
2753
|
-
# Converts hash and nil to an options object
|
|
2754
|
-
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2755
|
-
|
|
2756
|
-
# Customize the options with defaults
|
|
2757
|
-
metadata = @config.rpcs.create_android_app_data_stream.metadata.to_h
|
|
2758
|
-
|
|
2759
|
-
# Set x-goog-api-client and x-goog-user-project headers
|
|
2760
|
-
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2761
|
-
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2762
|
-
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
2763
|
-
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2764
2671
|
|
|
2765
|
-
|
|
2766
|
-
|
|
2767
|
-
}
|
|
2768
|
-
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2769
|
-
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2770
|
-
|
|
2771
|
-
options.apply_defaults timeout: @config.rpcs.create_android_app_data_stream.timeout,
|
|
2772
|
-
metadata: metadata,
|
|
2773
|
-
retry_policy: @config.rpcs.create_android_app_data_stream.retry_policy
|
|
2774
|
-
options.apply_defaults metadata: @config.metadata,
|
|
2672
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2673
|
+
metadata: @config.metadata,
|
|
2775
2674
|
retry_policy: @config.retry_policy
|
|
2776
2675
|
|
|
2777
|
-
@analytics_admin_service_stub.call_rpc :
|
|
2676
|
+
@analytics_admin_service_stub.call_rpc :update_android_app_data_stream, request, options: options do |response, operation|
|
|
2778
2677
|
yield response, operation if block_given?
|
|
2779
2678
|
return response
|
|
2780
2679
|
end
|
|
@@ -2853,7 +2752,9 @@ module Google
|
|
|
2853
2752
|
options.apply_defaults timeout: @config.rpcs.list_android_app_data_streams.timeout,
|
|
2854
2753
|
metadata: metadata,
|
|
2855
2754
|
retry_policy: @config.rpcs.list_android_app_data_streams.retry_policy
|
|
2856
|
-
|
|
2755
|
+
|
|
2756
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2757
|
+
metadata: @config.metadata,
|
|
2857
2758
|
retry_policy: @config.retry_policy
|
|
2858
2759
|
|
|
2859
2760
|
@analytics_admin_service_stub.call_rpc :list_android_app_data_streams, request, options: options do |response, operation|
|
|
@@ -2925,7 +2826,9 @@ module Google
|
|
|
2925
2826
|
options.apply_defaults timeout: @config.rpcs.get_enhanced_measurement_settings.timeout,
|
|
2926
2827
|
metadata: metadata,
|
|
2927
2828
|
retry_policy: @config.rpcs.get_enhanced_measurement_settings.retry_policy
|
|
2928
|
-
|
|
2829
|
+
|
|
2830
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2831
|
+
metadata: @config.metadata,
|
|
2929
2832
|
retry_policy: @config.retry_policy
|
|
2930
2833
|
|
|
2931
2834
|
@analytics_admin_service_stub.call_rpc :get_enhanced_measurement_settings, request, options: options do |response, operation|
|
|
@@ -2998,7 +2901,9 @@ module Google
|
|
|
2998
2901
|
options.apply_defaults timeout: @config.rpcs.update_enhanced_measurement_settings.timeout,
|
|
2999
2902
|
metadata: metadata,
|
|
3000
2903
|
retry_policy: @config.rpcs.update_enhanced_measurement_settings.retry_policy
|
|
3001
|
-
|
|
2904
|
+
|
|
2905
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2906
|
+
metadata: @config.metadata,
|
|
3002
2907
|
retry_policy: @config.retry_policy
|
|
3003
2908
|
|
|
3004
2909
|
@analytics_admin_service_stub.call_rpc :update_enhanced_measurement_settings, request, options: options do |response, operation|
|
|
@@ -3069,7 +2974,9 @@ module Google
|
|
|
3069
2974
|
options.apply_defaults timeout: @config.rpcs.create_firebase_link.timeout,
|
|
3070
2975
|
metadata: metadata,
|
|
3071
2976
|
retry_policy: @config.rpcs.create_firebase_link.retry_policy
|
|
3072
|
-
|
|
2977
|
+
|
|
2978
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2979
|
+
metadata: @config.metadata,
|
|
3073
2980
|
retry_policy: @config.retry_policy
|
|
3074
2981
|
|
|
3075
2982
|
@analytics_admin_service_stub.call_rpc :create_firebase_link, request, options: options do |response, operation|
|
|
@@ -3139,7 +3046,9 @@ module Google
|
|
|
3139
3046
|
options.apply_defaults timeout: @config.rpcs.update_firebase_link.timeout,
|
|
3140
3047
|
metadata: metadata,
|
|
3141
3048
|
retry_policy: @config.rpcs.update_firebase_link.retry_policy
|
|
3142
|
-
|
|
3049
|
+
|
|
3050
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3051
|
+
metadata: @config.metadata,
|
|
3143
3052
|
retry_policy: @config.retry_policy
|
|
3144
3053
|
|
|
3145
3054
|
@analytics_admin_service_stub.call_rpc :update_firebase_link, request, options: options do |response, operation|
|
|
@@ -3206,7 +3115,9 @@ module Google
|
|
|
3206
3115
|
options.apply_defaults timeout: @config.rpcs.delete_firebase_link.timeout,
|
|
3207
3116
|
metadata: metadata,
|
|
3208
3117
|
retry_policy: @config.rpcs.delete_firebase_link.retry_policy
|
|
3209
|
-
|
|
3118
|
+
|
|
3119
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3120
|
+
metadata: @config.metadata,
|
|
3210
3121
|
retry_policy: @config.retry_policy
|
|
3211
3122
|
|
|
3212
3123
|
@analytics_admin_service_stub.call_rpc :delete_firebase_link, request, options: options do |response, operation|
|
|
@@ -3284,7 +3195,9 @@ module Google
|
|
|
3284
3195
|
options.apply_defaults timeout: @config.rpcs.list_firebase_links.timeout,
|
|
3285
3196
|
metadata: metadata,
|
|
3286
3197
|
retry_policy: @config.rpcs.list_firebase_links.retry_policy
|
|
3287
|
-
|
|
3198
|
+
|
|
3199
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3200
|
+
metadata: @config.metadata,
|
|
3288
3201
|
retry_policy: @config.retry_policy
|
|
3289
3202
|
|
|
3290
3203
|
@analytics_admin_service_stub.call_rpc :list_firebase_links, request, options: options do |response, operation|
|
|
@@ -3355,7 +3268,9 @@ module Google
|
|
|
3355
3268
|
options.apply_defaults timeout: @config.rpcs.get_global_site_tag.timeout,
|
|
3356
3269
|
metadata: metadata,
|
|
3357
3270
|
retry_policy: @config.rpcs.get_global_site_tag.retry_policy
|
|
3358
|
-
|
|
3271
|
+
|
|
3272
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3273
|
+
metadata: @config.metadata,
|
|
3359
3274
|
retry_policy: @config.retry_policy
|
|
3360
3275
|
|
|
3361
3276
|
@analytics_admin_service_stub.call_rpc :get_global_site_tag, request, options: options do |response, operation|
|
|
@@ -3423,7 +3338,9 @@ module Google
|
|
|
3423
3338
|
options.apply_defaults timeout: @config.rpcs.create_google_ads_link.timeout,
|
|
3424
3339
|
metadata: metadata,
|
|
3425
3340
|
retry_policy: @config.rpcs.create_google_ads_link.retry_policy
|
|
3426
|
-
|
|
3341
|
+
|
|
3342
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3343
|
+
metadata: @config.metadata,
|
|
3427
3344
|
retry_policy: @config.retry_policy
|
|
3428
3345
|
|
|
3429
3346
|
@analytics_admin_service_stub.call_rpc :create_google_ads_link, request, options: options do |response, operation|
|
|
@@ -3493,7 +3410,9 @@ module Google
|
|
|
3493
3410
|
options.apply_defaults timeout: @config.rpcs.update_google_ads_link.timeout,
|
|
3494
3411
|
metadata: metadata,
|
|
3495
3412
|
retry_policy: @config.rpcs.update_google_ads_link.retry_policy
|
|
3496
|
-
|
|
3413
|
+
|
|
3414
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3415
|
+
metadata: @config.metadata,
|
|
3497
3416
|
retry_policy: @config.retry_policy
|
|
3498
3417
|
|
|
3499
3418
|
@analytics_admin_service_stub.call_rpc :update_google_ads_link, request, options: options do |response, operation|
|
|
@@ -3559,7 +3478,9 @@ module Google
|
|
|
3559
3478
|
options.apply_defaults timeout: @config.rpcs.delete_google_ads_link.timeout,
|
|
3560
3479
|
metadata: metadata,
|
|
3561
3480
|
retry_policy: @config.rpcs.delete_google_ads_link.retry_policy
|
|
3562
|
-
|
|
3481
|
+
|
|
3482
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3483
|
+
metadata: @config.metadata,
|
|
3563
3484
|
retry_policy: @config.retry_policy
|
|
3564
3485
|
|
|
3565
3486
|
@analytics_admin_service_stub.call_rpc :delete_google_ads_link, request, options: options do |response, operation|
|
|
@@ -3635,7 +3556,9 @@ module Google
|
|
|
3635
3556
|
options.apply_defaults timeout: @config.rpcs.list_google_ads_links.timeout,
|
|
3636
3557
|
metadata: metadata,
|
|
3637
3558
|
retry_policy: @config.rpcs.list_google_ads_links.retry_policy
|
|
3638
|
-
|
|
3559
|
+
|
|
3560
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3561
|
+
metadata: @config.metadata,
|
|
3639
3562
|
retry_policy: @config.retry_policy
|
|
3640
3563
|
|
|
3641
3564
|
@analytics_admin_service_stub.call_rpc :list_google_ads_links, request, options: options do |response, operation|
|
|
@@ -3705,7 +3628,9 @@ module Google
|
|
|
3705
3628
|
options.apply_defaults timeout: @config.rpcs.get_data_sharing_settings.timeout,
|
|
3706
3629
|
metadata: metadata,
|
|
3707
3630
|
retry_policy: @config.rpcs.get_data_sharing_settings.retry_policy
|
|
3708
|
-
|
|
3631
|
+
|
|
3632
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3633
|
+
metadata: @config.metadata,
|
|
3709
3634
|
retry_policy: @config.retry_policy
|
|
3710
3635
|
|
|
3711
3636
|
@analytics_admin_service_stub.call_rpc :get_data_sharing_settings, request, options: options do |response, operation|
|
|
@@ -3717,107 +3642,1723 @@ module Google
|
|
|
3717
3642
|
end
|
|
3718
3643
|
|
|
3719
3644
|
##
|
|
3720
|
-
#
|
|
3721
|
-
#
|
|
3722
|
-
# This class represents the configuration for AnalyticsAdminService,
|
|
3723
|
-
# providing control over timeouts, retry behavior, logging, transport
|
|
3724
|
-
# parameters, and other low-level controls. Certain parameters can also be
|
|
3725
|
-
# applied individually to specific RPCs. See
|
|
3726
|
-
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
|
3727
|
-
# for a list of RPCs that can be configured independently.
|
|
3645
|
+
# Lookup for a single "GA4" MeasurementProtocolSecret.
|
|
3728
3646
|
#
|
|
3729
|
-
#
|
|
3730
|
-
#
|
|
3647
|
+
# @overload get_measurement_protocol_secret(request, options = nil)
|
|
3648
|
+
# Pass arguments to `get_measurement_protocol_secret` via a request object, either of type
|
|
3649
|
+
# {::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3731
3650
|
#
|
|
3732
|
-
#
|
|
3651
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest, ::Hash]
|
|
3652
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3653
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3654
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3655
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3733
3656
|
#
|
|
3734
|
-
#
|
|
3735
|
-
# to
|
|
3657
|
+
# @overload get_measurement_protocol_secret(name: nil)
|
|
3658
|
+
# Pass arguments to `get_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3659
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3660
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3736
3661
|
#
|
|
3737
|
-
#
|
|
3738
|
-
#
|
|
3739
|
-
#
|
|
3740
|
-
#
|
|
3662
|
+
# @param name [::String]
|
|
3663
|
+
# Required. The name of the measurement protocol secret to lookup.
|
|
3664
|
+
# Format:
|
|
3665
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
|
3666
|
+
# Note: Any type of stream (WebDataStream, IosAppDataStream,
|
|
3667
|
+
# AndroidAppDataStream) may be a parent.
|
|
3741
3668
|
#
|
|
3742
|
-
#
|
|
3669
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3670
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3671
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3743
3672
|
#
|
|
3744
|
-
#
|
|
3745
|
-
# config.timeout = 10.0
|
|
3746
|
-
# config.rpcs.get_account.timeout = 20.0
|
|
3747
|
-
# end
|
|
3673
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3748
3674
|
#
|
|
3749
|
-
#
|
|
3750
|
-
# The hostname or hostname:port of the service endpoint.
|
|
3751
|
-
# Defaults to `"analyticsadmin.googleapis.com"`.
|
|
3752
|
-
# @return [::String]
|
|
3753
|
-
# @!attribute [rw] credentials
|
|
3754
|
-
# Credentials to send with calls. You may provide any of the following types:
|
|
3755
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
3756
|
-
# * (`Hash`) A service account key as a Hash
|
|
3757
|
-
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
3758
|
-
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
|
3759
|
-
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
3760
|
-
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
|
3761
|
-
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
|
3762
|
-
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
3763
|
-
# * (`nil`) indicating no credentials
|
|
3764
|
-
# @return [::Object]
|
|
3765
|
-
# @!attribute [rw] scope
|
|
3766
|
-
# The OAuth scopes
|
|
3767
|
-
# @return [::Array<::String>]
|
|
3768
|
-
# @!attribute [rw] lib_name
|
|
3769
|
-
# The library name as recorded in instrumentation and logging
|
|
3770
|
-
# @return [::String]
|
|
3771
|
-
# @!attribute [rw] lib_version
|
|
3772
|
-
# The library version as recorded in instrumentation and logging
|
|
3773
|
-
# @return [::String]
|
|
3774
|
-
# @!attribute [rw] channel_args
|
|
3775
|
-
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
|
3776
|
-
# `GRPC::Core::Channel` object is provided as the credential.
|
|
3777
|
-
# @return [::Hash]
|
|
3778
|
-
# @!attribute [rw] interceptors
|
|
3779
|
-
# An array of interceptors that are run before calls are executed.
|
|
3780
|
-
# @return [::Array<::GRPC::ClientInterceptor>]
|
|
3781
|
-
# @!attribute [rw] timeout
|
|
3782
|
-
# The call timeout in seconds.
|
|
3783
|
-
# @return [::Numeric]
|
|
3784
|
-
# @!attribute [rw] metadata
|
|
3785
|
-
# Additional gRPC headers to be sent with the call.
|
|
3786
|
-
# @return [::Hash{::Symbol=>::String}]
|
|
3787
|
-
# @!attribute [rw] retry_policy
|
|
3788
|
-
# The retry policy. The value is a hash with the following keys:
|
|
3789
|
-
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
3790
|
-
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
3791
|
-
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
3792
|
-
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
3793
|
-
# trigger a retry.
|
|
3794
|
-
# @return [::Hash]
|
|
3795
|
-
# @!attribute [rw] quota_project
|
|
3796
|
-
# A separate project against which to charge quota.
|
|
3797
|
-
# @return [::String]
|
|
3675
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3798
3676
|
#
|
|
3799
|
-
|
|
3800
|
-
|
|
3677
|
+
def get_measurement_protocol_secret request, options = nil
|
|
3678
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3801
3679
|
|
|
3802
|
-
|
|
3803
|
-
config_attr :credentials, nil do |value|
|
|
3804
|
-
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3805
|
-
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
3806
|
-
allowed.any? { |klass| klass === value }
|
|
3807
|
-
end
|
|
3808
|
-
config_attr :scope, nil, ::String, ::Array, nil
|
|
3809
|
-
config_attr :lib_name, nil, ::String, nil
|
|
3810
|
-
config_attr :lib_version, nil, ::String, nil
|
|
3811
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
3812
|
-
config_attr :interceptors, nil, ::Array, nil
|
|
3813
|
-
config_attr :timeout, nil, ::Numeric, nil
|
|
3814
|
-
config_attr :metadata, nil, ::Hash, nil
|
|
3815
|
-
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3816
|
-
config_attr :quota_project, nil, ::String, nil
|
|
3680
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest
|
|
3817
3681
|
|
|
3818
|
-
#
|
|
3819
|
-
|
|
3820
|
-
|
|
3682
|
+
# Converts hash and nil to an options object
|
|
3683
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3684
|
+
|
|
3685
|
+
# Customize the options with defaults
|
|
3686
|
+
metadata = @config.rpcs.get_measurement_protocol_secret.metadata.to_h
|
|
3687
|
+
|
|
3688
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3689
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3690
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3691
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3692
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3693
|
+
|
|
3694
|
+
header_params = {
|
|
3695
|
+
"name" => request.name
|
|
3696
|
+
}
|
|
3697
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3698
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3699
|
+
|
|
3700
|
+
options.apply_defaults timeout: @config.rpcs.get_measurement_protocol_secret.timeout,
|
|
3701
|
+
metadata: metadata,
|
|
3702
|
+
retry_policy: @config.rpcs.get_measurement_protocol_secret.retry_policy
|
|
3703
|
+
|
|
3704
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3705
|
+
metadata: @config.metadata,
|
|
3706
|
+
retry_policy: @config.retry_policy
|
|
3707
|
+
|
|
3708
|
+
@analytics_admin_service_stub.call_rpc :get_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3709
|
+
yield response, operation if block_given?
|
|
3710
|
+
return response
|
|
3711
|
+
end
|
|
3712
|
+
rescue ::GRPC::BadStatus => e
|
|
3713
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3714
|
+
end
|
|
3715
|
+
|
|
3716
|
+
##
|
|
3717
|
+
# Returns child MeasurementProtocolSecrets under the specified parent
|
|
3718
|
+
# Property.
|
|
3719
|
+
#
|
|
3720
|
+
# @overload list_measurement_protocol_secrets(request, options = nil)
|
|
3721
|
+
# Pass arguments to `list_measurement_protocol_secrets` via a request object, either of type
|
|
3722
|
+
# {::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest} or an equivalent Hash.
|
|
3723
|
+
#
|
|
3724
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest, ::Hash]
|
|
3725
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3726
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3727
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3728
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3729
|
+
#
|
|
3730
|
+
# @overload list_measurement_protocol_secrets(parent: nil, page_size: nil, page_token: nil)
|
|
3731
|
+
# Pass arguments to `list_measurement_protocol_secrets` via keyword arguments. Note that at
|
|
3732
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3733
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3734
|
+
#
|
|
3735
|
+
# @param parent [::String]
|
|
3736
|
+
# Required. The resource name of the parent stream.
|
|
3737
|
+
# Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
|
|
3738
|
+
# may be a parent.
|
|
3739
|
+
# Format:
|
|
3740
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets
|
|
3741
|
+
# @param page_size [::Integer]
|
|
3742
|
+
# The maximum number of resources to return.
|
|
3743
|
+
# If unspecified, at most 10 resources will be returned.
|
|
3744
|
+
# The maximum value is 10. Higher values will be coerced to the maximum.
|
|
3745
|
+
# @param page_token [::String]
|
|
3746
|
+
# A page token, received from a previous `ListMeasurementProtocolSecrets`
|
|
3747
|
+
# call. Provide this to retrieve the subsequent page. When paginating, all
|
|
3748
|
+
# other parameters provided to `ListMeasurementProtocolSecrets` must match
|
|
3749
|
+
# the call that provided the page token.
|
|
3750
|
+
#
|
|
3751
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3752
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
|
|
3753
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3754
|
+
#
|
|
3755
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
|
|
3756
|
+
#
|
|
3757
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3758
|
+
#
|
|
3759
|
+
def list_measurement_protocol_secrets request, options = nil
|
|
3760
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3761
|
+
|
|
3762
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest
|
|
3763
|
+
|
|
3764
|
+
# Converts hash and nil to an options object
|
|
3765
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3766
|
+
|
|
3767
|
+
# Customize the options with defaults
|
|
3768
|
+
metadata = @config.rpcs.list_measurement_protocol_secrets.metadata.to_h
|
|
3769
|
+
|
|
3770
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3771
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3772
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3773
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3774
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3775
|
+
|
|
3776
|
+
header_params = {
|
|
3777
|
+
"parent" => request.parent
|
|
3778
|
+
}
|
|
3779
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3780
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3781
|
+
|
|
3782
|
+
options.apply_defaults timeout: @config.rpcs.list_measurement_protocol_secrets.timeout,
|
|
3783
|
+
metadata: metadata,
|
|
3784
|
+
retry_policy: @config.rpcs.list_measurement_protocol_secrets.retry_policy
|
|
3785
|
+
|
|
3786
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3787
|
+
metadata: @config.metadata,
|
|
3788
|
+
retry_policy: @config.retry_policy
|
|
3789
|
+
|
|
3790
|
+
@analytics_admin_service_stub.call_rpc :list_measurement_protocol_secrets, request, options: options do |response, operation|
|
|
3791
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_measurement_protocol_secrets, request, response, operation, options
|
|
3792
|
+
yield response, operation if block_given?
|
|
3793
|
+
return response
|
|
3794
|
+
end
|
|
3795
|
+
rescue ::GRPC::BadStatus => e
|
|
3796
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3797
|
+
end
|
|
3798
|
+
|
|
3799
|
+
##
|
|
3800
|
+
# Creates a measurement protocol secret.
|
|
3801
|
+
#
|
|
3802
|
+
# @overload create_measurement_protocol_secret(request, options = nil)
|
|
3803
|
+
# Pass arguments to `create_measurement_protocol_secret` via a request object, either of type
|
|
3804
|
+
# {::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3805
|
+
#
|
|
3806
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest, ::Hash]
|
|
3807
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3808
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3809
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3810
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3811
|
+
#
|
|
3812
|
+
# @overload create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil)
|
|
3813
|
+
# Pass arguments to `create_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3814
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3815
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3816
|
+
#
|
|
3817
|
+
# @param parent [::String]
|
|
3818
|
+
# Required. The parent resource where this secret will be created.
|
|
3819
|
+
# Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
|
|
3820
|
+
# may be a parent.
|
|
3821
|
+
# Format: properties/\\{property}/webDataStreams/\\{webDataStream}
|
|
3822
|
+
# @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
|
|
3823
|
+
# Required. The measurement protocol secret to create.
|
|
3824
|
+
#
|
|
3825
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3826
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3827
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3828
|
+
#
|
|
3829
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3830
|
+
#
|
|
3831
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3832
|
+
#
|
|
3833
|
+
def create_measurement_protocol_secret request, options = nil
|
|
3834
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3835
|
+
|
|
3836
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest
|
|
3837
|
+
|
|
3838
|
+
# Converts hash and nil to an options object
|
|
3839
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3840
|
+
|
|
3841
|
+
# Customize the options with defaults
|
|
3842
|
+
metadata = @config.rpcs.create_measurement_protocol_secret.metadata.to_h
|
|
3843
|
+
|
|
3844
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3845
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3846
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3847
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3848
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3849
|
+
|
|
3850
|
+
header_params = {
|
|
3851
|
+
"parent" => request.parent
|
|
3852
|
+
}
|
|
3853
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3854
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3855
|
+
|
|
3856
|
+
options.apply_defaults timeout: @config.rpcs.create_measurement_protocol_secret.timeout,
|
|
3857
|
+
metadata: metadata,
|
|
3858
|
+
retry_policy: @config.rpcs.create_measurement_protocol_secret.retry_policy
|
|
3859
|
+
|
|
3860
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3861
|
+
metadata: @config.metadata,
|
|
3862
|
+
retry_policy: @config.retry_policy
|
|
3863
|
+
|
|
3864
|
+
@analytics_admin_service_stub.call_rpc :create_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3865
|
+
yield response, operation if block_given?
|
|
3866
|
+
return response
|
|
3867
|
+
end
|
|
3868
|
+
rescue ::GRPC::BadStatus => e
|
|
3869
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3870
|
+
end
|
|
3871
|
+
|
|
3872
|
+
##
|
|
3873
|
+
# Deletes target MeasurementProtocolSecret.
|
|
3874
|
+
#
|
|
3875
|
+
# @overload delete_measurement_protocol_secret(request, options = nil)
|
|
3876
|
+
# Pass arguments to `delete_measurement_protocol_secret` via a request object, either of type
|
|
3877
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3878
|
+
#
|
|
3879
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest, ::Hash]
|
|
3880
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3881
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3882
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3883
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3884
|
+
#
|
|
3885
|
+
# @overload delete_measurement_protocol_secret(name: nil)
|
|
3886
|
+
# Pass arguments to `delete_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3887
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3888
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3889
|
+
#
|
|
3890
|
+
# @param name [::String]
|
|
3891
|
+
# Required. The name of the MeasurementProtocolSecret to delete.
|
|
3892
|
+
# Format:
|
|
3893
|
+
# properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
|
|
3894
|
+
# Note: Any type of stream (WebDataStream, IosAppDataStream,
|
|
3895
|
+
# AndroidAppDataStream) may be a parent.
|
|
3896
|
+
#
|
|
3897
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3898
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
3899
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3900
|
+
#
|
|
3901
|
+
# @return [::Google::Protobuf::Empty]
|
|
3902
|
+
#
|
|
3903
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3904
|
+
#
|
|
3905
|
+
def delete_measurement_protocol_secret request, options = nil
|
|
3906
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3907
|
+
|
|
3908
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest
|
|
3909
|
+
|
|
3910
|
+
# Converts hash and nil to an options object
|
|
3911
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3912
|
+
|
|
3913
|
+
# Customize the options with defaults
|
|
3914
|
+
metadata = @config.rpcs.delete_measurement_protocol_secret.metadata.to_h
|
|
3915
|
+
|
|
3916
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3917
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3918
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3919
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3920
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3921
|
+
|
|
3922
|
+
header_params = {
|
|
3923
|
+
"name" => request.name
|
|
3924
|
+
}
|
|
3925
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3926
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3927
|
+
|
|
3928
|
+
options.apply_defaults timeout: @config.rpcs.delete_measurement_protocol_secret.timeout,
|
|
3929
|
+
metadata: metadata,
|
|
3930
|
+
retry_policy: @config.rpcs.delete_measurement_protocol_secret.retry_policy
|
|
3931
|
+
|
|
3932
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3933
|
+
metadata: @config.metadata,
|
|
3934
|
+
retry_policy: @config.retry_policy
|
|
3935
|
+
|
|
3936
|
+
@analytics_admin_service_stub.call_rpc :delete_measurement_protocol_secret, request, options: options do |response, operation|
|
|
3937
|
+
yield response, operation if block_given?
|
|
3938
|
+
return response
|
|
3939
|
+
end
|
|
3940
|
+
rescue ::GRPC::BadStatus => e
|
|
3941
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3942
|
+
end
|
|
3943
|
+
|
|
3944
|
+
##
|
|
3945
|
+
# Updates a measurement protocol secret.
|
|
3946
|
+
#
|
|
3947
|
+
# @overload update_measurement_protocol_secret(request, options = nil)
|
|
3948
|
+
# Pass arguments to `update_measurement_protocol_secret` via a request object, either of type
|
|
3949
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest} or an equivalent Hash.
|
|
3950
|
+
#
|
|
3951
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest, ::Hash]
|
|
3952
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3953
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3954
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3955
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3956
|
+
#
|
|
3957
|
+
# @overload update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil)
|
|
3958
|
+
# Pass arguments to `update_measurement_protocol_secret` via keyword arguments. Note that at
|
|
3959
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3960
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3961
|
+
#
|
|
3962
|
+
# @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
|
|
3963
|
+
# Required. The measurement protocol secret to update.
|
|
3964
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
3965
|
+
# The list of fields to be updated. Omitted fields will not be updated.
|
|
3966
|
+
#
|
|
3967
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3968
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3969
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3970
|
+
#
|
|
3971
|
+
# @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
|
|
3972
|
+
#
|
|
3973
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3974
|
+
#
|
|
3975
|
+
def update_measurement_protocol_secret request, options = nil
|
|
3976
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3977
|
+
|
|
3978
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest
|
|
3979
|
+
|
|
3980
|
+
# Converts hash and nil to an options object
|
|
3981
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3982
|
+
|
|
3983
|
+
# Customize the options with defaults
|
|
3984
|
+
metadata = @config.rpcs.update_measurement_protocol_secret.metadata.to_h
|
|
3985
|
+
|
|
3986
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3987
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3988
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3989
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
3990
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3991
|
+
|
|
3992
|
+
header_params = {
|
|
3993
|
+
"measurement_protocol_secret.name" => request.measurement_protocol_secret.name
|
|
3994
|
+
}
|
|
3995
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3996
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3997
|
+
|
|
3998
|
+
options.apply_defaults timeout: @config.rpcs.update_measurement_protocol_secret.timeout,
|
|
3999
|
+
metadata: metadata,
|
|
4000
|
+
retry_policy: @config.rpcs.update_measurement_protocol_secret.retry_policy
|
|
4001
|
+
|
|
4002
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4003
|
+
metadata: @config.metadata,
|
|
4004
|
+
retry_policy: @config.retry_policy
|
|
4005
|
+
|
|
4006
|
+
@analytics_admin_service_stub.call_rpc :update_measurement_protocol_secret, request, options: options do |response, operation|
|
|
4007
|
+
yield response, operation if block_given?
|
|
4008
|
+
return response
|
|
4009
|
+
end
|
|
4010
|
+
rescue ::GRPC::BadStatus => e
|
|
4011
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4012
|
+
end
|
|
4013
|
+
|
|
4014
|
+
##
|
|
4015
|
+
# Searches through all changes to an account or its children given the
|
|
4016
|
+
# specified set of filters.
|
|
4017
|
+
#
|
|
4018
|
+
# @overload search_change_history_events(request, options = nil)
|
|
4019
|
+
# Pass arguments to `search_change_history_events` via a request object, either of type
|
|
4020
|
+
# {::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest} or an equivalent Hash.
|
|
4021
|
+
#
|
|
4022
|
+
# @param request [::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Hash]
|
|
4023
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4024
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4025
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4026
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4027
|
+
#
|
|
4028
|
+
# @overload search_change_history_events(account: nil, property: nil, resource_type: nil, action: nil, actor_email: nil, earliest_change_time: nil, latest_change_time: nil, page_size: nil, page_token: nil)
|
|
4029
|
+
# Pass arguments to `search_change_history_events` via keyword arguments. Note that at
|
|
4030
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4031
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4032
|
+
#
|
|
4033
|
+
# @param account [::String]
|
|
4034
|
+
# Required. The account resource for which to return change history resources.
|
|
4035
|
+
# @param property [::String]
|
|
4036
|
+
# Optional. Resource name for a child property. If set, only return changes
|
|
4037
|
+
# made to this property or its child resources.
|
|
4038
|
+
# @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
|
4039
|
+
# Optional. If set, only return changes if they are for a resource that matches at
|
|
4040
|
+
# least one of these types.
|
|
4041
|
+
# @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
|
|
4042
|
+
# Optional. If set, only return changes that match one or more of these types of
|
|
4043
|
+
# actions.
|
|
4044
|
+
# @param actor_email [::Array<::String>]
|
|
4045
|
+
# Optional. If set, only return changes if they are made by a user in this list.
|
|
4046
|
+
# @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
4047
|
+
# Optional. If set, only return changes made after this time (inclusive).
|
|
4048
|
+
# @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
4049
|
+
# Optional. If set, only return changes made before this time (inclusive).
|
|
4050
|
+
# @param page_size [::Integer]
|
|
4051
|
+
# Optional. The maximum number of ChangeHistoryEvent items to return.
|
|
4052
|
+
# The service may return fewer than this value, even if there are additional
|
|
4053
|
+
# pages. If unspecified, at most 50 items will be returned.
|
|
4054
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
|
4055
|
+
# @param page_token [::String]
|
|
4056
|
+
# Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
|
|
4057
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
|
4058
|
+
# parameters provided to `SearchChangeHistoryEvents` must match the call that
|
|
4059
|
+
# provided the page token.
|
|
4060
|
+
#
|
|
4061
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4062
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
|
|
4063
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4064
|
+
#
|
|
4065
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
|
|
4066
|
+
#
|
|
4067
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4068
|
+
#
|
|
4069
|
+
def search_change_history_events request, options = nil
|
|
4070
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4071
|
+
|
|
4072
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest
|
|
4073
|
+
|
|
4074
|
+
# Converts hash and nil to an options object
|
|
4075
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4076
|
+
|
|
4077
|
+
# Customize the options with defaults
|
|
4078
|
+
metadata = @config.rpcs.search_change_history_events.metadata.to_h
|
|
4079
|
+
|
|
4080
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4081
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4082
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4083
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4084
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4085
|
+
|
|
4086
|
+
header_params = {
|
|
4087
|
+
"account" => request.account
|
|
4088
|
+
}
|
|
4089
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4090
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4091
|
+
|
|
4092
|
+
options.apply_defaults timeout: @config.rpcs.search_change_history_events.timeout,
|
|
4093
|
+
metadata: metadata,
|
|
4094
|
+
retry_policy: @config.rpcs.search_change_history_events.retry_policy
|
|
4095
|
+
|
|
4096
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4097
|
+
metadata: @config.metadata,
|
|
4098
|
+
retry_policy: @config.retry_policy
|
|
4099
|
+
|
|
4100
|
+
@analytics_admin_service_stub.call_rpc :search_change_history_events, request, options: options do |response, operation|
|
|
4101
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :search_change_history_events, request, response, operation, options
|
|
4102
|
+
yield response, operation if block_given?
|
|
4103
|
+
return response
|
|
4104
|
+
end
|
|
4105
|
+
rescue ::GRPC::BadStatus => e
|
|
4106
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4107
|
+
end
|
|
4108
|
+
|
|
4109
|
+
##
|
|
4110
|
+
# Lookup for Google Signals settings for a property.
|
|
4111
|
+
#
|
|
4112
|
+
# @overload get_google_signals_settings(request, options = nil)
|
|
4113
|
+
# Pass arguments to `get_google_signals_settings` via a request object, either of type
|
|
4114
|
+
# {::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest} or an equivalent Hash.
|
|
4115
|
+
#
|
|
4116
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest, ::Hash]
|
|
4117
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4118
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4119
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4120
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4121
|
+
#
|
|
4122
|
+
# @overload get_google_signals_settings(name: nil)
|
|
4123
|
+
# Pass arguments to `get_google_signals_settings` via keyword arguments. Note that at
|
|
4124
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4125
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4126
|
+
#
|
|
4127
|
+
# @param name [::String]
|
|
4128
|
+
# Required. The name of the google signals settings to retrieve.
|
|
4129
|
+
# Format: properties/\\{property}/googleSignalsSettings
|
|
4130
|
+
#
|
|
4131
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4132
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4133
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4134
|
+
#
|
|
4135
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4136
|
+
#
|
|
4137
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4138
|
+
#
|
|
4139
|
+
def get_google_signals_settings request, options = nil
|
|
4140
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4141
|
+
|
|
4142
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest
|
|
4143
|
+
|
|
4144
|
+
# Converts hash and nil to an options object
|
|
4145
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4146
|
+
|
|
4147
|
+
# Customize the options with defaults
|
|
4148
|
+
metadata = @config.rpcs.get_google_signals_settings.metadata.to_h
|
|
4149
|
+
|
|
4150
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4151
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4152
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4153
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4154
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4155
|
+
|
|
4156
|
+
header_params = {
|
|
4157
|
+
"name" => request.name
|
|
4158
|
+
}
|
|
4159
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4160
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4161
|
+
|
|
4162
|
+
options.apply_defaults timeout: @config.rpcs.get_google_signals_settings.timeout,
|
|
4163
|
+
metadata: metadata,
|
|
4164
|
+
retry_policy: @config.rpcs.get_google_signals_settings.retry_policy
|
|
4165
|
+
|
|
4166
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4167
|
+
metadata: @config.metadata,
|
|
4168
|
+
retry_policy: @config.retry_policy
|
|
4169
|
+
|
|
4170
|
+
@analytics_admin_service_stub.call_rpc :get_google_signals_settings, request, options: options do |response, operation|
|
|
4171
|
+
yield response, operation if block_given?
|
|
4172
|
+
return response
|
|
4173
|
+
end
|
|
4174
|
+
rescue ::GRPC::BadStatus => e
|
|
4175
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4176
|
+
end
|
|
4177
|
+
|
|
4178
|
+
##
|
|
4179
|
+
# Updates Google Signals settings for a property.
|
|
4180
|
+
#
|
|
4181
|
+
# @overload update_google_signals_settings(request, options = nil)
|
|
4182
|
+
# Pass arguments to `update_google_signals_settings` via a request object, either of type
|
|
4183
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest} or an equivalent Hash.
|
|
4184
|
+
#
|
|
4185
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest, ::Hash]
|
|
4186
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4187
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4188
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4189
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4190
|
+
#
|
|
4191
|
+
# @overload update_google_signals_settings(google_signals_settings: nil, update_mask: nil)
|
|
4192
|
+
# Pass arguments to `update_google_signals_settings` via keyword arguments. Note that at
|
|
4193
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4194
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4195
|
+
#
|
|
4196
|
+
# @param google_signals_settings [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings, ::Hash]
|
|
4197
|
+
# Required. The settings to update.
|
|
4198
|
+
# The `name` field is used to identify the settings to be updated.
|
|
4199
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
4200
|
+
# Required. The list of fields to be updated. Field names must be in snake case
|
|
4201
|
+
# (e.g., "field_to_update"). Omitted fields will not be updated. To replace
|
|
4202
|
+
# the entire entity, use one path with the string "*" to match all fields.
|
|
4203
|
+
#
|
|
4204
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4205
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4206
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4207
|
+
#
|
|
4208
|
+
# @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
|
4209
|
+
#
|
|
4210
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4211
|
+
#
|
|
4212
|
+
def update_google_signals_settings request, options = nil
|
|
4213
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4214
|
+
|
|
4215
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest
|
|
4216
|
+
|
|
4217
|
+
# Converts hash and nil to an options object
|
|
4218
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4219
|
+
|
|
4220
|
+
# Customize the options with defaults
|
|
4221
|
+
metadata = @config.rpcs.update_google_signals_settings.metadata.to_h
|
|
4222
|
+
|
|
4223
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4224
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4225
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4226
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4227
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4228
|
+
|
|
4229
|
+
header_params = {
|
|
4230
|
+
"google_signals_settings.name" => request.google_signals_settings.name
|
|
4231
|
+
}
|
|
4232
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4233
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4234
|
+
|
|
4235
|
+
options.apply_defaults timeout: @config.rpcs.update_google_signals_settings.timeout,
|
|
4236
|
+
metadata: metadata,
|
|
4237
|
+
retry_policy: @config.rpcs.update_google_signals_settings.retry_policy
|
|
4238
|
+
|
|
4239
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4240
|
+
metadata: @config.metadata,
|
|
4241
|
+
retry_policy: @config.retry_policy
|
|
4242
|
+
|
|
4243
|
+
@analytics_admin_service_stub.call_rpc :update_google_signals_settings, request, options: options do |response, operation|
|
|
4244
|
+
yield response, operation if block_given?
|
|
4245
|
+
return response
|
|
4246
|
+
end
|
|
4247
|
+
rescue ::GRPC::BadStatus => e
|
|
4248
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4249
|
+
end
|
|
4250
|
+
|
|
4251
|
+
##
|
|
4252
|
+
# Creates a conversion event with the specified attributes.
|
|
4253
|
+
#
|
|
4254
|
+
# @overload create_conversion_event(request, options = nil)
|
|
4255
|
+
# Pass arguments to `create_conversion_event` via a request object, either of type
|
|
4256
|
+
# {::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest} or an equivalent Hash.
|
|
4257
|
+
#
|
|
4258
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest, ::Hash]
|
|
4259
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4260
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4261
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4262
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4263
|
+
#
|
|
4264
|
+
# @overload create_conversion_event(conversion_event: nil, parent: nil)
|
|
4265
|
+
# Pass arguments to `create_conversion_event` via keyword arguments. Note that at
|
|
4266
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4267
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4268
|
+
#
|
|
4269
|
+
# @param conversion_event [::Google::Analytics::Admin::V1alpha::ConversionEvent, ::Hash]
|
|
4270
|
+
# Required. The conversion event to create.
|
|
4271
|
+
# @param parent [::String]
|
|
4272
|
+
# Required. The resource name of the parent property where this conversion event will
|
|
4273
|
+
# be created. Format: properties/123
|
|
4274
|
+
#
|
|
4275
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4276
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4277
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4278
|
+
#
|
|
4279
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4280
|
+
#
|
|
4281
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4282
|
+
#
|
|
4283
|
+
def create_conversion_event request, options = nil
|
|
4284
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4285
|
+
|
|
4286
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest
|
|
4287
|
+
|
|
4288
|
+
# Converts hash and nil to an options object
|
|
4289
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4290
|
+
|
|
4291
|
+
# Customize the options with defaults
|
|
4292
|
+
metadata = @config.rpcs.create_conversion_event.metadata.to_h
|
|
4293
|
+
|
|
4294
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4295
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4296
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4297
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4298
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4299
|
+
|
|
4300
|
+
header_params = {
|
|
4301
|
+
"parent" => request.parent
|
|
4302
|
+
}
|
|
4303
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4304
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4305
|
+
|
|
4306
|
+
options.apply_defaults timeout: @config.rpcs.create_conversion_event.timeout,
|
|
4307
|
+
metadata: metadata,
|
|
4308
|
+
retry_policy: @config.rpcs.create_conversion_event.retry_policy
|
|
4309
|
+
|
|
4310
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4311
|
+
metadata: @config.metadata,
|
|
4312
|
+
retry_policy: @config.retry_policy
|
|
4313
|
+
|
|
4314
|
+
@analytics_admin_service_stub.call_rpc :create_conversion_event, request, options: options do |response, operation|
|
|
4315
|
+
yield response, operation if block_given?
|
|
4316
|
+
return response
|
|
4317
|
+
end
|
|
4318
|
+
rescue ::GRPC::BadStatus => e
|
|
4319
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4320
|
+
end
|
|
4321
|
+
|
|
4322
|
+
##
|
|
4323
|
+
# Retrieve a single conversion event.
|
|
4324
|
+
#
|
|
4325
|
+
# @overload get_conversion_event(request, options = nil)
|
|
4326
|
+
# Pass arguments to `get_conversion_event` via a request object, either of type
|
|
4327
|
+
# {::Google::Analytics::Admin::V1alpha::GetConversionEventRequest} or an equivalent Hash.
|
|
4328
|
+
#
|
|
4329
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetConversionEventRequest, ::Hash]
|
|
4330
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4331
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4332
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4333
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4334
|
+
#
|
|
4335
|
+
# @overload get_conversion_event(name: nil)
|
|
4336
|
+
# Pass arguments to `get_conversion_event` via keyword arguments. Note that at
|
|
4337
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4338
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4339
|
+
#
|
|
4340
|
+
# @param name [::String]
|
|
4341
|
+
# Required. The resource name of the conversion event to retrieve.
|
|
4342
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
|
4343
|
+
# Example: "properties/123/conversionEvents/456"
|
|
4344
|
+
#
|
|
4345
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4346
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4347
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4348
|
+
#
|
|
4349
|
+
# @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
|
4350
|
+
#
|
|
4351
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4352
|
+
#
|
|
4353
|
+
def get_conversion_event request, options = nil
|
|
4354
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4355
|
+
|
|
4356
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetConversionEventRequest
|
|
4357
|
+
|
|
4358
|
+
# Converts hash and nil to an options object
|
|
4359
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4360
|
+
|
|
4361
|
+
# Customize the options with defaults
|
|
4362
|
+
metadata = @config.rpcs.get_conversion_event.metadata.to_h
|
|
4363
|
+
|
|
4364
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4365
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4366
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4367
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4368
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4369
|
+
|
|
4370
|
+
header_params = {
|
|
4371
|
+
"name" => request.name
|
|
4372
|
+
}
|
|
4373
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4374
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4375
|
+
|
|
4376
|
+
options.apply_defaults timeout: @config.rpcs.get_conversion_event.timeout,
|
|
4377
|
+
metadata: metadata,
|
|
4378
|
+
retry_policy: @config.rpcs.get_conversion_event.retry_policy
|
|
4379
|
+
|
|
4380
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4381
|
+
metadata: @config.metadata,
|
|
4382
|
+
retry_policy: @config.retry_policy
|
|
4383
|
+
|
|
4384
|
+
@analytics_admin_service_stub.call_rpc :get_conversion_event, request, options: options do |response, operation|
|
|
4385
|
+
yield response, operation if block_given?
|
|
4386
|
+
return response
|
|
4387
|
+
end
|
|
4388
|
+
rescue ::GRPC::BadStatus => e
|
|
4389
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4390
|
+
end
|
|
4391
|
+
|
|
4392
|
+
##
|
|
4393
|
+
# Deletes a conversion event in a property.
|
|
4394
|
+
#
|
|
4395
|
+
# @overload delete_conversion_event(request, options = nil)
|
|
4396
|
+
# Pass arguments to `delete_conversion_event` via a request object, either of type
|
|
4397
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest} or an equivalent Hash.
|
|
4398
|
+
#
|
|
4399
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest, ::Hash]
|
|
4400
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4401
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4402
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4403
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4404
|
+
#
|
|
4405
|
+
# @overload delete_conversion_event(name: nil)
|
|
4406
|
+
# Pass arguments to `delete_conversion_event` via keyword arguments. Note that at
|
|
4407
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4408
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4409
|
+
#
|
|
4410
|
+
# @param name [::String]
|
|
4411
|
+
# Required. The resource name of the conversion event to delete.
|
|
4412
|
+
# Format: properties/\\{property}/conversionEvents/\\{conversion_event}
|
|
4413
|
+
# Example: "properties/123/conversionEvents/456"
|
|
4414
|
+
#
|
|
4415
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4416
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
4417
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4418
|
+
#
|
|
4419
|
+
# @return [::Google::Protobuf::Empty]
|
|
4420
|
+
#
|
|
4421
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4422
|
+
#
|
|
4423
|
+
def delete_conversion_event request, options = nil
|
|
4424
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4425
|
+
|
|
4426
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest
|
|
4427
|
+
|
|
4428
|
+
# Converts hash and nil to an options object
|
|
4429
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4430
|
+
|
|
4431
|
+
# Customize the options with defaults
|
|
4432
|
+
metadata = @config.rpcs.delete_conversion_event.metadata.to_h
|
|
4433
|
+
|
|
4434
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4435
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4436
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4437
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4438
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4439
|
+
|
|
4440
|
+
header_params = {
|
|
4441
|
+
"name" => request.name
|
|
4442
|
+
}
|
|
4443
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4444
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4445
|
+
|
|
4446
|
+
options.apply_defaults timeout: @config.rpcs.delete_conversion_event.timeout,
|
|
4447
|
+
metadata: metadata,
|
|
4448
|
+
retry_policy: @config.rpcs.delete_conversion_event.retry_policy
|
|
4449
|
+
|
|
4450
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4451
|
+
metadata: @config.metadata,
|
|
4452
|
+
retry_policy: @config.retry_policy
|
|
4453
|
+
|
|
4454
|
+
@analytics_admin_service_stub.call_rpc :delete_conversion_event, request, options: options do |response, operation|
|
|
4455
|
+
yield response, operation if block_given?
|
|
4456
|
+
return response
|
|
4457
|
+
end
|
|
4458
|
+
rescue ::GRPC::BadStatus => e
|
|
4459
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4460
|
+
end
|
|
4461
|
+
|
|
4462
|
+
##
|
|
4463
|
+
# Returns a list of conversion events in the specified parent property.
|
|
4464
|
+
#
|
|
4465
|
+
# Returns an empty list if no conversion events are found.
|
|
4466
|
+
#
|
|
4467
|
+
# @overload list_conversion_events(request, options = nil)
|
|
4468
|
+
# Pass arguments to `list_conversion_events` via a request object, either of type
|
|
4469
|
+
# {::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest} or an equivalent Hash.
|
|
4470
|
+
#
|
|
4471
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest, ::Hash]
|
|
4472
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4473
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4474
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4475
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4476
|
+
#
|
|
4477
|
+
# @overload list_conversion_events(parent: nil, page_size: nil, page_token: nil)
|
|
4478
|
+
# Pass arguments to `list_conversion_events` via keyword arguments. Note that at
|
|
4479
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4480
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4481
|
+
#
|
|
4482
|
+
# @param parent [::String]
|
|
4483
|
+
# Required. The resource name of the parent property.
|
|
4484
|
+
# Example: 'properties/123'
|
|
4485
|
+
# @param page_size [::Integer]
|
|
4486
|
+
# The maximum number of resources to return.
|
|
4487
|
+
# If unspecified, at most 50 resources will be returned.
|
|
4488
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
|
4489
|
+
# @param page_token [::String]
|
|
4490
|
+
# A page token, received from a previous `ListConversionEvents` call.
|
|
4491
|
+
# Provide this to retrieve the subsequent page.
|
|
4492
|
+
# When paginating, all other parameters provided to `ListConversionEvents`
|
|
4493
|
+
# must match the call that provided the page token.
|
|
4494
|
+
#
|
|
4495
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4496
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
|
|
4497
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4498
|
+
#
|
|
4499
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
|
|
4500
|
+
#
|
|
4501
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4502
|
+
#
|
|
4503
|
+
def list_conversion_events request, options = nil
|
|
4504
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4505
|
+
|
|
4506
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest
|
|
4507
|
+
|
|
4508
|
+
# Converts hash and nil to an options object
|
|
4509
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4510
|
+
|
|
4511
|
+
# Customize the options with defaults
|
|
4512
|
+
metadata = @config.rpcs.list_conversion_events.metadata.to_h
|
|
4513
|
+
|
|
4514
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4515
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4516
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4517
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4518
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4519
|
+
|
|
4520
|
+
header_params = {
|
|
4521
|
+
"parent" => request.parent
|
|
4522
|
+
}
|
|
4523
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4524
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4525
|
+
|
|
4526
|
+
options.apply_defaults timeout: @config.rpcs.list_conversion_events.timeout,
|
|
4527
|
+
metadata: metadata,
|
|
4528
|
+
retry_policy: @config.rpcs.list_conversion_events.retry_policy
|
|
4529
|
+
|
|
4530
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4531
|
+
metadata: @config.metadata,
|
|
4532
|
+
retry_policy: @config.retry_policy
|
|
4533
|
+
|
|
4534
|
+
@analytics_admin_service_stub.call_rpc :list_conversion_events, request, options: options do |response, operation|
|
|
4535
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_conversion_events, request, response, operation, options
|
|
4536
|
+
yield response, operation if block_given?
|
|
4537
|
+
return response
|
|
4538
|
+
end
|
|
4539
|
+
rescue ::GRPC::BadStatus => e
|
|
4540
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4541
|
+
end
|
|
4542
|
+
|
|
4543
|
+
##
|
|
4544
|
+
# Creates a CustomDimension.
|
|
4545
|
+
#
|
|
4546
|
+
# @overload create_custom_dimension(request, options = nil)
|
|
4547
|
+
# Pass arguments to `create_custom_dimension` via a request object, either of type
|
|
4548
|
+
# {::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest} or an equivalent Hash.
|
|
4549
|
+
#
|
|
4550
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest, ::Hash]
|
|
4551
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4552
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4553
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4554
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4555
|
+
#
|
|
4556
|
+
# @overload create_custom_dimension(parent: nil, custom_dimension: nil)
|
|
4557
|
+
# Pass arguments to `create_custom_dimension` via keyword arguments. Note that at
|
|
4558
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4559
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4560
|
+
#
|
|
4561
|
+
# @param parent [::String]
|
|
4562
|
+
# Required. Example format: properties/1234
|
|
4563
|
+
# @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
|
|
4564
|
+
# Required. The CustomDimension to create.
|
|
4565
|
+
#
|
|
4566
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4567
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4568
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4569
|
+
#
|
|
4570
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4571
|
+
#
|
|
4572
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4573
|
+
#
|
|
4574
|
+
def create_custom_dimension request, options = nil
|
|
4575
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4576
|
+
|
|
4577
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest
|
|
4578
|
+
|
|
4579
|
+
# Converts hash and nil to an options object
|
|
4580
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4581
|
+
|
|
4582
|
+
# Customize the options with defaults
|
|
4583
|
+
metadata = @config.rpcs.create_custom_dimension.metadata.to_h
|
|
4584
|
+
|
|
4585
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4586
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4587
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4588
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4589
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4590
|
+
|
|
4591
|
+
header_params = {
|
|
4592
|
+
"parent" => request.parent
|
|
4593
|
+
}
|
|
4594
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4595
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4596
|
+
|
|
4597
|
+
options.apply_defaults timeout: @config.rpcs.create_custom_dimension.timeout,
|
|
4598
|
+
metadata: metadata,
|
|
4599
|
+
retry_policy: @config.rpcs.create_custom_dimension.retry_policy
|
|
4600
|
+
|
|
4601
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4602
|
+
metadata: @config.metadata,
|
|
4603
|
+
retry_policy: @config.retry_policy
|
|
4604
|
+
|
|
4605
|
+
@analytics_admin_service_stub.call_rpc :create_custom_dimension, request, options: options do |response, operation|
|
|
4606
|
+
yield response, operation if block_given?
|
|
4607
|
+
return response
|
|
4608
|
+
end
|
|
4609
|
+
rescue ::GRPC::BadStatus => e
|
|
4610
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4611
|
+
end
|
|
4612
|
+
|
|
4613
|
+
##
|
|
4614
|
+
# Updates a CustomDimension on a property.
|
|
4615
|
+
#
|
|
4616
|
+
# @overload update_custom_dimension(request, options = nil)
|
|
4617
|
+
# Pass arguments to `update_custom_dimension` via a request object, either of type
|
|
4618
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest} or an equivalent Hash.
|
|
4619
|
+
#
|
|
4620
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest, ::Hash]
|
|
4621
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4622
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4623
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4624
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4625
|
+
#
|
|
4626
|
+
# @overload update_custom_dimension(custom_dimension: nil, update_mask: nil)
|
|
4627
|
+
# Pass arguments to `update_custom_dimension` via keyword arguments. Note that at
|
|
4628
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4629
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4630
|
+
#
|
|
4631
|
+
# @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
|
|
4632
|
+
# The CustomDimension to update
|
|
4633
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
4634
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
|
4635
|
+
# To replace the entire entity, use one path with the string "*" to match
|
|
4636
|
+
# all fields.
|
|
4637
|
+
#
|
|
4638
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4639
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4640
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4641
|
+
#
|
|
4642
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4643
|
+
#
|
|
4644
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4645
|
+
#
|
|
4646
|
+
def update_custom_dimension request, options = nil
|
|
4647
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4648
|
+
|
|
4649
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest
|
|
4650
|
+
|
|
4651
|
+
# Converts hash and nil to an options object
|
|
4652
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4653
|
+
|
|
4654
|
+
# Customize the options with defaults
|
|
4655
|
+
metadata = @config.rpcs.update_custom_dimension.metadata.to_h
|
|
4656
|
+
|
|
4657
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4658
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4659
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4660
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4661
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4662
|
+
|
|
4663
|
+
header_params = {
|
|
4664
|
+
"custom_dimension.name" => request.custom_dimension.name
|
|
4665
|
+
}
|
|
4666
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4667
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4668
|
+
|
|
4669
|
+
options.apply_defaults timeout: @config.rpcs.update_custom_dimension.timeout,
|
|
4670
|
+
metadata: metadata,
|
|
4671
|
+
retry_policy: @config.rpcs.update_custom_dimension.retry_policy
|
|
4672
|
+
|
|
4673
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4674
|
+
metadata: @config.metadata,
|
|
4675
|
+
retry_policy: @config.retry_policy
|
|
4676
|
+
|
|
4677
|
+
@analytics_admin_service_stub.call_rpc :update_custom_dimension, request, options: options do |response, operation|
|
|
4678
|
+
yield response, operation if block_given?
|
|
4679
|
+
return response
|
|
4680
|
+
end
|
|
4681
|
+
rescue ::GRPC::BadStatus => e
|
|
4682
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4683
|
+
end
|
|
4684
|
+
|
|
4685
|
+
##
|
|
4686
|
+
# Lists CustomDimensions on a property.
|
|
4687
|
+
#
|
|
4688
|
+
# @overload list_custom_dimensions(request, options = nil)
|
|
4689
|
+
# Pass arguments to `list_custom_dimensions` via a request object, either of type
|
|
4690
|
+
# {::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest} or an equivalent Hash.
|
|
4691
|
+
#
|
|
4692
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest, ::Hash]
|
|
4693
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4694
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4695
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4696
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4697
|
+
#
|
|
4698
|
+
# @overload list_custom_dimensions(parent: nil, page_size: nil, page_token: nil)
|
|
4699
|
+
# Pass arguments to `list_custom_dimensions` via keyword arguments. Note that at
|
|
4700
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4701
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4702
|
+
#
|
|
4703
|
+
# @param parent [::String]
|
|
4704
|
+
# Required. Example format: properties/1234
|
|
4705
|
+
# @param page_size [::Integer]
|
|
4706
|
+
# The maximum number of resources to return.
|
|
4707
|
+
# If unspecified, at most 50 resources will be returned.
|
|
4708
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
|
4709
|
+
# @param page_token [::String]
|
|
4710
|
+
# A page token, received from a previous `ListCustomDimensions` call.
|
|
4711
|
+
# Provide this to retrieve the subsequent page.
|
|
4712
|
+
#
|
|
4713
|
+
# When paginating, all other parameters provided to `ListCustomDimensions`
|
|
4714
|
+
# must match the call that provided the page token.
|
|
4715
|
+
#
|
|
4716
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4717
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>]
|
|
4718
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4719
|
+
#
|
|
4720
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>]
|
|
4721
|
+
#
|
|
4722
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4723
|
+
#
|
|
4724
|
+
def list_custom_dimensions request, options = nil
|
|
4725
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4726
|
+
|
|
4727
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest
|
|
4728
|
+
|
|
4729
|
+
# Converts hash and nil to an options object
|
|
4730
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4731
|
+
|
|
4732
|
+
# Customize the options with defaults
|
|
4733
|
+
metadata = @config.rpcs.list_custom_dimensions.metadata.to_h
|
|
4734
|
+
|
|
4735
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4736
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4737
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4738
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4739
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4740
|
+
|
|
4741
|
+
header_params = {
|
|
4742
|
+
"parent" => request.parent
|
|
4743
|
+
}
|
|
4744
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4745
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4746
|
+
|
|
4747
|
+
options.apply_defaults timeout: @config.rpcs.list_custom_dimensions.timeout,
|
|
4748
|
+
metadata: metadata,
|
|
4749
|
+
retry_policy: @config.rpcs.list_custom_dimensions.retry_policy
|
|
4750
|
+
|
|
4751
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4752
|
+
metadata: @config.metadata,
|
|
4753
|
+
retry_policy: @config.retry_policy
|
|
4754
|
+
|
|
4755
|
+
@analytics_admin_service_stub.call_rpc :list_custom_dimensions, request, options: options do |response, operation|
|
|
4756
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_dimensions, request, response, operation, options
|
|
4757
|
+
yield response, operation if block_given?
|
|
4758
|
+
return response
|
|
4759
|
+
end
|
|
4760
|
+
rescue ::GRPC::BadStatus => e
|
|
4761
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4762
|
+
end
|
|
4763
|
+
|
|
4764
|
+
##
|
|
4765
|
+
# Archives a CustomDimension on a property.
|
|
4766
|
+
#
|
|
4767
|
+
# @overload archive_custom_dimension(request, options = nil)
|
|
4768
|
+
# Pass arguments to `archive_custom_dimension` via a request object, either of type
|
|
4769
|
+
# {::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest} or an equivalent Hash.
|
|
4770
|
+
#
|
|
4771
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest, ::Hash]
|
|
4772
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4773
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4774
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4775
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4776
|
+
#
|
|
4777
|
+
# @overload archive_custom_dimension(name: nil)
|
|
4778
|
+
# Pass arguments to `archive_custom_dimension` via keyword arguments. Note that at
|
|
4779
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4780
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4781
|
+
#
|
|
4782
|
+
# @param name [::String]
|
|
4783
|
+
# Required. The name of the CustomDimension to archive.
|
|
4784
|
+
# Example format: properties/1234/customDimensions/5678
|
|
4785
|
+
#
|
|
4786
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4787
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
4788
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4789
|
+
#
|
|
4790
|
+
# @return [::Google::Protobuf::Empty]
|
|
4791
|
+
#
|
|
4792
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4793
|
+
#
|
|
4794
|
+
def archive_custom_dimension request, options = nil
|
|
4795
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4796
|
+
|
|
4797
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest
|
|
4798
|
+
|
|
4799
|
+
# Converts hash and nil to an options object
|
|
4800
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4801
|
+
|
|
4802
|
+
# Customize the options with defaults
|
|
4803
|
+
metadata = @config.rpcs.archive_custom_dimension.metadata.to_h
|
|
4804
|
+
|
|
4805
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4806
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4807
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4808
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4809
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4810
|
+
|
|
4811
|
+
header_params = {
|
|
4812
|
+
"name" => request.name
|
|
4813
|
+
}
|
|
4814
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4815
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4816
|
+
|
|
4817
|
+
options.apply_defaults timeout: @config.rpcs.archive_custom_dimension.timeout,
|
|
4818
|
+
metadata: metadata,
|
|
4819
|
+
retry_policy: @config.rpcs.archive_custom_dimension.retry_policy
|
|
4820
|
+
|
|
4821
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4822
|
+
metadata: @config.metadata,
|
|
4823
|
+
retry_policy: @config.retry_policy
|
|
4824
|
+
|
|
4825
|
+
@analytics_admin_service_stub.call_rpc :archive_custom_dimension, request, options: options do |response, operation|
|
|
4826
|
+
yield response, operation if block_given?
|
|
4827
|
+
return response
|
|
4828
|
+
end
|
|
4829
|
+
rescue ::GRPC::BadStatus => e
|
|
4830
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4831
|
+
end
|
|
4832
|
+
|
|
4833
|
+
##
|
|
4834
|
+
# Lookup for a single CustomDimension.
|
|
4835
|
+
#
|
|
4836
|
+
# @overload get_custom_dimension(request, options = nil)
|
|
4837
|
+
# Pass arguments to `get_custom_dimension` via a request object, either of type
|
|
4838
|
+
# {::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest} or an equivalent Hash.
|
|
4839
|
+
#
|
|
4840
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest, ::Hash]
|
|
4841
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4842
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4843
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4844
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4845
|
+
#
|
|
4846
|
+
# @overload get_custom_dimension(name: nil)
|
|
4847
|
+
# Pass arguments to `get_custom_dimension` via keyword arguments. Note that at
|
|
4848
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4849
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4850
|
+
#
|
|
4851
|
+
# @param name [::String]
|
|
4852
|
+
# Required. The name of the CustomDimension to get.
|
|
4853
|
+
# Example format: properties/1234/customDimensions/5678
|
|
4854
|
+
#
|
|
4855
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4856
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4857
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4858
|
+
#
|
|
4859
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
|
4860
|
+
#
|
|
4861
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4862
|
+
#
|
|
4863
|
+
def get_custom_dimension request, options = nil
|
|
4864
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4865
|
+
|
|
4866
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest
|
|
4867
|
+
|
|
4868
|
+
# Converts hash and nil to an options object
|
|
4869
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4870
|
+
|
|
4871
|
+
# Customize the options with defaults
|
|
4872
|
+
metadata = @config.rpcs.get_custom_dimension.metadata.to_h
|
|
4873
|
+
|
|
4874
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4875
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4876
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4877
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4878
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4879
|
+
|
|
4880
|
+
header_params = {
|
|
4881
|
+
"name" => request.name
|
|
4882
|
+
}
|
|
4883
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4884
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4885
|
+
|
|
4886
|
+
options.apply_defaults timeout: @config.rpcs.get_custom_dimension.timeout,
|
|
4887
|
+
metadata: metadata,
|
|
4888
|
+
retry_policy: @config.rpcs.get_custom_dimension.retry_policy
|
|
4889
|
+
|
|
4890
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4891
|
+
metadata: @config.metadata,
|
|
4892
|
+
retry_policy: @config.retry_policy
|
|
4893
|
+
|
|
4894
|
+
@analytics_admin_service_stub.call_rpc :get_custom_dimension, request, options: options do |response, operation|
|
|
4895
|
+
yield response, operation if block_given?
|
|
4896
|
+
return response
|
|
4897
|
+
end
|
|
4898
|
+
rescue ::GRPC::BadStatus => e
|
|
4899
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4900
|
+
end
|
|
4901
|
+
|
|
4902
|
+
##
|
|
4903
|
+
# Creates a CustomMetric.
|
|
4904
|
+
#
|
|
4905
|
+
# @overload create_custom_metric(request, options = nil)
|
|
4906
|
+
# Pass arguments to `create_custom_metric` via a request object, either of type
|
|
4907
|
+
# {::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest} or an equivalent Hash.
|
|
4908
|
+
#
|
|
4909
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest, ::Hash]
|
|
4910
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4911
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4912
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4913
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4914
|
+
#
|
|
4915
|
+
# @overload create_custom_metric(parent: nil, custom_metric: nil)
|
|
4916
|
+
# Pass arguments to `create_custom_metric` via keyword arguments. Note that at
|
|
4917
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4918
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4919
|
+
#
|
|
4920
|
+
# @param parent [::String]
|
|
4921
|
+
# Required. Example format: properties/1234
|
|
4922
|
+
# @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
|
|
4923
|
+
# Required. The CustomMetric to create.
|
|
4924
|
+
#
|
|
4925
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4926
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4927
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
4928
|
+
#
|
|
4929
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4930
|
+
#
|
|
4931
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
4932
|
+
#
|
|
4933
|
+
def create_custom_metric request, options = nil
|
|
4934
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
4935
|
+
|
|
4936
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest
|
|
4937
|
+
|
|
4938
|
+
# Converts hash and nil to an options object
|
|
4939
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
4940
|
+
|
|
4941
|
+
# Customize the options with defaults
|
|
4942
|
+
metadata = @config.rpcs.create_custom_metric.metadata.to_h
|
|
4943
|
+
|
|
4944
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
4945
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
4946
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
4947
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
4948
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
4949
|
+
|
|
4950
|
+
header_params = {
|
|
4951
|
+
"parent" => request.parent
|
|
4952
|
+
}
|
|
4953
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
4954
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
4955
|
+
|
|
4956
|
+
options.apply_defaults timeout: @config.rpcs.create_custom_metric.timeout,
|
|
4957
|
+
metadata: metadata,
|
|
4958
|
+
retry_policy: @config.rpcs.create_custom_metric.retry_policy
|
|
4959
|
+
|
|
4960
|
+
options.apply_defaults timeout: @config.timeout,
|
|
4961
|
+
metadata: @config.metadata,
|
|
4962
|
+
retry_policy: @config.retry_policy
|
|
4963
|
+
|
|
4964
|
+
@analytics_admin_service_stub.call_rpc :create_custom_metric, request, options: options do |response, operation|
|
|
4965
|
+
yield response, operation if block_given?
|
|
4966
|
+
return response
|
|
4967
|
+
end
|
|
4968
|
+
rescue ::GRPC::BadStatus => e
|
|
4969
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
4970
|
+
end
|
|
4971
|
+
|
|
4972
|
+
##
|
|
4973
|
+
# Updates a CustomMetric on a property.
|
|
4974
|
+
#
|
|
4975
|
+
# @overload update_custom_metric(request, options = nil)
|
|
4976
|
+
# Pass arguments to `update_custom_metric` via a request object, either of type
|
|
4977
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest} or an equivalent Hash.
|
|
4978
|
+
#
|
|
4979
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest, ::Hash]
|
|
4980
|
+
# A request object representing the call parameters. Required. To specify no
|
|
4981
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
4982
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
4983
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
4984
|
+
#
|
|
4985
|
+
# @overload update_custom_metric(custom_metric: nil, update_mask: nil)
|
|
4986
|
+
# Pass arguments to `update_custom_metric` via keyword arguments. Note that at
|
|
4987
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
4988
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
4989
|
+
#
|
|
4990
|
+
# @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
|
|
4991
|
+
# The CustomMetric to update
|
|
4992
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
4993
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
|
4994
|
+
# To replace the entire entity, use one path with the string "*" to match
|
|
4995
|
+
# all fields.
|
|
4996
|
+
#
|
|
4997
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
4998
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
4999
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
5000
|
+
#
|
|
5001
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
5002
|
+
#
|
|
5003
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
5004
|
+
#
|
|
5005
|
+
def update_custom_metric request, options = nil
|
|
5006
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
5007
|
+
|
|
5008
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest
|
|
5009
|
+
|
|
5010
|
+
# Converts hash and nil to an options object
|
|
5011
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
5012
|
+
|
|
5013
|
+
# Customize the options with defaults
|
|
5014
|
+
metadata = @config.rpcs.update_custom_metric.metadata.to_h
|
|
5015
|
+
|
|
5016
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
5017
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
5018
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
5019
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
5020
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
5021
|
+
|
|
5022
|
+
header_params = {
|
|
5023
|
+
"custom_metric.name" => request.custom_metric.name
|
|
5024
|
+
}
|
|
5025
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
5026
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
5027
|
+
|
|
5028
|
+
options.apply_defaults timeout: @config.rpcs.update_custom_metric.timeout,
|
|
5029
|
+
metadata: metadata,
|
|
5030
|
+
retry_policy: @config.rpcs.update_custom_metric.retry_policy
|
|
5031
|
+
|
|
5032
|
+
options.apply_defaults timeout: @config.timeout,
|
|
5033
|
+
metadata: @config.metadata,
|
|
5034
|
+
retry_policy: @config.retry_policy
|
|
5035
|
+
|
|
5036
|
+
@analytics_admin_service_stub.call_rpc :update_custom_metric, request, options: options do |response, operation|
|
|
5037
|
+
yield response, operation if block_given?
|
|
5038
|
+
return response
|
|
5039
|
+
end
|
|
5040
|
+
rescue ::GRPC::BadStatus => e
|
|
5041
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
5042
|
+
end
|
|
5043
|
+
|
|
5044
|
+
##
|
|
5045
|
+
# Lists CustomMetrics on a property.
|
|
5046
|
+
#
|
|
5047
|
+
# @overload list_custom_metrics(request, options = nil)
|
|
5048
|
+
# Pass arguments to `list_custom_metrics` via a request object, either of type
|
|
5049
|
+
# {::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest} or an equivalent Hash.
|
|
5050
|
+
#
|
|
5051
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest, ::Hash]
|
|
5052
|
+
# A request object representing the call parameters. Required. To specify no
|
|
5053
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
5054
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
5055
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
5056
|
+
#
|
|
5057
|
+
# @overload list_custom_metrics(parent: nil, page_size: nil, page_token: nil)
|
|
5058
|
+
# Pass arguments to `list_custom_metrics` via keyword arguments. Note that at
|
|
5059
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
5060
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
5061
|
+
#
|
|
5062
|
+
# @param parent [::String]
|
|
5063
|
+
# Required. Example format: properties/1234
|
|
5064
|
+
# @param page_size [::Integer]
|
|
5065
|
+
# The maximum number of resources to return.
|
|
5066
|
+
# If unspecified, at most 50 resources will be returned.
|
|
5067
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
|
5068
|
+
# @param page_token [::String]
|
|
5069
|
+
# A page token, received from a previous `ListCustomMetrics` call.
|
|
5070
|
+
# Provide this to retrieve the subsequent page.
|
|
5071
|
+
#
|
|
5072
|
+
# When paginating, all other parameters provided to `ListCustomMetrics` must
|
|
5073
|
+
# match the call that provided the page token.
|
|
5074
|
+
#
|
|
5075
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
5076
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>]
|
|
5077
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
5078
|
+
#
|
|
5079
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>]
|
|
5080
|
+
#
|
|
5081
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
5082
|
+
#
|
|
5083
|
+
def list_custom_metrics request, options = nil
|
|
5084
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
5085
|
+
|
|
5086
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest
|
|
5087
|
+
|
|
5088
|
+
# Converts hash and nil to an options object
|
|
5089
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
5090
|
+
|
|
5091
|
+
# Customize the options with defaults
|
|
5092
|
+
metadata = @config.rpcs.list_custom_metrics.metadata.to_h
|
|
5093
|
+
|
|
5094
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
5095
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
5096
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
5097
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
5098
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
5099
|
+
|
|
5100
|
+
header_params = {
|
|
5101
|
+
"parent" => request.parent
|
|
5102
|
+
}
|
|
5103
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
5104
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
5105
|
+
|
|
5106
|
+
options.apply_defaults timeout: @config.rpcs.list_custom_metrics.timeout,
|
|
5107
|
+
metadata: metadata,
|
|
5108
|
+
retry_policy: @config.rpcs.list_custom_metrics.retry_policy
|
|
5109
|
+
|
|
5110
|
+
options.apply_defaults timeout: @config.timeout,
|
|
5111
|
+
metadata: @config.metadata,
|
|
5112
|
+
retry_policy: @config.retry_policy
|
|
5113
|
+
|
|
5114
|
+
@analytics_admin_service_stub.call_rpc :list_custom_metrics, request, options: options do |response, operation|
|
|
5115
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_metrics, request, response, operation, options
|
|
5116
|
+
yield response, operation if block_given?
|
|
5117
|
+
return response
|
|
5118
|
+
end
|
|
5119
|
+
rescue ::GRPC::BadStatus => e
|
|
5120
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
5121
|
+
end
|
|
5122
|
+
|
|
5123
|
+
##
|
|
5124
|
+
# Archives a CustomMetric on a property.
|
|
5125
|
+
#
|
|
5126
|
+
# @overload archive_custom_metric(request, options = nil)
|
|
5127
|
+
# Pass arguments to `archive_custom_metric` via a request object, either of type
|
|
5128
|
+
# {::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest} or an equivalent Hash.
|
|
5129
|
+
#
|
|
5130
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest, ::Hash]
|
|
5131
|
+
# A request object representing the call parameters. Required. To specify no
|
|
5132
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
5133
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
5134
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
5135
|
+
#
|
|
5136
|
+
# @overload archive_custom_metric(name: nil)
|
|
5137
|
+
# Pass arguments to `archive_custom_metric` via keyword arguments. Note that at
|
|
5138
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
5139
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
5140
|
+
#
|
|
5141
|
+
# @param name [::String]
|
|
5142
|
+
# Required. The name of the CustomMetric to archive.
|
|
5143
|
+
# Example format: properties/1234/customMetrics/5678
|
|
5144
|
+
#
|
|
5145
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
5146
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
|
5147
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
5148
|
+
#
|
|
5149
|
+
# @return [::Google::Protobuf::Empty]
|
|
5150
|
+
#
|
|
5151
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
5152
|
+
#
|
|
5153
|
+
def archive_custom_metric request, options = nil
|
|
5154
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
5155
|
+
|
|
5156
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest
|
|
5157
|
+
|
|
5158
|
+
# Converts hash and nil to an options object
|
|
5159
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
5160
|
+
|
|
5161
|
+
# Customize the options with defaults
|
|
5162
|
+
metadata = @config.rpcs.archive_custom_metric.metadata.to_h
|
|
5163
|
+
|
|
5164
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
5165
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
5166
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
5167
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
5168
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
5169
|
+
|
|
5170
|
+
header_params = {
|
|
5171
|
+
"name" => request.name
|
|
5172
|
+
}
|
|
5173
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
5174
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
5175
|
+
|
|
5176
|
+
options.apply_defaults timeout: @config.rpcs.archive_custom_metric.timeout,
|
|
5177
|
+
metadata: metadata,
|
|
5178
|
+
retry_policy: @config.rpcs.archive_custom_metric.retry_policy
|
|
5179
|
+
|
|
5180
|
+
options.apply_defaults timeout: @config.timeout,
|
|
5181
|
+
metadata: @config.metadata,
|
|
5182
|
+
retry_policy: @config.retry_policy
|
|
5183
|
+
|
|
5184
|
+
@analytics_admin_service_stub.call_rpc :archive_custom_metric, request, options: options do |response, operation|
|
|
5185
|
+
yield response, operation if block_given?
|
|
5186
|
+
return response
|
|
5187
|
+
end
|
|
5188
|
+
rescue ::GRPC::BadStatus => e
|
|
5189
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
5190
|
+
end
|
|
5191
|
+
|
|
5192
|
+
##
|
|
5193
|
+
# Lookup for a single CustomMetric.
|
|
5194
|
+
#
|
|
5195
|
+
# @overload get_custom_metric(request, options = nil)
|
|
5196
|
+
# Pass arguments to `get_custom_metric` via a request object, either of type
|
|
5197
|
+
# {::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest} or an equivalent Hash.
|
|
5198
|
+
#
|
|
5199
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest, ::Hash]
|
|
5200
|
+
# A request object representing the call parameters. Required. To specify no
|
|
5201
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
5202
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
5203
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
5204
|
+
#
|
|
5205
|
+
# @overload get_custom_metric(name: nil)
|
|
5206
|
+
# Pass arguments to `get_custom_metric` via keyword arguments. Note that at
|
|
5207
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
5208
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
5209
|
+
#
|
|
5210
|
+
# @param name [::String]
|
|
5211
|
+
# Required. The name of the CustomMetric to get.
|
|
5212
|
+
# Example format: properties/1234/customMetrics/5678
|
|
5213
|
+
#
|
|
5214
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
5215
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
5216
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
5217
|
+
#
|
|
5218
|
+
# @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
|
5219
|
+
#
|
|
5220
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
5221
|
+
#
|
|
5222
|
+
def get_custom_metric request, options = nil
|
|
5223
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
5224
|
+
|
|
5225
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest
|
|
5226
|
+
|
|
5227
|
+
# Converts hash and nil to an options object
|
|
5228
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
5229
|
+
|
|
5230
|
+
# Customize the options with defaults
|
|
5231
|
+
metadata = @config.rpcs.get_custom_metric.metadata.to_h
|
|
5232
|
+
|
|
5233
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
5234
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
5235
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
5236
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
|
5237
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
5238
|
+
|
|
5239
|
+
header_params = {
|
|
5240
|
+
"name" => request.name
|
|
5241
|
+
}
|
|
5242
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
5243
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
5244
|
+
|
|
5245
|
+
options.apply_defaults timeout: @config.rpcs.get_custom_metric.timeout,
|
|
5246
|
+
metadata: metadata,
|
|
5247
|
+
retry_policy: @config.rpcs.get_custom_metric.retry_policy
|
|
5248
|
+
|
|
5249
|
+
options.apply_defaults timeout: @config.timeout,
|
|
5250
|
+
metadata: @config.metadata,
|
|
5251
|
+
retry_policy: @config.retry_policy
|
|
5252
|
+
|
|
5253
|
+
@analytics_admin_service_stub.call_rpc :get_custom_metric, request, options: options do |response, operation|
|
|
5254
|
+
yield response, operation if block_given?
|
|
5255
|
+
return response
|
|
5256
|
+
end
|
|
5257
|
+
rescue ::GRPC::BadStatus => e
|
|
5258
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
5259
|
+
end
|
|
5260
|
+
|
|
5261
|
+
##
|
|
5262
|
+
# Configuration class for the AnalyticsAdminService API.
|
|
5263
|
+
#
|
|
5264
|
+
# This class represents the configuration for AnalyticsAdminService,
|
|
5265
|
+
# providing control over timeouts, retry behavior, logging, transport
|
|
5266
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
|
5267
|
+
# applied individually to specific RPCs. See
|
|
5268
|
+
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
|
5269
|
+
# for a list of RPCs that can be configured independently.
|
|
5270
|
+
#
|
|
5271
|
+
# Configuration can be applied globally to all clients, or to a single client
|
|
5272
|
+
# on construction.
|
|
5273
|
+
#
|
|
5274
|
+
# @example
|
|
5275
|
+
#
|
|
5276
|
+
# # Modify the global config, setting the timeout for
|
|
5277
|
+
# # get_account to 20 seconds,
|
|
5278
|
+
# # and all remaining timeouts to 10 seconds.
|
|
5279
|
+
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
|
5280
|
+
# config.timeout = 10.0
|
|
5281
|
+
# config.rpcs.get_account.timeout = 20.0
|
|
5282
|
+
# end
|
|
5283
|
+
#
|
|
5284
|
+
# # Apply the above configuration only to a new client.
|
|
5285
|
+
# client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
|
|
5286
|
+
# config.timeout = 10.0
|
|
5287
|
+
# config.rpcs.get_account.timeout = 20.0
|
|
5288
|
+
# end
|
|
5289
|
+
#
|
|
5290
|
+
# @!attribute [rw] endpoint
|
|
5291
|
+
# The hostname or hostname:port of the service endpoint.
|
|
5292
|
+
# Defaults to `"analyticsadmin.googleapis.com"`.
|
|
5293
|
+
# @return [::String]
|
|
5294
|
+
# @!attribute [rw] credentials
|
|
5295
|
+
# Credentials to send with calls. You may provide any of the following types:
|
|
5296
|
+
# * (`String`) The path to a service account key file in JSON format
|
|
5297
|
+
# * (`Hash`) A service account key as a Hash
|
|
5298
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
5299
|
+
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
|
5300
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
5301
|
+
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
|
5302
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
|
5303
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
5304
|
+
# * (`nil`) indicating no credentials
|
|
5305
|
+
# @return [::Object]
|
|
5306
|
+
# @!attribute [rw] scope
|
|
5307
|
+
# The OAuth scopes
|
|
5308
|
+
# @return [::Array<::String>]
|
|
5309
|
+
# @!attribute [rw] lib_name
|
|
5310
|
+
# The library name as recorded in instrumentation and logging
|
|
5311
|
+
# @return [::String]
|
|
5312
|
+
# @!attribute [rw] lib_version
|
|
5313
|
+
# The library version as recorded in instrumentation and logging
|
|
5314
|
+
# @return [::String]
|
|
5315
|
+
# @!attribute [rw] channel_args
|
|
5316
|
+
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
|
5317
|
+
# `GRPC::Core::Channel` object is provided as the credential.
|
|
5318
|
+
# @return [::Hash]
|
|
5319
|
+
# @!attribute [rw] interceptors
|
|
5320
|
+
# An array of interceptors that are run before calls are executed.
|
|
5321
|
+
# @return [::Array<::GRPC::ClientInterceptor>]
|
|
5322
|
+
# @!attribute [rw] timeout
|
|
5323
|
+
# The call timeout in seconds.
|
|
5324
|
+
# @return [::Numeric]
|
|
5325
|
+
# @!attribute [rw] metadata
|
|
5326
|
+
# Additional gRPC headers to be sent with the call.
|
|
5327
|
+
# @return [::Hash{::Symbol=>::String}]
|
|
5328
|
+
# @!attribute [rw] retry_policy
|
|
5329
|
+
# The retry policy. The value is a hash with the following keys:
|
|
5330
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
5331
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
5332
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
5333
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
5334
|
+
# trigger a retry.
|
|
5335
|
+
# @return [::Hash]
|
|
5336
|
+
# @!attribute [rw] quota_project
|
|
5337
|
+
# A separate project against which to charge quota.
|
|
5338
|
+
# @return [::String]
|
|
5339
|
+
#
|
|
5340
|
+
class Configuration
|
|
5341
|
+
extend ::Gapic::Config
|
|
5342
|
+
|
|
5343
|
+
config_attr :endpoint, "analyticsadmin.googleapis.com", ::String
|
|
5344
|
+
config_attr :credentials, nil do |value|
|
|
5345
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
5346
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
5347
|
+
allowed.any? { |klass| klass === value }
|
|
5348
|
+
end
|
|
5349
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
|
5350
|
+
config_attr :lib_name, nil, ::String, nil
|
|
5351
|
+
config_attr :lib_version, nil, ::String, nil
|
|
5352
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
5353
|
+
config_attr :interceptors, nil, ::Array, nil
|
|
5354
|
+
config_attr :timeout, nil, ::Numeric, nil
|
|
5355
|
+
config_attr :metadata, nil, ::Hash, nil
|
|
5356
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
5357
|
+
config_attr :quota_project, nil, ::String, nil
|
|
5358
|
+
|
|
5359
|
+
# @private
|
|
5360
|
+
def initialize parent_config = nil
|
|
5361
|
+
@parent_config = parent_config unless parent_config.nil?
|
|
3821
5362
|
|
|
3822
5363
|
yield self if block_given?
|
|
3823
5364
|
end
|
|
@@ -3998,11 +5539,6 @@ module Google
|
|
|
3998
5539
|
#
|
|
3999
5540
|
attr_reader :update_ios_app_data_stream
|
|
4000
5541
|
##
|
|
4001
|
-
# RPC-specific configuration for `create_ios_app_data_stream`
|
|
4002
|
-
# @return [::Gapic::Config::Method]
|
|
4003
|
-
#
|
|
4004
|
-
attr_reader :create_ios_app_data_stream
|
|
4005
|
-
##
|
|
4006
5542
|
# RPC-specific configuration for `list_ios_app_data_streams`
|
|
4007
5543
|
# @return [::Gapic::Config::Method]
|
|
4008
5544
|
#
|
|
@@ -4023,11 +5559,6 @@ module Google
|
|
|
4023
5559
|
#
|
|
4024
5560
|
attr_reader :update_android_app_data_stream
|
|
4025
5561
|
##
|
|
4026
|
-
# RPC-specific configuration for `create_android_app_data_stream`
|
|
4027
|
-
# @return [::Gapic::Config::Method]
|
|
4028
|
-
#
|
|
4029
|
-
attr_reader :create_android_app_data_stream
|
|
4030
|
-
##
|
|
4031
5562
|
# RPC-specific configuration for `list_android_app_data_streams`
|
|
4032
5563
|
# @return [::Gapic::Config::Method]
|
|
4033
5564
|
#
|
|
@@ -4092,6 +5623,116 @@ module Google
|
|
|
4092
5623
|
# @return [::Gapic::Config::Method]
|
|
4093
5624
|
#
|
|
4094
5625
|
attr_reader :get_data_sharing_settings
|
|
5626
|
+
##
|
|
5627
|
+
# RPC-specific configuration for `get_measurement_protocol_secret`
|
|
5628
|
+
# @return [::Gapic::Config::Method]
|
|
5629
|
+
#
|
|
5630
|
+
attr_reader :get_measurement_protocol_secret
|
|
5631
|
+
##
|
|
5632
|
+
# RPC-specific configuration for `list_measurement_protocol_secrets`
|
|
5633
|
+
# @return [::Gapic::Config::Method]
|
|
5634
|
+
#
|
|
5635
|
+
attr_reader :list_measurement_protocol_secrets
|
|
5636
|
+
##
|
|
5637
|
+
# RPC-specific configuration for `create_measurement_protocol_secret`
|
|
5638
|
+
# @return [::Gapic::Config::Method]
|
|
5639
|
+
#
|
|
5640
|
+
attr_reader :create_measurement_protocol_secret
|
|
5641
|
+
##
|
|
5642
|
+
# RPC-specific configuration for `delete_measurement_protocol_secret`
|
|
5643
|
+
# @return [::Gapic::Config::Method]
|
|
5644
|
+
#
|
|
5645
|
+
attr_reader :delete_measurement_protocol_secret
|
|
5646
|
+
##
|
|
5647
|
+
# RPC-specific configuration for `update_measurement_protocol_secret`
|
|
5648
|
+
# @return [::Gapic::Config::Method]
|
|
5649
|
+
#
|
|
5650
|
+
attr_reader :update_measurement_protocol_secret
|
|
5651
|
+
##
|
|
5652
|
+
# RPC-specific configuration for `search_change_history_events`
|
|
5653
|
+
# @return [::Gapic::Config::Method]
|
|
5654
|
+
#
|
|
5655
|
+
attr_reader :search_change_history_events
|
|
5656
|
+
##
|
|
5657
|
+
# RPC-specific configuration for `get_google_signals_settings`
|
|
5658
|
+
# @return [::Gapic::Config::Method]
|
|
5659
|
+
#
|
|
5660
|
+
attr_reader :get_google_signals_settings
|
|
5661
|
+
##
|
|
5662
|
+
# RPC-specific configuration for `update_google_signals_settings`
|
|
5663
|
+
# @return [::Gapic::Config::Method]
|
|
5664
|
+
#
|
|
5665
|
+
attr_reader :update_google_signals_settings
|
|
5666
|
+
##
|
|
5667
|
+
# RPC-specific configuration for `create_conversion_event`
|
|
5668
|
+
# @return [::Gapic::Config::Method]
|
|
5669
|
+
#
|
|
5670
|
+
attr_reader :create_conversion_event
|
|
5671
|
+
##
|
|
5672
|
+
# RPC-specific configuration for `get_conversion_event`
|
|
5673
|
+
# @return [::Gapic::Config::Method]
|
|
5674
|
+
#
|
|
5675
|
+
attr_reader :get_conversion_event
|
|
5676
|
+
##
|
|
5677
|
+
# RPC-specific configuration for `delete_conversion_event`
|
|
5678
|
+
# @return [::Gapic::Config::Method]
|
|
5679
|
+
#
|
|
5680
|
+
attr_reader :delete_conversion_event
|
|
5681
|
+
##
|
|
5682
|
+
# RPC-specific configuration for `list_conversion_events`
|
|
5683
|
+
# @return [::Gapic::Config::Method]
|
|
5684
|
+
#
|
|
5685
|
+
attr_reader :list_conversion_events
|
|
5686
|
+
##
|
|
5687
|
+
# RPC-specific configuration for `create_custom_dimension`
|
|
5688
|
+
# @return [::Gapic::Config::Method]
|
|
5689
|
+
#
|
|
5690
|
+
attr_reader :create_custom_dimension
|
|
5691
|
+
##
|
|
5692
|
+
# RPC-specific configuration for `update_custom_dimension`
|
|
5693
|
+
# @return [::Gapic::Config::Method]
|
|
5694
|
+
#
|
|
5695
|
+
attr_reader :update_custom_dimension
|
|
5696
|
+
##
|
|
5697
|
+
# RPC-specific configuration for `list_custom_dimensions`
|
|
5698
|
+
# @return [::Gapic::Config::Method]
|
|
5699
|
+
#
|
|
5700
|
+
attr_reader :list_custom_dimensions
|
|
5701
|
+
##
|
|
5702
|
+
# RPC-specific configuration for `archive_custom_dimension`
|
|
5703
|
+
# @return [::Gapic::Config::Method]
|
|
5704
|
+
#
|
|
5705
|
+
attr_reader :archive_custom_dimension
|
|
5706
|
+
##
|
|
5707
|
+
# RPC-specific configuration for `get_custom_dimension`
|
|
5708
|
+
# @return [::Gapic::Config::Method]
|
|
5709
|
+
#
|
|
5710
|
+
attr_reader :get_custom_dimension
|
|
5711
|
+
##
|
|
5712
|
+
# RPC-specific configuration for `create_custom_metric`
|
|
5713
|
+
# @return [::Gapic::Config::Method]
|
|
5714
|
+
#
|
|
5715
|
+
attr_reader :create_custom_metric
|
|
5716
|
+
##
|
|
5717
|
+
# RPC-specific configuration for `update_custom_metric`
|
|
5718
|
+
# @return [::Gapic::Config::Method]
|
|
5719
|
+
#
|
|
5720
|
+
attr_reader :update_custom_metric
|
|
5721
|
+
##
|
|
5722
|
+
# RPC-specific configuration for `list_custom_metrics`
|
|
5723
|
+
# @return [::Gapic::Config::Method]
|
|
5724
|
+
#
|
|
5725
|
+
attr_reader :list_custom_metrics
|
|
5726
|
+
##
|
|
5727
|
+
# RPC-specific configuration for `archive_custom_metric`
|
|
5728
|
+
# @return [::Gapic::Config::Method]
|
|
5729
|
+
#
|
|
5730
|
+
attr_reader :archive_custom_metric
|
|
5731
|
+
##
|
|
5732
|
+
# RPC-specific configuration for `get_custom_metric`
|
|
5733
|
+
# @return [::Gapic::Config::Method]
|
|
5734
|
+
#
|
|
5735
|
+
attr_reader :get_custom_metric
|
|
4095
5736
|
|
|
4096
5737
|
# @private
|
|
4097
5738
|
def initialize parent_rpcs = nil
|
|
@@ -4153,8 +5794,6 @@ module Google
|
|
|
4153
5794
|
@delete_ios_app_data_stream = ::Gapic::Config::Method.new delete_ios_app_data_stream_config
|
|
4154
5795
|
update_ios_app_data_stream_config = parent_rpcs.update_ios_app_data_stream if parent_rpcs.respond_to? :update_ios_app_data_stream
|
|
4155
5796
|
@update_ios_app_data_stream = ::Gapic::Config::Method.new update_ios_app_data_stream_config
|
|
4156
|
-
create_ios_app_data_stream_config = parent_rpcs.create_ios_app_data_stream if parent_rpcs.respond_to? :create_ios_app_data_stream
|
|
4157
|
-
@create_ios_app_data_stream = ::Gapic::Config::Method.new create_ios_app_data_stream_config
|
|
4158
5797
|
list_ios_app_data_streams_config = parent_rpcs.list_ios_app_data_streams if parent_rpcs.respond_to? :list_ios_app_data_streams
|
|
4159
5798
|
@list_ios_app_data_streams = ::Gapic::Config::Method.new list_ios_app_data_streams_config
|
|
4160
5799
|
get_android_app_data_stream_config = parent_rpcs.get_android_app_data_stream if parent_rpcs.respond_to? :get_android_app_data_stream
|
|
@@ -4163,8 +5802,6 @@ module Google
|
|
|
4163
5802
|
@delete_android_app_data_stream = ::Gapic::Config::Method.new delete_android_app_data_stream_config
|
|
4164
5803
|
update_android_app_data_stream_config = parent_rpcs.update_android_app_data_stream if parent_rpcs.respond_to? :update_android_app_data_stream
|
|
4165
5804
|
@update_android_app_data_stream = ::Gapic::Config::Method.new update_android_app_data_stream_config
|
|
4166
|
-
create_android_app_data_stream_config = parent_rpcs.create_android_app_data_stream if parent_rpcs.respond_to? :create_android_app_data_stream
|
|
4167
|
-
@create_android_app_data_stream = ::Gapic::Config::Method.new create_android_app_data_stream_config
|
|
4168
5805
|
list_android_app_data_streams_config = parent_rpcs.list_android_app_data_streams if parent_rpcs.respond_to? :list_android_app_data_streams
|
|
4169
5806
|
@list_android_app_data_streams = ::Gapic::Config::Method.new list_android_app_data_streams_config
|
|
4170
5807
|
get_enhanced_measurement_settings_config = parent_rpcs.get_enhanced_measurement_settings if parent_rpcs.respond_to? :get_enhanced_measurement_settings
|
|
@@ -4191,6 +5828,50 @@ module Google
|
|
|
4191
5828
|
@list_google_ads_links = ::Gapic::Config::Method.new list_google_ads_links_config
|
|
4192
5829
|
get_data_sharing_settings_config = parent_rpcs.get_data_sharing_settings if parent_rpcs.respond_to? :get_data_sharing_settings
|
|
4193
5830
|
@get_data_sharing_settings = ::Gapic::Config::Method.new get_data_sharing_settings_config
|
|
5831
|
+
get_measurement_protocol_secret_config = parent_rpcs.get_measurement_protocol_secret if parent_rpcs.respond_to? :get_measurement_protocol_secret
|
|
5832
|
+
@get_measurement_protocol_secret = ::Gapic::Config::Method.new get_measurement_protocol_secret_config
|
|
5833
|
+
list_measurement_protocol_secrets_config = parent_rpcs.list_measurement_protocol_secrets if parent_rpcs.respond_to? :list_measurement_protocol_secrets
|
|
5834
|
+
@list_measurement_protocol_secrets = ::Gapic::Config::Method.new list_measurement_protocol_secrets_config
|
|
5835
|
+
create_measurement_protocol_secret_config = parent_rpcs.create_measurement_protocol_secret if parent_rpcs.respond_to? :create_measurement_protocol_secret
|
|
5836
|
+
@create_measurement_protocol_secret = ::Gapic::Config::Method.new create_measurement_protocol_secret_config
|
|
5837
|
+
delete_measurement_protocol_secret_config = parent_rpcs.delete_measurement_protocol_secret if parent_rpcs.respond_to? :delete_measurement_protocol_secret
|
|
5838
|
+
@delete_measurement_protocol_secret = ::Gapic::Config::Method.new delete_measurement_protocol_secret_config
|
|
5839
|
+
update_measurement_protocol_secret_config = parent_rpcs.update_measurement_protocol_secret if parent_rpcs.respond_to? :update_measurement_protocol_secret
|
|
5840
|
+
@update_measurement_protocol_secret = ::Gapic::Config::Method.new update_measurement_protocol_secret_config
|
|
5841
|
+
search_change_history_events_config = parent_rpcs.search_change_history_events if parent_rpcs.respond_to? :search_change_history_events
|
|
5842
|
+
@search_change_history_events = ::Gapic::Config::Method.new search_change_history_events_config
|
|
5843
|
+
get_google_signals_settings_config = parent_rpcs.get_google_signals_settings if parent_rpcs.respond_to? :get_google_signals_settings
|
|
5844
|
+
@get_google_signals_settings = ::Gapic::Config::Method.new get_google_signals_settings_config
|
|
5845
|
+
update_google_signals_settings_config = parent_rpcs.update_google_signals_settings if parent_rpcs.respond_to? :update_google_signals_settings
|
|
5846
|
+
@update_google_signals_settings = ::Gapic::Config::Method.new update_google_signals_settings_config
|
|
5847
|
+
create_conversion_event_config = parent_rpcs.create_conversion_event if parent_rpcs.respond_to? :create_conversion_event
|
|
5848
|
+
@create_conversion_event = ::Gapic::Config::Method.new create_conversion_event_config
|
|
5849
|
+
get_conversion_event_config = parent_rpcs.get_conversion_event if parent_rpcs.respond_to? :get_conversion_event
|
|
5850
|
+
@get_conversion_event = ::Gapic::Config::Method.new get_conversion_event_config
|
|
5851
|
+
delete_conversion_event_config = parent_rpcs.delete_conversion_event if parent_rpcs.respond_to? :delete_conversion_event
|
|
5852
|
+
@delete_conversion_event = ::Gapic::Config::Method.new delete_conversion_event_config
|
|
5853
|
+
list_conversion_events_config = parent_rpcs.list_conversion_events if parent_rpcs.respond_to? :list_conversion_events
|
|
5854
|
+
@list_conversion_events = ::Gapic::Config::Method.new list_conversion_events_config
|
|
5855
|
+
create_custom_dimension_config = parent_rpcs.create_custom_dimension if parent_rpcs.respond_to? :create_custom_dimension
|
|
5856
|
+
@create_custom_dimension = ::Gapic::Config::Method.new create_custom_dimension_config
|
|
5857
|
+
update_custom_dimension_config = parent_rpcs.update_custom_dimension if parent_rpcs.respond_to? :update_custom_dimension
|
|
5858
|
+
@update_custom_dimension = ::Gapic::Config::Method.new update_custom_dimension_config
|
|
5859
|
+
list_custom_dimensions_config = parent_rpcs.list_custom_dimensions if parent_rpcs.respond_to? :list_custom_dimensions
|
|
5860
|
+
@list_custom_dimensions = ::Gapic::Config::Method.new list_custom_dimensions_config
|
|
5861
|
+
archive_custom_dimension_config = parent_rpcs.archive_custom_dimension if parent_rpcs.respond_to? :archive_custom_dimension
|
|
5862
|
+
@archive_custom_dimension = ::Gapic::Config::Method.new archive_custom_dimension_config
|
|
5863
|
+
get_custom_dimension_config = parent_rpcs.get_custom_dimension if parent_rpcs.respond_to? :get_custom_dimension
|
|
5864
|
+
@get_custom_dimension = ::Gapic::Config::Method.new get_custom_dimension_config
|
|
5865
|
+
create_custom_metric_config = parent_rpcs.create_custom_metric if parent_rpcs.respond_to? :create_custom_metric
|
|
5866
|
+
@create_custom_metric = ::Gapic::Config::Method.new create_custom_metric_config
|
|
5867
|
+
update_custom_metric_config = parent_rpcs.update_custom_metric if parent_rpcs.respond_to? :update_custom_metric
|
|
5868
|
+
@update_custom_metric = ::Gapic::Config::Method.new update_custom_metric_config
|
|
5869
|
+
list_custom_metrics_config = parent_rpcs.list_custom_metrics if parent_rpcs.respond_to? :list_custom_metrics
|
|
5870
|
+
@list_custom_metrics = ::Gapic::Config::Method.new list_custom_metrics_config
|
|
5871
|
+
archive_custom_metric_config = parent_rpcs.archive_custom_metric if parent_rpcs.respond_to? :archive_custom_metric
|
|
5872
|
+
@archive_custom_metric = ::Gapic::Config::Method.new archive_custom_metric_config
|
|
5873
|
+
get_custom_metric_config = parent_rpcs.get_custom_metric if parent_rpcs.respond_to? :get_custom_metric
|
|
5874
|
+
@get_custom_metric = ::Gapic::Config::Method.new get_custom_metric_config
|
|
4194
5875
|
|
|
4195
5876
|
yield self if block_given?
|
|
4196
5877
|
end
|