google-analytics-admin-v1alpha 0.7.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -1
  4. data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +194 -5
  5. data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +2998 -293
  6. data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +126 -0
  7. data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +82 -2
  8. data/lib/google/analytics/admin/v1alpha/resources_pb.rb +153 -9
  9. data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
  10. data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +550 -14
  11. data/proto_docs/google/analytics/admin/v1alpha/resources.rb +476 -27
  12. data/proto_docs/google/api/field_behavior.rb +7 -1
  13. metadata +13 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7a415c9a7eed5ec3ffdbbd1fe096eec5fbd3b00d8a751c4ff944d97ac929fbeb
4
- data.tar.gz: 386ff1283da96579255e9cd990e47bafa6e45f64e17c69f044e850ad93d36f66
3
+ metadata.gz: 9eaab51c64fbb783631c8b0272f1beee8a6c3abf6d202ef0326ee582291a2c60
4
+ data.tar.gz: 6f1bf163fbec193bd85a54bde552738a3159ffe95a3a5d6947a5663e939b8183
5
5
  SHA512:
6
- metadata.gz: 3a1196e17f5ba41ce0b1ed0b1fec205bf18a8d115676a36385408a99fde931d7055e4359b811439d9e4388d03c1b4dd313f4cd6cbf5cc7f75cdc5be59725571f
7
- data.tar.gz: fd942c7a9ebde18e37c61984235f782736af3ec52772dc25b4c18d86d37bcb26105044c7abe4a933b591ac54fdbb3cbc790c08d9c4b2a7bdacf708c12a062407
6
+ metadata.gz: 0acf44c29d1dc7eaef3e14212350ee09191c2f63552fd580bfad848ed63bc49edb00b013babafb993d952d0babb3002436c40f1e784a54ef24a1523bb86a01a6
7
+ data.tar.gz: 72aac863696e518b10dd2505c52af210965928fd77b3c00d6415e3f5805d41db605593b5f5ae6887841b1b4b72db5a9af53b2bad9169d07220720310ce9c2115
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
- 1. `ANALYTICS_ADMIN_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `ANALYTICS_ADMIN_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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 placing them in
86
- environment variables. Either on an individual client initialization:
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 configured globally for all clients:
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 = my_create_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
 
data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb CHANGED
@@ -192,10 +192,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
192
192
  optional :parent, :string, 1
193
193
  optional :firebase_link, :message, 2, "google.analytics.admin.v1alpha.FirebaseLink"
194
194
  end
195
- add_message "google.analytics.admin.v1alpha.UpdateFirebaseLinkRequest" do
196
- optional :firebase_link, :message, 1, "google.analytics.admin.v1alpha.FirebaseLink"
197
- optional :update_mask, :message, 2, "google.protobuf.FieldMask"
198
- end
199
195
  add_message "google.analytics.admin.v1alpha.DeleteFirebaseLinkRequest" do
200
196
  optional :name, :string, 1
201
197
  end
@@ -257,6 +253,159 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
257
253
  repeated :change_history_events, :message, 1, "google.analytics.admin.v1alpha.ChangeHistoryEvent"
258
254
  optional :next_page_token, :string, 2
259
255
  end
256
+ add_message "google.analytics.admin.v1alpha.GetMeasurementProtocolSecretRequest" do
257
+ optional :name, :string, 1
258
+ end
259
+ add_message "google.analytics.admin.v1alpha.CreateMeasurementProtocolSecretRequest" do
260
+ optional :parent, :string, 1
261
+ optional :measurement_protocol_secret, :message, 2, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
262
+ end
263
+ add_message "google.analytics.admin.v1alpha.DeleteMeasurementProtocolSecretRequest" do
264
+ optional :name, :string, 1
265
+ end
266
+ add_message "google.analytics.admin.v1alpha.UpdateMeasurementProtocolSecretRequest" do
267
+ optional :measurement_protocol_secret, :message, 1, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
268
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
269
+ end
270
+ add_message "google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsRequest" do
271
+ optional :parent, :string, 1
272
+ optional :page_size, :int32, 2
273
+ optional :page_token, :string, 3
274
+ end
275
+ add_message "google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsResponse" do
276
+ repeated :measurement_protocol_secrets, :message, 1, "google.analytics.admin.v1alpha.MeasurementProtocolSecret"
277
+ optional :next_page_token, :string, 2
278
+ end
279
+ add_message "google.analytics.admin.v1alpha.GetGoogleSignalsSettingsRequest" do
280
+ optional :name, :string, 1
281
+ end
282
+ add_message "google.analytics.admin.v1alpha.UpdateGoogleSignalsSettingsRequest" do
283
+ optional :google_signals_settings, :message, 1, "google.analytics.admin.v1alpha.GoogleSignalsSettings"
284
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
285
+ end
286
+ add_message "google.analytics.admin.v1alpha.CreateConversionEventRequest" do
287
+ optional :conversion_event, :message, 1, "google.analytics.admin.v1alpha.ConversionEvent"
288
+ optional :parent, :string, 2
289
+ end
290
+ add_message "google.analytics.admin.v1alpha.GetConversionEventRequest" do
291
+ optional :name, :string, 1
292
+ end
293
+ add_message "google.analytics.admin.v1alpha.DeleteConversionEventRequest" do
294
+ optional :name, :string, 1
295
+ end
296
+ add_message "google.analytics.admin.v1alpha.ListConversionEventsRequest" do
297
+ optional :parent, :string, 1
298
+ optional :page_size, :int32, 2
299
+ optional :page_token, :string, 3
300
+ end
301
+ add_message "google.analytics.admin.v1alpha.ListConversionEventsResponse" do
302
+ repeated :conversion_events, :message, 1, "google.analytics.admin.v1alpha.ConversionEvent"
303
+ optional :next_page_token, :string, 2
304
+ end
305
+ add_message "google.analytics.admin.v1alpha.GetDisplayVideo360AdvertiserLinkRequest" do
306
+ optional :name, :string, 1
307
+ end
308
+ add_message "google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinksRequest" do
309
+ optional :parent, :string, 1
310
+ optional :page_size, :int32, 2
311
+ optional :page_token, :string, 3
312
+ end
313
+ add_message "google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinksResponse" do
314
+ repeated :display_video_360_advertiser_links, :message, 1, "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink"
315
+ optional :next_page_token, :string, 2
316
+ end
317
+ add_message "google.analytics.admin.v1alpha.CreateDisplayVideo360AdvertiserLinkRequest" do
318
+ optional :parent, :string, 1
319
+ optional :display_video_360_advertiser_link, :message, 2, "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink"
320
+ end
321
+ add_message "google.analytics.admin.v1alpha.DeleteDisplayVideo360AdvertiserLinkRequest" do
322
+ optional :name, :string, 1
323
+ end
324
+ add_message "google.analytics.admin.v1alpha.UpdateDisplayVideo360AdvertiserLinkRequest" do
325
+ optional :display_video_360_advertiser_link, :message, 1, "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink"
326
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
327
+ end
328
+ add_message "google.analytics.admin.v1alpha.GetDisplayVideo360AdvertiserLinkProposalRequest" do
329
+ optional :name, :string, 1
330
+ end
331
+ add_message "google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinkProposalsRequest" do
332
+ optional :parent, :string, 1
333
+ optional :page_size, :int32, 2
334
+ optional :page_token, :string, 3
335
+ end
336
+ add_message "google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinkProposalsResponse" do
337
+ repeated :display_video_360_advertiser_link_proposals, :message, 1, "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLinkProposal"
338
+ optional :next_page_token, :string, 2
339
+ end
340
+ add_message "google.analytics.admin.v1alpha.CreateDisplayVideo360AdvertiserLinkProposalRequest" do
341
+ optional :parent, :string, 1
342
+ optional :display_video_360_advertiser_link_proposal, :message, 2, "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLinkProposal"
343
+ end
344
+ add_message "google.analytics.admin.v1alpha.DeleteDisplayVideo360AdvertiserLinkProposalRequest" do
345
+ optional :name, :string, 1
346
+ end
347
+ add_message "google.analytics.admin.v1alpha.ApproveDisplayVideo360AdvertiserLinkProposalRequest" do
348
+ optional :name, :string, 1
349
+ end
350
+ add_message "google.analytics.admin.v1alpha.ApproveDisplayVideo360AdvertiserLinkProposalResponse" do
351
+ optional :display_video_360_advertiser_link, :message, 1, "google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLink"
352
+ end
353
+ add_message "google.analytics.admin.v1alpha.CancelDisplayVideo360AdvertiserLinkProposalRequest" do
354
+ optional :name, :string, 1
355
+ end
356
+ add_message "google.analytics.admin.v1alpha.CreateCustomDimensionRequest" do
357
+ optional :parent, :string, 1
358
+ optional :custom_dimension, :message, 2, "google.analytics.admin.v1alpha.CustomDimension"
359
+ end
360
+ add_message "google.analytics.admin.v1alpha.UpdateCustomDimensionRequest" do
361
+ optional :custom_dimension, :message, 1, "google.analytics.admin.v1alpha.CustomDimension"
362
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
363
+ end
364
+ add_message "google.analytics.admin.v1alpha.ListCustomDimensionsRequest" do
365
+ optional :parent, :string, 1
366
+ optional :page_size, :int32, 2
367
+ optional :page_token, :string, 3
368
+ end
369
+ add_message "google.analytics.admin.v1alpha.ListCustomDimensionsResponse" do
370
+ repeated :custom_dimensions, :message, 1, "google.analytics.admin.v1alpha.CustomDimension"
371
+ optional :next_page_token, :string, 2
372
+ end
373
+ add_message "google.analytics.admin.v1alpha.ArchiveCustomDimensionRequest" do
374
+ optional :name, :string, 1
375
+ end
376
+ add_message "google.analytics.admin.v1alpha.GetCustomDimensionRequest" do
377
+ optional :name, :string, 1
378
+ end
379
+ add_message "google.analytics.admin.v1alpha.CreateCustomMetricRequest" do
380
+ optional :parent, :string, 1
381
+ optional :custom_metric, :message, 2, "google.analytics.admin.v1alpha.CustomMetric"
382
+ end
383
+ add_message "google.analytics.admin.v1alpha.UpdateCustomMetricRequest" do
384
+ optional :custom_metric, :message, 1, "google.analytics.admin.v1alpha.CustomMetric"
385
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
386
+ end
387
+ add_message "google.analytics.admin.v1alpha.ListCustomMetricsRequest" do
388
+ optional :parent, :string, 1
389
+ optional :page_size, :int32, 2
390
+ optional :page_token, :string, 3
391
+ end
392
+ add_message "google.analytics.admin.v1alpha.ListCustomMetricsResponse" do
393
+ repeated :custom_metrics, :message, 1, "google.analytics.admin.v1alpha.CustomMetric"
394
+ optional :next_page_token, :string, 2
395
+ end
396
+ add_message "google.analytics.admin.v1alpha.ArchiveCustomMetricRequest" do
397
+ optional :name, :string, 1
398
+ end
399
+ add_message "google.analytics.admin.v1alpha.GetCustomMetricRequest" do
400
+ optional :name, :string, 1
401
+ end
402
+ add_message "google.analytics.admin.v1alpha.GetDataRetentionSettingsRequest" do
403
+ optional :name, :string, 1
404
+ end
405
+ add_message "google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest" do
406
+ optional :data_retention_settings, :message, 1, "google.analytics.admin.v1alpha.DataRetentionSettings"
407
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
408
+ end
260
409
  end
261
410
  end
262
411
 
@@ -311,7 +460,6 @@ module Google
311
460
  GetEnhancedMeasurementSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetEnhancedMeasurementSettingsRequest").msgclass
312
461
  UpdateEnhancedMeasurementSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateEnhancedMeasurementSettingsRequest").msgclass
313
462
  CreateFirebaseLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateFirebaseLinkRequest").msgclass
314
- UpdateFirebaseLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateFirebaseLinkRequest").msgclass
315
463
  DeleteFirebaseLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteFirebaseLinkRequest").msgclass
316
464
  ListFirebaseLinksRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListFirebaseLinksRequest").msgclass
317
465
  ListFirebaseLinksResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListFirebaseLinksResponse").msgclass
@@ -326,6 +474,47 @@ module Google
326
474
  ListAccountSummariesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListAccountSummariesResponse").msgclass
327
475
  SearchChangeHistoryEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest").msgclass
328
476
  SearchChangeHistoryEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse").msgclass
477
+ GetMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetMeasurementProtocolSecretRequest").msgclass
478
+ CreateMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateMeasurementProtocolSecretRequest").msgclass
479
+ DeleteMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteMeasurementProtocolSecretRequest").msgclass
480
+ UpdateMeasurementProtocolSecretRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateMeasurementProtocolSecretRequest").msgclass
481
+ ListMeasurementProtocolSecretsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsRequest").msgclass
482
+ ListMeasurementProtocolSecretsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListMeasurementProtocolSecretsResponse").msgclass
483
+ GetGoogleSignalsSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetGoogleSignalsSettingsRequest").msgclass
484
+ UpdateGoogleSignalsSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateGoogleSignalsSettingsRequest").msgclass
485
+ CreateConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateConversionEventRequest").msgclass
486
+ GetConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetConversionEventRequest").msgclass
487
+ DeleteConversionEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteConversionEventRequest").msgclass
488
+ ListConversionEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListConversionEventsRequest").msgclass
489
+ ListConversionEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListConversionEventsResponse").msgclass
490
+ GetDisplayVideo360AdvertiserLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetDisplayVideo360AdvertiserLinkRequest").msgclass
491
+ ListDisplayVideo360AdvertiserLinksRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinksRequest").msgclass
492
+ ListDisplayVideo360AdvertiserLinksResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinksResponse").msgclass
493
+ CreateDisplayVideo360AdvertiserLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateDisplayVideo360AdvertiserLinkRequest").msgclass
494
+ DeleteDisplayVideo360AdvertiserLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteDisplayVideo360AdvertiserLinkRequest").msgclass
495
+ UpdateDisplayVideo360AdvertiserLinkRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateDisplayVideo360AdvertiserLinkRequest").msgclass
496
+ GetDisplayVideo360AdvertiserLinkProposalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetDisplayVideo360AdvertiserLinkProposalRequest").msgclass
497
+ ListDisplayVideo360AdvertiserLinkProposalsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinkProposalsRequest").msgclass
498
+ ListDisplayVideo360AdvertiserLinkProposalsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListDisplayVideo360AdvertiserLinkProposalsResponse").msgclass
499
+ CreateDisplayVideo360AdvertiserLinkProposalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateDisplayVideo360AdvertiserLinkProposalRequest").msgclass
500
+ DeleteDisplayVideo360AdvertiserLinkProposalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.DeleteDisplayVideo360AdvertiserLinkProposalRequest").msgclass
501
+ ApproveDisplayVideo360AdvertiserLinkProposalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ApproveDisplayVideo360AdvertiserLinkProposalRequest").msgclass
502
+ ApproveDisplayVideo360AdvertiserLinkProposalResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ApproveDisplayVideo360AdvertiserLinkProposalResponse").msgclass
503
+ CancelDisplayVideo360AdvertiserLinkProposalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CancelDisplayVideo360AdvertiserLinkProposalRequest").msgclass
504
+ CreateCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateCustomDimensionRequest").msgclass
505
+ UpdateCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateCustomDimensionRequest").msgclass
506
+ ListCustomDimensionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomDimensionsRequest").msgclass
507
+ ListCustomDimensionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomDimensionsResponse").msgclass
508
+ ArchiveCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ArchiveCustomDimensionRequest").msgclass
509
+ GetCustomDimensionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetCustomDimensionRequest").msgclass
510
+ CreateCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.CreateCustomMetricRequest").msgclass
511
+ UpdateCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateCustomMetricRequest").msgclass
512
+ ListCustomMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomMetricsRequest").msgclass
513
+ ListCustomMetricsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ListCustomMetricsResponse").msgclass
514
+ ArchiveCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.ArchiveCustomMetricRequest").msgclass
515
+ GetCustomMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetCustomMetricRequest").msgclass
516
+ GetDataRetentionSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.GetDataRetentionSettingsRequest").msgclass
517
+ UpdateDataRetentionSettingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest").msgclass
329
518
  end
330
519
  end
331
520
  end
data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb CHANGED
@@ -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
- # ## Example
44
+ # @example
45
45
  #
46
- # To modify the configuration for all AnalyticsAdminService clients:
47
- #
48
- # ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
49
- # config.timeout = 10.0
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
@@ -143,8 +139,6 @@ module Google
143
139
 
144
140
  default_config.rpcs.create_firebase_link.timeout = 60.0
145
141
 
146
- default_config.rpcs.update_firebase_link.timeout = 60.0
147
-
148
142
  default_config.rpcs.delete_firebase_link.timeout = 60.0
149
143
 
150
144
  default_config.rpcs.list_firebase_links.timeout = 60.0
@@ -188,19 +182,15 @@ module Google
188
182
  ##
189
183
  # Create a new AnalyticsAdminService client object.
190
184
  #
191
- # ## Examples
192
- #
193
- # To create a new AnalyticsAdminService client with the default
194
- # configuration:
195
- #
196
- # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
185
+ # @example
197
186
  #
198
- # To create a new AnalyticsAdminService client with a custom
199
- # configuration:
187
+ # # Create a client using the default configuration
188
+ # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
200
189
  #
201
- # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
202
- # config.timeout = 10.0
203
- # end
190
+ # # Create a client using a custom configuration
191
+ # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
192
+ # config.timeout = 10.0
193
+ # end
204
194
  #
205
195
  # @yield [config] Configure the AnalyticsAdminService client.
206
196
  # @yieldparam config [Client::Configuration]
@@ -220,14 +210,13 @@ module Google
220
210
 
221
211
  # Create credentials
222
212
  credentials = @config.credentials
223
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
213
+ # Use self-signed JWT if the endpoint is unchanged from default,
224
214
  # but only if the default endpoint does not have a region prefix.
225
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
226
- @config.endpoint == Client.configure.endpoint &&
215
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
227
216
  !@config.endpoint.split(".").first.include?("-")
228
217
  credentials ||= Credentials.default scope: @config.scope,
229
218
  enable_self_signed_jwt: enable_self_signed_jwt
230
- if credentials.is_a?(String) || credentials.is_a?(Hash)
219
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
231
220
  credentials = Credentials.new credentials, scope: @config.scope
232
221
  end
233
222
  @quota_project_id = @config.quota_project
@@ -301,7 +290,9 @@ module Google
301
290
  options.apply_defaults timeout: @config.rpcs.get_account.timeout,
302
291
  metadata: metadata,
303
292
  retry_policy: @config.rpcs.get_account.retry_policy
304
- options.apply_defaults metadata: @config.metadata,
293
+
294
+ options.apply_defaults timeout: @config.timeout,
295
+ metadata: @config.metadata,
305
296
  retry_policy: @config.retry_policy
306
297
 
307
298
  @analytics_admin_service_stub.call_rpc :get_account, request, options: options do |response, operation|
@@ -377,7 +368,9 @@ module Google
377
368
  options.apply_defaults timeout: @config.rpcs.list_accounts.timeout,
378
369
  metadata: metadata,
379
370
  retry_policy: @config.rpcs.list_accounts.retry_policy
380
- options.apply_defaults metadata: @config.metadata,
371
+
372
+ options.apply_defaults timeout: @config.timeout,
373
+ metadata: @config.metadata,
381
374
  retry_policy: @config.retry_policy
382
375
 
383
376
  @analytics_admin_service_stub.call_rpc :list_accounts, request, options: options do |response, operation|
@@ -456,7 +449,9 @@ module Google
456
449
  options.apply_defaults timeout: @config.rpcs.delete_account.timeout,
457
450
  metadata: metadata,
458
451
  retry_policy: @config.rpcs.delete_account.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
452
+
453
+ options.apply_defaults timeout: @config.timeout,
454
+ metadata: @config.metadata,
460
455
  retry_policy: @config.retry_policy
461
456
 
462
457
  @analytics_admin_service_stub.call_rpc :delete_account, request, options: options do |response, operation|
@@ -527,7 +522,9 @@ module Google
527
522
  options.apply_defaults timeout: @config.rpcs.update_account.timeout,
528
523
  metadata: metadata,
529
524
  retry_policy: @config.rpcs.update_account.retry_policy
530
- options.apply_defaults metadata: @config.metadata,
525
+
526
+ options.apply_defaults timeout: @config.timeout,
527
+ metadata: @config.metadata,
531
528
  retry_policy: @config.retry_policy
532
529
 
533
530
  @analytics_admin_service_stub.call_rpc :update_account, request, options: options do |response, operation|
@@ -590,7 +587,9 @@ module Google
590
587
  options.apply_defaults timeout: @config.rpcs.provision_account_ticket.timeout,
591
588
  metadata: metadata,
592
589
  retry_policy: @config.rpcs.provision_account_ticket.retry_policy
593
- options.apply_defaults metadata: @config.metadata,
590
+
591
+ options.apply_defaults timeout: @config.timeout,
592
+ metadata: @config.metadata,
594
593
  retry_policy: @config.retry_policy
595
594
 
596
595
  @analytics_admin_service_stub.call_rpc :provision_account_ticket, request, options: options do |response, operation|
@@ -658,7 +657,9 @@ module Google
658
657
  options.apply_defaults timeout: @config.rpcs.list_account_summaries.timeout,
659
658
  metadata: metadata,
660
659
  retry_policy: @config.rpcs.list_account_summaries.retry_policy
661
- options.apply_defaults metadata: @config.metadata,
660
+
661
+ options.apply_defaults timeout: @config.timeout,
662
+ metadata: @config.metadata,
662
663
  retry_policy: @config.retry_policy
663
664
 
664
665
  @analytics_admin_service_stub.call_rpc :list_account_summaries, request, options: options do |response, operation|
@@ -727,7 +728,9 @@ module Google
727
728
  options.apply_defaults timeout: @config.rpcs.get_property.timeout,
728
729
  metadata: metadata,
729
730
  retry_policy: @config.rpcs.get_property.retry_policy
730
- options.apply_defaults metadata: @config.metadata,
731
+
732
+ options.apply_defaults timeout: @config.timeout,
733
+ metadata: @config.metadata,
731
734
  retry_policy: @config.retry_policy
732
735
 
733
736
  @analytics_admin_service_stub.call_rpc :get_property, request, options: options do |response, operation|
@@ -818,7 +821,9 @@ module Google
818
821
  options.apply_defaults timeout: @config.rpcs.list_properties.timeout,
819
822
  metadata: metadata,
820
823
  retry_policy: @config.rpcs.list_properties.retry_policy
821
- options.apply_defaults metadata: @config.metadata,
824
+
825
+ options.apply_defaults timeout: @config.timeout,
826
+ metadata: @config.metadata,
822
827
  retry_policy: @config.retry_policy
823
828
 
824
829
  @analytics_admin_service_stub.call_rpc :list_properties, request, options: options do |response, operation|
@@ -880,7 +885,9 @@ module Google
880
885
  options.apply_defaults timeout: @config.rpcs.create_property.timeout,
881
886
  metadata: metadata,
882
887
  retry_policy: @config.rpcs.create_property.retry_policy
883
- options.apply_defaults metadata: @config.metadata,
888
+
889
+ options.apply_defaults timeout: @config.timeout,
890
+ metadata: @config.metadata,
884
891
  retry_policy: @config.retry_policy
885
892
 
886
893
  @analytics_admin_service_stub.call_rpc :create_property, request, options: options do |response, operation|
@@ -958,7 +965,9 @@ module Google
958
965
  options.apply_defaults timeout: @config.rpcs.delete_property.timeout,
959
966
  metadata: metadata,
960
967
  retry_policy: @config.rpcs.delete_property.retry_policy
961
- options.apply_defaults metadata: @config.metadata,
968
+
969
+ options.apply_defaults timeout: @config.timeout,
970
+ metadata: @config.metadata,
962
971
  retry_policy: @config.retry_policy
963
972
 
964
973
  @analytics_admin_service_stub.call_rpc :delete_property, request, options: options do |response, operation|
@@ -1030,7 +1039,9 @@ module Google
1030
1039
  options.apply_defaults timeout: @config.rpcs.update_property.timeout,
1031
1040
  metadata: metadata,
1032
1041
  retry_policy: @config.rpcs.update_property.retry_policy
1033
- options.apply_defaults metadata: @config.metadata,
1042
+
1043
+ options.apply_defaults timeout: @config.timeout,
1044
+ metadata: @config.metadata,
1034
1045
  retry_policy: @config.retry_policy
1035
1046
 
1036
1047
  @analytics_admin_service_stub.call_rpc :update_property, request, options: options do |response, operation|
@@ -1096,7 +1107,9 @@ module Google
1096
1107
  options.apply_defaults timeout: @config.rpcs.get_user_link.timeout,
1097
1108
  metadata: metadata,
1098
1109
  retry_policy: @config.rpcs.get_user_link.retry_policy
1099
- options.apply_defaults metadata: @config.metadata,
1110
+
1111
+ options.apply_defaults timeout: @config.timeout,
1112
+ metadata: @config.metadata,
1100
1113
  retry_policy: @config.retry_policy
1101
1114
 
1102
1115
  @analytics_admin_service_stub.call_rpc :get_user_link, request, options: options do |response, operation|
@@ -1169,7 +1182,9 @@ module Google
1169
1182
  options.apply_defaults timeout: @config.rpcs.batch_get_user_links.timeout,
1170
1183
  metadata: metadata,
1171
1184
  retry_policy: @config.rpcs.batch_get_user_links.retry_policy
1172
- options.apply_defaults metadata: @config.metadata,
1185
+
1186
+ options.apply_defaults timeout: @config.timeout,
1187
+ metadata: @config.metadata,
1173
1188
  retry_policy: @config.retry_policy
1174
1189
 
1175
1190
  @analytics_admin_service_stub.call_rpc :batch_get_user_links, request, options: options do |response, operation|
@@ -1245,7 +1260,9 @@ module Google
1245
1260
  options.apply_defaults timeout: @config.rpcs.list_user_links.timeout,
1246
1261
  metadata: metadata,
1247
1262
  retry_policy: @config.rpcs.list_user_links.retry_policy
1248
- options.apply_defaults metadata: @config.metadata,
1263
+
1264
+ options.apply_defaults timeout: @config.timeout,
1265
+ metadata: @config.metadata,
1249
1266
  retry_policy: @config.retry_policy
1250
1267
 
1251
1268
  @analytics_admin_service_stub.call_rpc :list_user_links, request, options: options do |response, operation|
@@ -1330,7 +1347,9 @@ module Google
1330
1347
  options.apply_defaults timeout: @config.rpcs.audit_user_links.timeout,
1331
1348
  metadata: metadata,
1332
1349
  retry_policy: @config.rpcs.audit_user_links.retry_policy
1333
- options.apply_defaults metadata: @config.metadata,
1350
+
1351
+ options.apply_defaults timeout: @config.timeout,
1352
+ metadata: @config.metadata,
1334
1353
  retry_policy: @config.retry_policy
1335
1354
 
1336
1355
  @analytics_admin_service_stub.call_rpc :audit_user_links, request, options: options do |response, operation|
@@ -1406,7 +1425,9 @@ module Google
1406
1425
  options.apply_defaults timeout: @config.rpcs.create_user_link.timeout,
1407
1426
  metadata: metadata,
1408
1427
  retry_policy: @config.rpcs.create_user_link.retry_policy
1409
- options.apply_defaults metadata: @config.metadata,
1428
+
1429
+ options.apply_defaults timeout: @config.timeout,
1430
+ metadata: @config.metadata,
1410
1431
  retry_policy: @config.retry_policy
1411
1432
 
1412
1433
  @analytics_admin_service_stub.call_rpc :create_user_link, request, options: options do |response, operation|
@@ -1485,7 +1506,9 @@ module Google
1485
1506
  options.apply_defaults timeout: @config.rpcs.batch_create_user_links.timeout,
1486
1507
  metadata: metadata,
1487
1508
  retry_policy: @config.rpcs.batch_create_user_links.retry_policy
1488
- options.apply_defaults metadata: @config.metadata,
1509
+
1510
+ options.apply_defaults timeout: @config.timeout,
1511
+ metadata: @config.metadata,
1489
1512
  retry_policy: @config.retry_policy
1490
1513
 
1491
1514
  @analytics_admin_service_stub.call_rpc :batch_create_user_links, request, options: options do |response, operation|
@@ -1551,7 +1574,9 @@ module Google
1551
1574
  options.apply_defaults timeout: @config.rpcs.update_user_link.timeout,
1552
1575
  metadata: metadata,
1553
1576
  retry_policy: @config.rpcs.update_user_link.retry_policy
1554
- options.apply_defaults metadata: @config.metadata,
1577
+
1578
+ options.apply_defaults timeout: @config.timeout,
1579
+ metadata: @config.metadata,
1555
1580
  retry_policy: @config.retry_policy
1556
1581
 
1557
1582
  @analytics_admin_service_stub.call_rpc :update_user_link, request, options: options do |response, operation|
@@ -1623,7 +1648,9 @@ module Google
1623
1648
  options.apply_defaults timeout: @config.rpcs.batch_update_user_links.timeout,
1624
1649
  metadata: metadata,
1625
1650
  retry_policy: @config.rpcs.batch_update_user_links.retry_policy
1626
- options.apply_defaults metadata: @config.metadata,
1651
+
1652
+ options.apply_defaults timeout: @config.timeout,
1653
+ metadata: @config.metadata,
1627
1654
  retry_policy: @config.retry_policy
1628
1655
 
1629
1656
  @analytics_admin_service_stub.call_rpc :batch_update_user_links, request, options: options do |response, operation|
@@ -1689,7 +1716,9 @@ module Google
1689
1716
  options.apply_defaults timeout: @config.rpcs.delete_user_link.timeout,
1690
1717
  metadata: metadata,
1691
1718
  retry_policy: @config.rpcs.delete_user_link.retry_policy
1692
- options.apply_defaults metadata: @config.metadata,
1719
+
1720
+ options.apply_defaults timeout: @config.timeout,
1721
+ metadata: @config.metadata,
1693
1722
  retry_policy: @config.retry_policy
1694
1723
 
1695
1724
  @analytics_admin_service_stub.call_rpc :delete_user_link, request, options: options do |response, operation|
@@ -1761,7 +1790,9 @@ module Google
1761
1790
  options.apply_defaults timeout: @config.rpcs.batch_delete_user_links.timeout,
1762
1791
  metadata: metadata,
1763
1792
  retry_policy: @config.rpcs.batch_delete_user_links.retry_policy
1764
- options.apply_defaults metadata: @config.metadata,
1793
+
1794
+ options.apply_defaults timeout: @config.timeout,
1795
+ metadata: @config.metadata,
1765
1796
  retry_policy: @config.retry_policy
1766
1797
 
1767
1798
  @analytics_admin_service_stub.call_rpc :batch_delete_user_links, request, options: options do |response, operation|
@@ -1829,7 +1860,9 @@ module Google
1829
1860
  options.apply_defaults timeout: @config.rpcs.get_web_data_stream.timeout,
1830
1861
  metadata: metadata,
1831
1862
  retry_policy: @config.rpcs.get_web_data_stream.retry_policy
1832
- options.apply_defaults metadata: @config.metadata,
1863
+
1864
+ options.apply_defaults timeout: @config.timeout,
1865
+ metadata: @config.metadata,
1833
1866
  retry_policy: @config.retry_policy
1834
1867
 
1835
1868
  @analytics_admin_service_stub.call_rpc :get_web_data_stream, request, options: options do |response, operation|
@@ -1897,7 +1930,9 @@ module Google
1897
1930
  options.apply_defaults timeout: @config.rpcs.delete_web_data_stream.timeout,
1898
1931
  metadata: metadata,
1899
1932
  retry_policy: @config.rpcs.delete_web_data_stream.retry_policy
1900
- options.apply_defaults metadata: @config.metadata,
1933
+
1934
+ options.apply_defaults timeout: @config.timeout,
1935
+ metadata: @config.metadata,
1901
1936
  retry_policy: @config.retry_policy
1902
1937
 
1903
1938
  @analytics_admin_service_stub.call_rpc :delete_web_data_stream, request, options: options do |response, operation|
@@ -1968,7 +2003,9 @@ module Google
1968
2003
  options.apply_defaults timeout: @config.rpcs.update_web_data_stream.timeout,
1969
2004
  metadata: metadata,
1970
2005
  retry_policy: @config.rpcs.update_web_data_stream.retry_policy
1971
- options.apply_defaults metadata: @config.metadata,
2006
+
2007
+ options.apply_defaults timeout: @config.timeout,
2008
+ metadata: @config.metadata,
1972
2009
  retry_policy: @config.retry_policy
1973
2010
 
1974
2011
  @analytics_admin_service_stub.call_rpc :update_web_data_stream, request, options: options do |response, operation|
@@ -2037,7 +2074,9 @@ module Google
2037
2074
  options.apply_defaults timeout: @config.rpcs.create_web_data_stream.timeout,
2038
2075
  metadata: metadata,
2039
2076
  retry_policy: @config.rpcs.create_web_data_stream.retry_policy
2040
- options.apply_defaults metadata: @config.metadata,
2077
+
2078
+ options.apply_defaults timeout: @config.timeout,
2079
+ metadata: @config.metadata,
2041
2080
  retry_policy: @config.retry_policy
2042
2081
 
2043
2082
  @analytics_admin_service_stub.call_rpc :create_web_data_stream, request, options: options do |response, operation|
@@ -2117,7 +2156,9 @@ module Google
2117
2156
  options.apply_defaults timeout: @config.rpcs.list_web_data_streams.timeout,
2118
2157
  metadata: metadata,
2119
2158
  retry_policy: @config.rpcs.list_web_data_streams.retry_policy
2120
- options.apply_defaults metadata: @config.metadata,
2159
+
2160
+ options.apply_defaults timeout: @config.timeout,
2161
+ metadata: @config.metadata,
2121
2162
  retry_policy: @config.retry_policy
2122
2163
 
2123
2164
  @analytics_admin_service_stub.call_rpc :list_web_data_streams, request, options: options do |response, operation|
@@ -2186,7 +2227,9 @@ module Google
2186
2227
  options.apply_defaults timeout: @config.rpcs.get_ios_app_data_stream.timeout,
2187
2228
  metadata: metadata,
2188
2229
  retry_policy: @config.rpcs.get_ios_app_data_stream.retry_policy
2189
- options.apply_defaults metadata: @config.metadata,
2230
+
2231
+ options.apply_defaults timeout: @config.timeout,
2232
+ metadata: @config.metadata,
2190
2233
  retry_policy: @config.retry_policy
2191
2234
 
2192
2235
  @analytics_admin_service_stub.call_rpc :get_ios_app_data_stream, request, options: options do |response, operation|
@@ -2254,7 +2297,9 @@ module Google
2254
2297
  options.apply_defaults timeout: @config.rpcs.delete_ios_app_data_stream.timeout,
2255
2298
  metadata: metadata,
2256
2299
  retry_policy: @config.rpcs.delete_ios_app_data_stream.retry_policy
2257
- options.apply_defaults metadata: @config.metadata,
2300
+
2301
+ options.apply_defaults timeout: @config.timeout,
2302
+ metadata: @config.metadata,
2258
2303
  retry_policy: @config.retry_policy
2259
2304
 
2260
2305
  @analytics_admin_service_stub.call_rpc :delete_ios_app_data_stream, request, options: options do |response, operation|
@@ -2325,7 +2370,9 @@ module Google
2325
2370
  options.apply_defaults timeout: @config.rpcs.update_ios_app_data_stream.timeout,
2326
2371
  metadata: metadata,
2327
2372
  retry_policy: @config.rpcs.update_ios_app_data_stream.retry_policy
2328
- options.apply_defaults metadata: @config.metadata,
2373
+
2374
+ options.apply_defaults timeout: @config.timeout,
2375
+ metadata: @config.metadata,
2329
2376
  retry_policy: @config.retry_policy
2330
2377
 
2331
2378
  @analytics_admin_service_stub.call_rpc :update_ios_app_data_stream, request, options: options do |response, operation|
@@ -2405,7 +2452,9 @@ module Google
2405
2452
  options.apply_defaults timeout: @config.rpcs.list_ios_app_data_streams.timeout,
2406
2453
  metadata: metadata,
2407
2454
  retry_policy: @config.rpcs.list_ios_app_data_streams.retry_policy
2408
- options.apply_defaults metadata: @config.metadata,
2455
+
2456
+ options.apply_defaults timeout: @config.timeout,
2457
+ metadata: @config.metadata,
2409
2458
  retry_policy: @config.retry_policy
2410
2459
 
2411
2460
  @analytics_admin_service_stub.call_rpc :list_ios_app_data_streams, request, options: options do |response, operation|
@@ -2474,7 +2523,9 @@ module Google
2474
2523
  options.apply_defaults timeout: @config.rpcs.get_android_app_data_stream.timeout,
2475
2524
  metadata: metadata,
2476
2525
  retry_policy: @config.rpcs.get_android_app_data_stream.retry_policy
2477
- options.apply_defaults metadata: @config.metadata,
2526
+
2527
+ options.apply_defaults timeout: @config.timeout,
2528
+ metadata: @config.metadata,
2478
2529
  retry_policy: @config.retry_policy
2479
2530
 
2480
2531
  @analytics_admin_service_stub.call_rpc :get_android_app_data_stream, request, options: options do |response, operation|
@@ -2542,7 +2593,9 @@ module Google
2542
2593
  options.apply_defaults timeout: @config.rpcs.delete_android_app_data_stream.timeout,
2543
2594
  metadata: metadata,
2544
2595
  retry_policy: @config.rpcs.delete_android_app_data_stream.retry_policy
2545
- options.apply_defaults metadata: @config.metadata,
2596
+
2597
+ options.apply_defaults timeout: @config.timeout,
2598
+ metadata: @config.metadata,
2546
2599
  retry_policy: @config.retry_policy
2547
2600
 
2548
2601
  @analytics_admin_service_stub.call_rpc :delete_android_app_data_stream, request, options: options do |response, operation|
@@ -2613,7 +2666,9 @@ module Google
2613
2666
  options.apply_defaults timeout: @config.rpcs.update_android_app_data_stream.timeout,
2614
2667
  metadata: metadata,
2615
2668
  retry_policy: @config.rpcs.update_android_app_data_stream.retry_policy
2616
- options.apply_defaults metadata: @config.metadata,
2669
+
2670
+ options.apply_defaults timeout: @config.timeout,
2671
+ metadata: @config.metadata,
2617
2672
  retry_policy: @config.retry_policy
2618
2673
 
2619
2674
  @analytics_admin_service_stub.call_rpc :update_android_app_data_stream, request, options: options do |response, operation|
@@ -2695,7 +2750,9 @@ module Google
2695
2750
  options.apply_defaults timeout: @config.rpcs.list_android_app_data_streams.timeout,
2696
2751
  metadata: metadata,
2697
2752
  retry_policy: @config.rpcs.list_android_app_data_streams.retry_policy
2698
- options.apply_defaults metadata: @config.metadata,
2753
+
2754
+ options.apply_defaults timeout: @config.timeout,
2755
+ metadata: @config.metadata,
2699
2756
  retry_policy: @config.retry_policy
2700
2757
 
2701
2758
  @analytics_admin_service_stub.call_rpc :list_android_app_data_streams, request, options: options do |response, operation|
@@ -2767,7 +2824,9 @@ module Google
2767
2824
  options.apply_defaults timeout: @config.rpcs.get_enhanced_measurement_settings.timeout,
2768
2825
  metadata: metadata,
2769
2826
  retry_policy: @config.rpcs.get_enhanced_measurement_settings.retry_policy
2770
- options.apply_defaults metadata: @config.metadata,
2827
+
2828
+ options.apply_defaults timeout: @config.timeout,
2829
+ metadata: @config.metadata,
2771
2830
  retry_policy: @config.retry_policy
2772
2831
 
2773
2832
  @analytics_admin_service_stub.call_rpc :get_enhanced_measurement_settings, request, options: options do |response, operation|
@@ -2840,7 +2899,9 @@ module Google
2840
2899
  options.apply_defaults timeout: @config.rpcs.update_enhanced_measurement_settings.timeout,
2841
2900
  metadata: metadata,
2842
2901
  retry_policy: @config.rpcs.update_enhanced_measurement_settings.retry_policy
2843
- options.apply_defaults metadata: @config.metadata,
2902
+
2903
+ options.apply_defaults timeout: @config.timeout,
2904
+ metadata: @config.metadata,
2844
2905
  retry_policy: @config.retry_policy
2845
2906
 
2846
2907
  @analytics_admin_service_stub.call_rpc :update_enhanced_measurement_settings, request, options: options do |response, operation|
@@ -2911,80 +2972,12 @@ module Google
2911
2972
  options.apply_defaults timeout: @config.rpcs.create_firebase_link.timeout,
2912
2973
  metadata: metadata,
2913
2974
  retry_policy: @config.rpcs.create_firebase_link.retry_policy
2914
- options.apply_defaults metadata: @config.metadata,
2915
- retry_policy: @config.retry_policy
2916
-
2917
- @analytics_admin_service_stub.call_rpc :create_firebase_link, request, options: options do |response, operation|
2918
- yield response, operation if block_given?
2919
- return response
2920
- end
2921
- rescue ::GRPC::BadStatus => e
2922
- raise ::Google::Cloud::Error.from_error(e)
2923
- end
2924
-
2925
- ##
2926
- # Updates a FirebaseLink on a property
2927
- #
2928
- # @overload update_firebase_link(request, options = nil)
2929
- # Pass arguments to `update_firebase_link` via a request object, either of type
2930
- # {::Google::Analytics::Admin::V1alpha::UpdateFirebaseLinkRequest} or an equivalent Hash.
2931
- #
2932
- # @param request [::Google::Analytics::Admin::V1alpha::UpdateFirebaseLinkRequest, ::Hash]
2933
- # A request object representing the call parameters. Required. To specify no
2934
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2935
- # @param options [::Gapic::CallOptions, ::Hash]
2936
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2937
- #
2938
- # @overload update_firebase_link(firebase_link: nil, update_mask: nil)
2939
- # Pass arguments to `update_firebase_link` via keyword arguments. Note that at
2940
- # least one keyword argument is required. To specify no parameters, or to keep all
2941
- # the default parameter values, pass an empty Hash as a request object (see above).
2942
- #
2943
- # @param firebase_link [::Google::Analytics::Admin::V1alpha::FirebaseLink, ::Hash]
2944
- # Required. The Firebase link to update.
2945
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2946
- # Required. The list of fields to be updated. Field names must be in snake case
2947
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
2948
- # the entire entity, use one path with the string "*" to match all fields.
2949
- #
2950
- # @yield [response, operation] Access the result along with the RPC operation
2951
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::FirebaseLink]
2952
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2953
- #
2954
- # @return [::Google::Analytics::Admin::V1alpha::FirebaseLink]
2955
- #
2956
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2957
- #
2958
- def update_firebase_link request, options = nil
2959
- raise ::ArgumentError, "request must be provided" if request.nil?
2960
-
2961
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateFirebaseLinkRequest
2962
-
2963
- # Converts hash and nil to an options object
2964
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2965
2975
 
2966
- # Customize the options with defaults
2967
- metadata = @config.rpcs.update_firebase_link.metadata.to_h
2968
-
2969
- # Set x-goog-api-client and x-goog-user-project headers
2970
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2971
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2972
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2973
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2974
-
2975
- header_params = {
2976
- "firebase_link.name" => request.firebase_link.name
2977
- }
2978
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2979
- metadata[:"x-goog-request-params"] ||= request_params_header
2980
-
2981
- options.apply_defaults timeout: @config.rpcs.update_firebase_link.timeout,
2982
- metadata: metadata,
2983
- retry_policy: @config.rpcs.update_firebase_link.retry_policy
2984
- options.apply_defaults metadata: @config.metadata,
2976
+ options.apply_defaults timeout: @config.timeout,
2977
+ metadata: @config.metadata,
2985
2978
  retry_policy: @config.retry_policy
2986
2979
 
2987
- @analytics_admin_service_stub.call_rpc :update_firebase_link, request, options: options do |response, operation|
2980
+ @analytics_admin_service_stub.call_rpc :create_firebase_link, request, options: options do |response, operation|
2988
2981
  yield response, operation if block_given?
2989
2982
  return response
2990
2983
  end
@@ -3048,7 +3041,9 @@ module Google
3048
3041
  options.apply_defaults timeout: @config.rpcs.delete_firebase_link.timeout,
3049
3042
  metadata: metadata,
3050
3043
  retry_policy: @config.rpcs.delete_firebase_link.retry_policy
3051
- options.apply_defaults metadata: @config.metadata,
3044
+
3045
+ options.apply_defaults timeout: @config.timeout,
3046
+ metadata: @config.metadata,
3052
3047
  retry_policy: @config.retry_policy
3053
3048
 
3054
3049
  @analytics_admin_service_stub.call_rpc :delete_firebase_link, request, options: options do |response, operation|
@@ -3126,7 +3121,9 @@ module Google
3126
3121
  options.apply_defaults timeout: @config.rpcs.list_firebase_links.timeout,
3127
3122
  metadata: metadata,
3128
3123
  retry_policy: @config.rpcs.list_firebase_links.retry_policy
3129
- options.apply_defaults metadata: @config.metadata,
3124
+
3125
+ options.apply_defaults timeout: @config.timeout,
3126
+ metadata: @config.metadata,
3130
3127
  retry_policy: @config.retry_policy
3131
3128
 
3132
3129
  @analytics_admin_service_stub.call_rpc :list_firebase_links, request, options: options do |response, operation|
@@ -3197,7 +3194,9 @@ module Google
3197
3194
  options.apply_defaults timeout: @config.rpcs.get_global_site_tag.timeout,
3198
3195
  metadata: metadata,
3199
3196
  retry_policy: @config.rpcs.get_global_site_tag.retry_policy
3200
- options.apply_defaults metadata: @config.metadata,
3197
+
3198
+ options.apply_defaults timeout: @config.timeout,
3199
+ metadata: @config.metadata,
3201
3200
  retry_policy: @config.retry_policy
3202
3201
 
3203
3202
  @analytics_admin_service_stub.call_rpc :get_global_site_tag, request, options: options do |response, operation|
@@ -3265,7 +3264,9 @@ module Google
3265
3264
  options.apply_defaults timeout: @config.rpcs.create_google_ads_link.timeout,
3266
3265
  metadata: metadata,
3267
3266
  retry_policy: @config.rpcs.create_google_ads_link.retry_policy
3268
- options.apply_defaults metadata: @config.metadata,
3267
+
3268
+ options.apply_defaults timeout: @config.timeout,
3269
+ metadata: @config.metadata,
3269
3270
  retry_policy: @config.retry_policy
3270
3271
 
3271
3272
  @analytics_admin_service_stub.call_rpc :create_google_ads_link, request, options: options do |response, operation|
@@ -3335,7 +3336,9 @@ module Google
3335
3336
  options.apply_defaults timeout: @config.rpcs.update_google_ads_link.timeout,
3336
3337
  metadata: metadata,
3337
3338
  retry_policy: @config.rpcs.update_google_ads_link.retry_policy
3338
- options.apply_defaults metadata: @config.metadata,
3339
+
3340
+ options.apply_defaults timeout: @config.timeout,
3341
+ metadata: @config.metadata,
3339
3342
  retry_policy: @config.retry_policy
3340
3343
 
3341
3344
  @analytics_admin_service_stub.call_rpc :update_google_ads_link, request, options: options do |response, operation|
@@ -3401,7 +3404,9 @@ module Google
3401
3404
  options.apply_defaults timeout: @config.rpcs.delete_google_ads_link.timeout,
3402
3405
  metadata: metadata,
3403
3406
  retry_policy: @config.rpcs.delete_google_ads_link.retry_policy
3404
- options.apply_defaults metadata: @config.metadata,
3407
+
3408
+ options.apply_defaults timeout: @config.timeout,
3409
+ metadata: @config.metadata,
3405
3410
  retry_policy: @config.retry_policy
3406
3411
 
3407
3412
  @analytics_admin_service_stub.call_rpc :delete_google_ads_link, request, options: options do |response, operation|
@@ -3477,7 +3482,9 @@ module Google
3477
3482
  options.apply_defaults timeout: @config.rpcs.list_google_ads_links.timeout,
3478
3483
  metadata: metadata,
3479
3484
  retry_policy: @config.rpcs.list_google_ads_links.retry_policy
3480
- options.apply_defaults metadata: @config.metadata,
3485
+
3486
+ options.apply_defaults timeout: @config.timeout,
3487
+ metadata: @config.metadata,
3481
3488
  retry_policy: @config.retry_policy
3482
3489
 
3483
3490
  @analytics_admin_service_stub.call_rpc :list_google_ads_links, request, options: options do |response, operation|
@@ -3547,7 +3554,9 @@ module Google
3547
3554
  options.apply_defaults timeout: @config.rpcs.get_data_sharing_settings.timeout,
3548
3555
  metadata: metadata,
3549
3556
  retry_policy: @config.rpcs.get_data_sharing_settings.retry_policy
3550
- options.apply_defaults metadata: @config.metadata,
3557
+
3558
+ options.apply_defaults timeout: @config.timeout,
3559
+ metadata: @config.metadata,
3551
3560
  retry_policy: @config.retry_policy
3552
3561
 
3553
3562
  @analytics_admin_service_stub.call_rpc :get_data_sharing_settings, request, options: options do |response, operation|
@@ -3559,70 +3568,48 @@ module Google
3559
3568
  end
3560
3569
 
3561
3570
  ##
3562
- # Searches through all changes to an account or its children given the
3563
- # specified set of filters.
3571
+ # Lookup for a single "GA4" MeasurementProtocolSecret.
3564
3572
  #
3565
- # @overload search_change_history_events(request, options = nil)
3566
- # Pass arguments to `search_change_history_events` via a request object, either of type
3567
- # {::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest} or an equivalent Hash.
3573
+ # @overload get_measurement_protocol_secret(request, options = nil)
3574
+ # Pass arguments to `get_measurement_protocol_secret` via a request object, either of type
3575
+ # {::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest} or an equivalent Hash.
3568
3576
  #
3569
- # @param request [::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Hash]
3577
+ # @param request [::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest, ::Hash]
3570
3578
  # A request object representing the call parameters. Required. To specify no
3571
3579
  # parameters, or to keep all the default parameter values, pass an empty Hash.
3572
3580
  # @param options [::Gapic::CallOptions, ::Hash]
3573
3581
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3574
3582
  #
3575
- # @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)
3576
- # Pass arguments to `search_change_history_events` via keyword arguments. Note that at
3583
+ # @overload get_measurement_protocol_secret(name: nil)
3584
+ # Pass arguments to `get_measurement_protocol_secret` via keyword arguments. Note that at
3577
3585
  # least one keyword argument is required. To specify no parameters, or to keep all
3578
3586
  # the default parameter values, pass an empty Hash as a request object (see above).
3579
3587
  #
3580
- # @param account [::String]
3581
- # Required. The account resource for which to return change history resources.
3582
- # @param property [::String]
3583
- # Optional. Resource name for a child property. If set, only return changes
3584
- # made to this property or its child resources.
3585
- # @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
3586
- # Optional. If set, only return changes if they are for a resource that matches at
3587
- # least one of these types.
3588
- # @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
3589
- # Optional. If set, only return changes that match one or more of these types of
3590
- # actions.
3591
- # @param actor_email [::Array<::String>]
3592
- # Optional. If set, only return changes if they are made by a user in this list.
3593
- # @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
3594
- # Optional. If set, only return changes made after this time (inclusive).
3595
- # @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
3596
- # Optional. If set, only return changes made before this time (inclusive).
3597
- # @param page_size [::Integer]
3598
- # Optional. The maximum number of ChangeHistoryEvent items to return.
3599
- # The service may return fewer than this value, even if there are additional
3600
- # pages. If unspecified, at most 50 items will be returned.
3601
- # The maximum value is 200 (higher values will be coerced to the maximum).
3602
- # @param page_token [::String]
3603
- # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
3604
- # Provide this to retrieve the subsequent page. When paginating, all other
3605
- # parameters provided to `SearchChangeHistoryEvents` must match the call that
3606
- # provided the page token.
3588
+ # @param name [::String]
3589
+ # Required. The name of the measurement protocol secret to lookup.
3590
+ # Format:
3591
+ # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
3592
+ # Note: Any type of stream (WebDataStream, IosAppDataStream,
3593
+ # AndroidAppDataStream) may be a parent.
3607
3594
  #
3608
3595
  # @yield [response, operation] Access the result along with the RPC operation
3609
- # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
3596
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
3610
3597
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
3611
3598
  #
3612
- # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
3599
+ # @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
3613
3600
  #
3614
3601
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3615
3602
  #
3616
- def search_change_history_events request, options = nil
3603
+ def get_measurement_protocol_secret request, options = nil
3617
3604
  raise ::ArgumentError, "request must be provided" if request.nil?
3618
3605
 
3619
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest
3606
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest
3620
3607
 
3621
3608
  # Converts hash and nil to an options object
3622
3609
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3623
3610
 
3624
3611
  # Customize the options with defaults
3625
- metadata = @config.rpcs.search_change_history_events.metadata.to_h
3612
+ metadata = @config.rpcs.get_measurement_protocol_secret.metadata.to_h
3626
3613
 
3627
3614
  # Set x-goog-api-client and x-goog-user-project headers
3628
3615
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -3631,19 +3618,20 @@ module Google
3631
3618
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3632
3619
 
3633
3620
  header_params = {
3634
- "account" => request.account
3621
+ "name" => request.name
3635
3622
  }
3636
3623
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3637
3624
  metadata[:"x-goog-request-params"] ||= request_params_header
3638
3625
 
3639
- options.apply_defaults timeout: @config.rpcs.search_change_history_events.timeout,
3626
+ options.apply_defaults timeout: @config.rpcs.get_measurement_protocol_secret.timeout,
3640
3627
  metadata: metadata,
3641
- retry_policy: @config.rpcs.search_change_history_events.retry_policy
3642
- options.apply_defaults metadata: @config.metadata,
3628
+ retry_policy: @config.rpcs.get_measurement_protocol_secret.retry_policy
3629
+
3630
+ options.apply_defaults timeout: @config.timeout,
3631
+ metadata: @config.metadata,
3643
3632
  retry_policy: @config.retry_policy
3644
3633
 
3645
- @analytics_admin_service_stub.call_rpc :search_change_history_events, request, options: options do |response, operation|
3646
- response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :search_change_history_events, request, response, operation, options
3634
+ @analytics_admin_service_stub.call_rpc :get_measurement_protocol_secret, request, options: options do |response, operation|
3647
3635
  yield response, operation if block_given?
3648
3636
  return response
3649
3637
  end
@@ -3652,116 +3640,2602 @@ module Google
3652
3640
  end
3653
3641
 
3654
3642
  ##
3655
- # Configuration class for the AnalyticsAdminService API.
3656
- #
3657
- # This class represents the configuration for AnalyticsAdminService,
3658
- # providing control over timeouts, retry behavior, logging, transport
3659
- # parameters, and other low-level controls. Certain parameters can also be
3660
- # applied individually to specific RPCs. See
3661
- # {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
3662
- # for a list of RPCs that can be configured independently.
3643
+ # Returns child MeasurementProtocolSecrets under the specified parent
3644
+ # Property.
3663
3645
  #
3664
- # Configuration can be applied globally to all clients, or to a single client
3665
- # on construction.
3646
+ # @overload list_measurement_protocol_secrets(request, options = nil)
3647
+ # Pass arguments to `list_measurement_protocol_secrets` via a request object, either of type
3648
+ # {::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest} or an equivalent Hash.
3666
3649
  #
3667
- # # Examples
3650
+ # @param request [::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest, ::Hash]
3651
+ # A request object representing the call parameters. Required. To specify no
3652
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3653
+ # @param options [::Gapic::CallOptions, ::Hash]
3654
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3668
3655
  #
3669
- # To modify the global config, setting the timeout for get_account
3670
- # to 20 seconds, and all remaining timeouts to 10 seconds:
3656
+ # @overload list_measurement_protocol_secrets(parent: nil, page_size: nil, page_token: nil)
3657
+ # Pass arguments to `list_measurement_protocol_secrets` via keyword arguments. Note that at
3658
+ # least one keyword argument is required. To specify no parameters, or to keep all
3659
+ # the default parameter values, pass an empty Hash as a request object (see above).
3671
3660
  #
3672
- # ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
3673
- # config.timeout = 10.0
3674
- # config.rpcs.get_account.timeout = 20.0
3675
- # end
3661
+ # @param parent [::String]
3662
+ # Required. The resource name of the parent stream.
3663
+ # Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
3664
+ # may be a parent.
3665
+ # Format:
3666
+ # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets
3667
+ # @param page_size [::Integer]
3668
+ # The maximum number of resources to return.
3669
+ # If unspecified, at most 10 resources will be returned.
3670
+ # The maximum value is 10. Higher values will be coerced to the maximum.
3671
+ # @param page_token [::String]
3672
+ # A page token, received from a previous `ListMeasurementProtocolSecrets`
3673
+ # call. Provide this to retrieve the subsequent page. When paginating, all
3674
+ # other parameters provided to `ListMeasurementProtocolSecrets` must match
3675
+ # the call that provided the page token.
3676
3676
  #
3677
- # To apply the above configuration only to a new client:
3677
+ # @yield [response, operation] Access the result along with the RPC operation
3678
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
3679
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3678
3680
  #
3679
- # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
3680
- # config.timeout = 10.0
3681
- # config.rpcs.get_account.timeout = 20.0
3682
- # end
3681
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>]
3683
3682
  #
3684
- # @!attribute [rw] endpoint
3685
- # The hostname or hostname:port of the service endpoint.
3686
- # Defaults to `"analyticsadmin.googleapis.com"`.
3687
- # @return [::String]
3688
- # @!attribute [rw] credentials
3689
- # Credentials to send with calls. You may provide any of the following types:
3690
- # * (`String`) The path to a service account key file in JSON format
3691
- # * (`Hash`) A service account key as a Hash
3692
- # * (`Google::Auth::Credentials`) A googleauth credentials object
3693
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
3694
- # * (`Signet::OAuth2::Client`) A signet oauth2 client object
3695
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
3696
- # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
3697
- # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
3698
- # * (`nil`) indicating no credentials
3699
- # @return [::Object]
3700
- # @!attribute [rw] scope
3701
- # The OAuth scopes
3702
- # @return [::Array<::String>]
3703
- # @!attribute [rw] lib_name
3704
- # The library name as recorded in instrumentation and logging
3705
- # @return [::String]
3706
- # @!attribute [rw] lib_version
3707
- # The library version as recorded in instrumentation and logging
3708
- # @return [::String]
3709
- # @!attribute [rw] channel_args
3710
- # Extra parameters passed to the gRPC channel. Note: this is ignored if a
3711
- # `GRPC::Core::Channel` object is provided as the credential.
3712
- # @return [::Hash]
3713
- # @!attribute [rw] interceptors
3714
- # An array of interceptors that are run before calls are executed.
3715
- # @return [::Array<::GRPC::ClientInterceptor>]
3716
- # @!attribute [rw] timeout
3717
- # The call timeout in seconds.
3718
- # @return [::Numeric]
3719
- # @!attribute [rw] metadata
3720
- # Additional gRPC headers to be sent with the call.
3721
- # @return [::Hash{::Symbol=>::String}]
3722
- # @!attribute [rw] retry_policy
3723
- # The retry policy. The value is a hash with the following keys:
3724
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
3725
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
3726
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
3727
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
3728
- # trigger a retry.
3729
- # @return [::Hash]
3730
- # @!attribute [rw] quota_project
3731
- # A separate project against which to charge quota.
3732
- # @return [::String]
3683
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3733
3684
  #
3734
- class Configuration
3735
- extend ::Gapic::Config
3685
+ def list_measurement_protocol_secrets request, options = nil
3686
+ raise ::ArgumentError, "request must be provided" if request.nil?
3736
3687
 
3737
- config_attr :endpoint, "analyticsadmin.googleapis.com", ::String
3738
- config_attr :credentials, nil do |value|
3739
- allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3740
- allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
3741
- allowed.any? { |klass| klass === value }
3742
- end
3743
- config_attr :scope, nil, ::String, ::Array, nil
3744
- config_attr :lib_name, nil, ::String, nil
3745
- config_attr :lib_version, nil, ::String, nil
3746
- config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
3747
- config_attr :interceptors, nil, ::Array, nil
3748
- config_attr :timeout, nil, ::Numeric, nil
3749
- config_attr :metadata, nil, ::Hash, nil
3750
- config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3751
- config_attr :quota_project, nil, ::String, nil
3688
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest
3752
3689
 
3753
- # @private
3754
- def initialize parent_config = nil
3755
- @parent_config = parent_config unless parent_config.nil?
3690
+ # Converts hash and nil to an options object
3691
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3756
3692
 
3757
- yield self if block_given?
3758
- end
3693
+ # Customize the options with defaults
3694
+ metadata = @config.rpcs.list_measurement_protocol_secrets.metadata.to_h
3759
3695
 
3760
- ##
3761
- # Configurations for individual RPCs
3762
- # @return [Rpcs]
3763
- #
3764
- def rpcs
3696
+ # Set x-goog-api-client and x-goog-user-project headers
3697
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3698
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3699
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
3700
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3701
+
3702
+ header_params = {
3703
+ "parent" => request.parent
3704
+ }
3705
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3706
+ metadata[:"x-goog-request-params"] ||= request_params_header
3707
+
3708
+ options.apply_defaults timeout: @config.rpcs.list_measurement_protocol_secrets.timeout,
3709
+ metadata: metadata,
3710
+ retry_policy: @config.rpcs.list_measurement_protocol_secrets.retry_policy
3711
+
3712
+ options.apply_defaults timeout: @config.timeout,
3713
+ metadata: @config.metadata,
3714
+ retry_policy: @config.retry_policy
3715
+
3716
+ @analytics_admin_service_stub.call_rpc :list_measurement_protocol_secrets, request, options: options do |response, operation|
3717
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_measurement_protocol_secrets, request, response, operation, options
3718
+ yield response, operation if block_given?
3719
+ return response
3720
+ end
3721
+ rescue ::GRPC::BadStatus => e
3722
+ raise ::Google::Cloud::Error.from_error(e)
3723
+ end
3724
+
3725
+ ##
3726
+ # Creates a measurement protocol secret.
3727
+ #
3728
+ # @overload create_measurement_protocol_secret(request, options = nil)
3729
+ # Pass arguments to `create_measurement_protocol_secret` via a request object, either of type
3730
+ # {::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest} or an equivalent Hash.
3731
+ #
3732
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest, ::Hash]
3733
+ # A request object representing the call parameters. Required. To specify no
3734
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3735
+ # @param options [::Gapic::CallOptions, ::Hash]
3736
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3737
+ #
3738
+ # @overload create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil)
3739
+ # Pass arguments to `create_measurement_protocol_secret` via keyword arguments. Note that at
3740
+ # least one keyword argument is required. To specify no parameters, or to keep all
3741
+ # the default parameter values, pass an empty Hash as a request object (see above).
3742
+ #
3743
+ # @param parent [::String]
3744
+ # Required. The parent resource where this secret will be created.
3745
+ # Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
3746
+ # may be a parent.
3747
+ # Format: properties/\\{property}/webDataStreams/\\{webDataStream}
3748
+ # @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
3749
+ # Required. The measurement protocol secret to create.
3750
+ #
3751
+ # @yield [response, operation] Access the result along with the RPC operation
3752
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
3753
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3754
+ #
3755
+ # @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
3756
+ #
3757
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3758
+ #
3759
+ def create_measurement_protocol_secret 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::CreateMeasurementProtocolSecretRequest
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.create_measurement_protocol_secret.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.create_measurement_protocol_secret.timeout,
3783
+ metadata: metadata,
3784
+ retry_policy: @config.rpcs.create_measurement_protocol_secret.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 :create_measurement_protocol_secret, request, options: options do |response, operation|
3791
+ yield response, operation if block_given?
3792
+ return response
3793
+ end
3794
+ rescue ::GRPC::BadStatus => e
3795
+ raise ::Google::Cloud::Error.from_error(e)
3796
+ end
3797
+
3798
+ ##
3799
+ # Deletes target MeasurementProtocolSecret.
3800
+ #
3801
+ # @overload delete_measurement_protocol_secret(request, options = nil)
3802
+ # Pass arguments to `delete_measurement_protocol_secret` via a request object, either of type
3803
+ # {::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest} or an equivalent Hash.
3804
+ #
3805
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest, ::Hash]
3806
+ # A request object representing the call parameters. Required. To specify no
3807
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3808
+ # @param options [::Gapic::CallOptions, ::Hash]
3809
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3810
+ #
3811
+ # @overload delete_measurement_protocol_secret(name: nil)
3812
+ # Pass arguments to `delete_measurement_protocol_secret` via keyword arguments. Note that at
3813
+ # least one keyword argument is required. To specify no parameters, or to keep all
3814
+ # the default parameter values, pass an empty Hash as a request object (see above).
3815
+ #
3816
+ # @param name [::String]
3817
+ # Required. The name of the MeasurementProtocolSecret to delete.
3818
+ # Format:
3819
+ # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
3820
+ # Note: Any type of stream (WebDataStream, IosAppDataStream,
3821
+ # AndroidAppDataStream) may be a parent.
3822
+ #
3823
+ # @yield [response, operation] Access the result along with the RPC operation
3824
+ # @yieldparam response [::Google::Protobuf::Empty]
3825
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3826
+ #
3827
+ # @return [::Google::Protobuf::Empty]
3828
+ #
3829
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3830
+ #
3831
+ def delete_measurement_protocol_secret request, options = nil
3832
+ raise ::ArgumentError, "request must be provided" if request.nil?
3833
+
3834
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest
3835
+
3836
+ # Converts hash and nil to an options object
3837
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3838
+
3839
+ # Customize the options with defaults
3840
+ metadata = @config.rpcs.delete_measurement_protocol_secret.metadata.to_h
3841
+
3842
+ # Set x-goog-api-client and x-goog-user-project headers
3843
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3844
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3845
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
3846
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3847
+
3848
+ header_params = {
3849
+ "name" => request.name
3850
+ }
3851
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3852
+ metadata[:"x-goog-request-params"] ||= request_params_header
3853
+
3854
+ options.apply_defaults timeout: @config.rpcs.delete_measurement_protocol_secret.timeout,
3855
+ metadata: metadata,
3856
+ retry_policy: @config.rpcs.delete_measurement_protocol_secret.retry_policy
3857
+
3858
+ options.apply_defaults timeout: @config.timeout,
3859
+ metadata: @config.metadata,
3860
+ retry_policy: @config.retry_policy
3861
+
3862
+ @analytics_admin_service_stub.call_rpc :delete_measurement_protocol_secret, request, options: options do |response, operation|
3863
+ yield response, operation if block_given?
3864
+ return response
3865
+ end
3866
+ rescue ::GRPC::BadStatus => e
3867
+ raise ::Google::Cloud::Error.from_error(e)
3868
+ end
3869
+
3870
+ ##
3871
+ # Updates a measurement protocol secret.
3872
+ #
3873
+ # @overload update_measurement_protocol_secret(request, options = nil)
3874
+ # Pass arguments to `update_measurement_protocol_secret` via a request object, either of type
3875
+ # {::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest} or an equivalent Hash.
3876
+ #
3877
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest, ::Hash]
3878
+ # A request object representing the call parameters. Required. To specify no
3879
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3880
+ # @param options [::Gapic::CallOptions, ::Hash]
3881
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3882
+ #
3883
+ # @overload update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil)
3884
+ # Pass arguments to `update_measurement_protocol_secret` via keyword arguments. Note that at
3885
+ # least one keyword argument is required. To specify no parameters, or to keep all
3886
+ # the default parameter values, pass an empty Hash as a request object (see above).
3887
+ #
3888
+ # @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
3889
+ # Required. The measurement protocol secret to update.
3890
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3891
+ # The list of fields to be updated. Omitted fields will not be updated.
3892
+ #
3893
+ # @yield [response, operation] Access the result along with the RPC operation
3894
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
3895
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3896
+ #
3897
+ # @return [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
3898
+ #
3899
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3900
+ #
3901
+ def update_measurement_protocol_secret request, options = nil
3902
+ raise ::ArgumentError, "request must be provided" if request.nil?
3903
+
3904
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest
3905
+
3906
+ # Converts hash and nil to an options object
3907
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3908
+
3909
+ # Customize the options with defaults
3910
+ metadata = @config.rpcs.update_measurement_protocol_secret.metadata.to_h
3911
+
3912
+ # Set x-goog-api-client and x-goog-user-project headers
3913
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3914
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3915
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
3916
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3917
+
3918
+ header_params = {
3919
+ "measurement_protocol_secret.name" => request.measurement_protocol_secret.name
3920
+ }
3921
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3922
+ metadata[:"x-goog-request-params"] ||= request_params_header
3923
+
3924
+ options.apply_defaults timeout: @config.rpcs.update_measurement_protocol_secret.timeout,
3925
+ metadata: metadata,
3926
+ retry_policy: @config.rpcs.update_measurement_protocol_secret.retry_policy
3927
+
3928
+ options.apply_defaults timeout: @config.timeout,
3929
+ metadata: @config.metadata,
3930
+ retry_policy: @config.retry_policy
3931
+
3932
+ @analytics_admin_service_stub.call_rpc :update_measurement_protocol_secret, request, options: options do |response, operation|
3933
+ yield response, operation if block_given?
3934
+ return response
3935
+ end
3936
+ rescue ::GRPC::BadStatus => e
3937
+ raise ::Google::Cloud::Error.from_error(e)
3938
+ end
3939
+
3940
+ ##
3941
+ # Searches through all changes to an account or its children given the
3942
+ # specified set of filters.
3943
+ #
3944
+ # @overload search_change_history_events(request, options = nil)
3945
+ # Pass arguments to `search_change_history_events` via a request object, either of type
3946
+ # {::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest} or an equivalent Hash.
3947
+ #
3948
+ # @param request [::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Hash]
3949
+ # A request object representing the call parameters. Required. To specify no
3950
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3951
+ # @param options [::Gapic::CallOptions, ::Hash]
3952
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3953
+ #
3954
+ # @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)
3955
+ # Pass arguments to `search_change_history_events` via keyword arguments. Note that at
3956
+ # least one keyword argument is required. To specify no parameters, or to keep all
3957
+ # the default parameter values, pass an empty Hash as a request object (see above).
3958
+ #
3959
+ # @param account [::String]
3960
+ # Required. The account resource for which to return change history resources.
3961
+ # @param property [::String]
3962
+ # Optional. Resource name for a child property. If set, only return changes
3963
+ # made to this property or its child resources.
3964
+ # @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
3965
+ # Optional. If set, only return changes if they are for a resource that matches at
3966
+ # least one of these types.
3967
+ # @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
3968
+ # Optional. If set, only return changes that match one or more of these types of
3969
+ # actions.
3970
+ # @param actor_email [::Array<::String>]
3971
+ # Optional. If set, only return changes if they are made by a user in this list.
3972
+ # @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
3973
+ # Optional. If set, only return changes made after this time (inclusive).
3974
+ # @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
3975
+ # Optional. If set, only return changes made before this time (inclusive).
3976
+ # @param page_size [::Integer]
3977
+ # Optional. The maximum number of ChangeHistoryEvent items to return.
3978
+ # The service may return fewer than this value, even if there are additional
3979
+ # pages. If unspecified, at most 50 items will be returned.
3980
+ # The maximum value is 200 (higher values will be coerced to the maximum).
3981
+ # @param page_token [::String]
3982
+ # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
3983
+ # Provide this to retrieve the subsequent page. When paginating, all other
3984
+ # parameters provided to `SearchChangeHistoryEvents` must match the call that
3985
+ # provided the page token.
3986
+ #
3987
+ # @yield [response, operation] Access the result along with the RPC operation
3988
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
3989
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3990
+ #
3991
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
3992
+ #
3993
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3994
+ #
3995
+ def search_change_history_events request, options = nil
3996
+ raise ::ArgumentError, "request must be provided" if request.nil?
3997
+
3998
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest
3999
+
4000
+ # Converts hash and nil to an options object
4001
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4002
+
4003
+ # Customize the options with defaults
4004
+ metadata = @config.rpcs.search_change_history_events.metadata.to_h
4005
+
4006
+ # Set x-goog-api-client and x-goog-user-project headers
4007
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4008
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4009
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4010
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4011
+
4012
+ header_params = {
4013
+ "account" => request.account
4014
+ }
4015
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4016
+ metadata[:"x-goog-request-params"] ||= request_params_header
4017
+
4018
+ options.apply_defaults timeout: @config.rpcs.search_change_history_events.timeout,
4019
+ metadata: metadata,
4020
+ retry_policy: @config.rpcs.search_change_history_events.retry_policy
4021
+
4022
+ options.apply_defaults timeout: @config.timeout,
4023
+ metadata: @config.metadata,
4024
+ retry_policy: @config.retry_policy
4025
+
4026
+ @analytics_admin_service_stub.call_rpc :search_change_history_events, request, options: options do |response, operation|
4027
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :search_change_history_events, request, response, operation, options
4028
+ yield response, operation if block_given?
4029
+ return response
4030
+ end
4031
+ rescue ::GRPC::BadStatus => e
4032
+ raise ::Google::Cloud::Error.from_error(e)
4033
+ end
4034
+
4035
+ ##
4036
+ # Lookup for Google Signals settings for a property.
4037
+ #
4038
+ # @overload get_google_signals_settings(request, options = nil)
4039
+ # Pass arguments to `get_google_signals_settings` via a request object, either of type
4040
+ # {::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest} or an equivalent Hash.
4041
+ #
4042
+ # @param request [::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest, ::Hash]
4043
+ # A request object representing the call parameters. Required. To specify no
4044
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4045
+ # @param options [::Gapic::CallOptions, ::Hash]
4046
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4047
+ #
4048
+ # @overload get_google_signals_settings(name: nil)
4049
+ # Pass arguments to `get_google_signals_settings` via keyword arguments. Note that at
4050
+ # least one keyword argument is required. To specify no parameters, or to keep all
4051
+ # the default parameter values, pass an empty Hash as a request object (see above).
4052
+ #
4053
+ # @param name [::String]
4054
+ # Required. The name of the google signals settings to retrieve.
4055
+ # Format: properties/\\{property}/googleSignalsSettings
4056
+ #
4057
+ # @yield [response, operation] Access the result along with the RPC operation
4058
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
4059
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4060
+ #
4061
+ # @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
4062
+ #
4063
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4064
+ #
4065
+ def get_google_signals_settings request, options = nil
4066
+ raise ::ArgumentError, "request must be provided" if request.nil?
4067
+
4068
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest
4069
+
4070
+ # Converts hash and nil to an options object
4071
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4072
+
4073
+ # Customize the options with defaults
4074
+ metadata = @config.rpcs.get_google_signals_settings.metadata.to_h
4075
+
4076
+ # Set x-goog-api-client and x-goog-user-project headers
4077
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4078
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4079
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4080
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4081
+
4082
+ header_params = {
4083
+ "name" => request.name
4084
+ }
4085
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4086
+ metadata[:"x-goog-request-params"] ||= request_params_header
4087
+
4088
+ options.apply_defaults timeout: @config.rpcs.get_google_signals_settings.timeout,
4089
+ metadata: metadata,
4090
+ retry_policy: @config.rpcs.get_google_signals_settings.retry_policy
4091
+
4092
+ options.apply_defaults timeout: @config.timeout,
4093
+ metadata: @config.metadata,
4094
+ retry_policy: @config.retry_policy
4095
+
4096
+ @analytics_admin_service_stub.call_rpc :get_google_signals_settings, request, options: options do |response, operation|
4097
+ yield response, operation if block_given?
4098
+ return response
4099
+ end
4100
+ rescue ::GRPC::BadStatus => e
4101
+ raise ::Google::Cloud::Error.from_error(e)
4102
+ end
4103
+
4104
+ ##
4105
+ # Updates Google Signals settings for a property.
4106
+ #
4107
+ # @overload update_google_signals_settings(request, options = nil)
4108
+ # Pass arguments to `update_google_signals_settings` via a request object, either of type
4109
+ # {::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest} or an equivalent Hash.
4110
+ #
4111
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest, ::Hash]
4112
+ # A request object representing the call parameters. Required. To specify no
4113
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4114
+ # @param options [::Gapic::CallOptions, ::Hash]
4115
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4116
+ #
4117
+ # @overload update_google_signals_settings(google_signals_settings: nil, update_mask: nil)
4118
+ # Pass arguments to `update_google_signals_settings` via keyword arguments. Note that at
4119
+ # least one keyword argument is required. To specify no parameters, or to keep all
4120
+ # the default parameter values, pass an empty Hash as a request object (see above).
4121
+ #
4122
+ # @param google_signals_settings [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings, ::Hash]
4123
+ # Required. The settings to update.
4124
+ # The `name` field is used to identify the settings to be updated.
4125
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
4126
+ # Required. The list of fields to be updated. Field names must be in snake case
4127
+ # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
4128
+ # the entire entity, use one path with the string "*" to match all fields.
4129
+ #
4130
+ # @yield [response, operation] Access the result along with the RPC operation
4131
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
4132
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4133
+ #
4134
+ # @return [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
4135
+ #
4136
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4137
+ #
4138
+ def update_google_signals_settings request, options = nil
4139
+ raise ::ArgumentError, "request must be provided" if request.nil?
4140
+
4141
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest
4142
+
4143
+ # Converts hash and nil to an options object
4144
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4145
+
4146
+ # Customize the options with defaults
4147
+ metadata = @config.rpcs.update_google_signals_settings.metadata.to_h
4148
+
4149
+ # Set x-goog-api-client and x-goog-user-project headers
4150
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4151
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4152
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4153
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4154
+
4155
+ header_params = {
4156
+ "google_signals_settings.name" => request.google_signals_settings.name
4157
+ }
4158
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4159
+ metadata[:"x-goog-request-params"] ||= request_params_header
4160
+
4161
+ options.apply_defaults timeout: @config.rpcs.update_google_signals_settings.timeout,
4162
+ metadata: metadata,
4163
+ retry_policy: @config.rpcs.update_google_signals_settings.retry_policy
4164
+
4165
+ options.apply_defaults timeout: @config.timeout,
4166
+ metadata: @config.metadata,
4167
+ retry_policy: @config.retry_policy
4168
+
4169
+ @analytics_admin_service_stub.call_rpc :update_google_signals_settings, request, options: options do |response, operation|
4170
+ yield response, operation if block_given?
4171
+ return response
4172
+ end
4173
+ rescue ::GRPC::BadStatus => e
4174
+ raise ::Google::Cloud::Error.from_error(e)
4175
+ end
4176
+
4177
+ ##
4178
+ # Creates a conversion event with the specified attributes.
4179
+ #
4180
+ # @overload create_conversion_event(request, options = nil)
4181
+ # Pass arguments to `create_conversion_event` via a request object, either of type
4182
+ # {::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest} or an equivalent Hash.
4183
+ #
4184
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest, ::Hash]
4185
+ # A request object representing the call parameters. Required. To specify no
4186
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4187
+ # @param options [::Gapic::CallOptions, ::Hash]
4188
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4189
+ #
4190
+ # @overload create_conversion_event(conversion_event: nil, parent: nil)
4191
+ # Pass arguments to `create_conversion_event` via keyword arguments. Note that at
4192
+ # least one keyword argument is required. To specify no parameters, or to keep all
4193
+ # the default parameter values, pass an empty Hash as a request object (see above).
4194
+ #
4195
+ # @param conversion_event [::Google::Analytics::Admin::V1alpha::ConversionEvent, ::Hash]
4196
+ # Required. The conversion event to create.
4197
+ # @param parent [::String]
4198
+ # Required. The resource name of the parent property where this conversion event will
4199
+ # be created. Format: properties/123
4200
+ #
4201
+ # @yield [response, operation] Access the result along with the RPC operation
4202
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
4203
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4204
+ #
4205
+ # @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
4206
+ #
4207
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4208
+ #
4209
+ def create_conversion_event request, options = nil
4210
+ raise ::ArgumentError, "request must be provided" if request.nil?
4211
+
4212
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest
4213
+
4214
+ # Converts hash and nil to an options object
4215
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4216
+
4217
+ # Customize the options with defaults
4218
+ metadata = @config.rpcs.create_conversion_event.metadata.to_h
4219
+
4220
+ # Set x-goog-api-client and x-goog-user-project headers
4221
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4222
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4223
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4224
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4225
+
4226
+ header_params = {
4227
+ "parent" => request.parent
4228
+ }
4229
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4230
+ metadata[:"x-goog-request-params"] ||= request_params_header
4231
+
4232
+ options.apply_defaults timeout: @config.rpcs.create_conversion_event.timeout,
4233
+ metadata: metadata,
4234
+ retry_policy: @config.rpcs.create_conversion_event.retry_policy
4235
+
4236
+ options.apply_defaults timeout: @config.timeout,
4237
+ metadata: @config.metadata,
4238
+ retry_policy: @config.retry_policy
4239
+
4240
+ @analytics_admin_service_stub.call_rpc :create_conversion_event, request, options: options do |response, operation|
4241
+ yield response, operation if block_given?
4242
+ return response
4243
+ end
4244
+ rescue ::GRPC::BadStatus => e
4245
+ raise ::Google::Cloud::Error.from_error(e)
4246
+ end
4247
+
4248
+ ##
4249
+ # Retrieve a single conversion event.
4250
+ #
4251
+ # @overload get_conversion_event(request, options = nil)
4252
+ # Pass arguments to `get_conversion_event` via a request object, either of type
4253
+ # {::Google::Analytics::Admin::V1alpha::GetConversionEventRequest} or an equivalent Hash.
4254
+ #
4255
+ # @param request [::Google::Analytics::Admin::V1alpha::GetConversionEventRequest, ::Hash]
4256
+ # A request object representing the call parameters. Required. To specify no
4257
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4258
+ # @param options [::Gapic::CallOptions, ::Hash]
4259
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4260
+ #
4261
+ # @overload get_conversion_event(name: nil)
4262
+ # Pass arguments to `get_conversion_event` via keyword arguments. Note that at
4263
+ # least one keyword argument is required. To specify no parameters, or to keep all
4264
+ # the default parameter values, pass an empty Hash as a request object (see above).
4265
+ #
4266
+ # @param name [::String]
4267
+ # Required. The resource name of the conversion event to retrieve.
4268
+ # Format: properties/\\{property}/conversionEvents/\\{conversion_event}
4269
+ # Example: "properties/123/conversionEvents/456"
4270
+ #
4271
+ # @yield [response, operation] Access the result along with the RPC operation
4272
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
4273
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4274
+ #
4275
+ # @return [::Google::Analytics::Admin::V1alpha::ConversionEvent]
4276
+ #
4277
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4278
+ #
4279
+ def get_conversion_event request, options = nil
4280
+ raise ::ArgumentError, "request must be provided" if request.nil?
4281
+
4282
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetConversionEventRequest
4283
+
4284
+ # Converts hash and nil to an options object
4285
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4286
+
4287
+ # Customize the options with defaults
4288
+ metadata = @config.rpcs.get_conversion_event.metadata.to_h
4289
+
4290
+ # Set x-goog-api-client and x-goog-user-project headers
4291
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4292
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4293
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4294
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4295
+
4296
+ header_params = {
4297
+ "name" => request.name
4298
+ }
4299
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4300
+ metadata[:"x-goog-request-params"] ||= request_params_header
4301
+
4302
+ options.apply_defaults timeout: @config.rpcs.get_conversion_event.timeout,
4303
+ metadata: metadata,
4304
+ retry_policy: @config.rpcs.get_conversion_event.retry_policy
4305
+
4306
+ options.apply_defaults timeout: @config.timeout,
4307
+ metadata: @config.metadata,
4308
+ retry_policy: @config.retry_policy
4309
+
4310
+ @analytics_admin_service_stub.call_rpc :get_conversion_event, request, options: options do |response, operation|
4311
+ yield response, operation if block_given?
4312
+ return response
4313
+ end
4314
+ rescue ::GRPC::BadStatus => e
4315
+ raise ::Google::Cloud::Error.from_error(e)
4316
+ end
4317
+
4318
+ ##
4319
+ # Deletes a conversion event in a property.
4320
+ #
4321
+ # @overload delete_conversion_event(request, options = nil)
4322
+ # Pass arguments to `delete_conversion_event` via a request object, either of type
4323
+ # {::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest} or an equivalent Hash.
4324
+ #
4325
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest, ::Hash]
4326
+ # A request object representing the call parameters. Required. To specify no
4327
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4328
+ # @param options [::Gapic::CallOptions, ::Hash]
4329
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4330
+ #
4331
+ # @overload delete_conversion_event(name: nil)
4332
+ # Pass arguments to `delete_conversion_event` via keyword arguments. Note that at
4333
+ # least one keyword argument is required. To specify no parameters, or to keep all
4334
+ # the default parameter values, pass an empty Hash as a request object (see above).
4335
+ #
4336
+ # @param name [::String]
4337
+ # Required. The resource name of the conversion event to delete.
4338
+ # Format: properties/\\{property}/conversionEvents/\\{conversion_event}
4339
+ # Example: "properties/123/conversionEvents/456"
4340
+ #
4341
+ # @yield [response, operation] Access the result along with the RPC operation
4342
+ # @yieldparam response [::Google::Protobuf::Empty]
4343
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4344
+ #
4345
+ # @return [::Google::Protobuf::Empty]
4346
+ #
4347
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4348
+ #
4349
+ def delete_conversion_event request, options = nil
4350
+ raise ::ArgumentError, "request must be provided" if request.nil?
4351
+
4352
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest
4353
+
4354
+ # Converts hash and nil to an options object
4355
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4356
+
4357
+ # Customize the options with defaults
4358
+ metadata = @config.rpcs.delete_conversion_event.metadata.to_h
4359
+
4360
+ # Set x-goog-api-client and x-goog-user-project headers
4361
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4362
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4363
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4364
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4365
+
4366
+ header_params = {
4367
+ "name" => request.name
4368
+ }
4369
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4370
+ metadata[:"x-goog-request-params"] ||= request_params_header
4371
+
4372
+ options.apply_defaults timeout: @config.rpcs.delete_conversion_event.timeout,
4373
+ metadata: metadata,
4374
+ retry_policy: @config.rpcs.delete_conversion_event.retry_policy
4375
+
4376
+ options.apply_defaults timeout: @config.timeout,
4377
+ metadata: @config.metadata,
4378
+ retry_policy: @config.retry_policy
4379
+
4380
+ @analytics_admin_service_stub.call_rpc :delete_conversion_event, request, options: options do |response, operation|
4381
+ yield response, operation if block_given?
4382
+ return response
4383
+ end
4384
+ rescue ::GRPC::BadStatus => e
4385
+ raise ::Google::Cloud::Error.from_error(e)
4386
+ end
4387
+
4388
+ ##
4389
+ # Returns a list of conversion events in the specified parent property.
4390
+ #
4391
+ # Returns an empty list if no conversion events are found.
4392
+ #
4393
+ # @overload list_conversion_events(request, options = nil)
4394
+ # Pass arguments to `list_conversion_events` via a request object, either of type
4395
+ # {::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest} or an equivalent Hash.
4396
+ #
4397
+ # @param request [::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest, ::Hash]
4398
+ # A request object representing the call parameters. Required. To specify no
4399
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4400
+ # @param options [::Gapic::CallOptions, ::Hash]
4401
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4402
+ #
4403
+ # @overload list_conversion_events(parent: nil, page_size: nil, page_token: nil)
4404
+ # Pass arguments to `list_conversion_events` via keyword arguments. Note that at
4405
+ # least one keyword argument is required. To specify no parameters, or to keep all
4406
+ # the default parameter values, pass an empty Hash as a request object (see above).
4407
+ #
4408
+ # @param parent [::String]
4409
+ # Required. The resource name of the parent property.
4410
+ # Example: 'properties/123'
4411
+ # @param page_size [::Integer]
4412
+ # The maximum number of resources to return.
4413
+ # If unspecified, at most 50 resources will be returned.
4414
+ # The maximum value is 200; (higher values will be coerced to the maximum)
4415
+ # @param page_token [::String]
4416
+ # A page token, received from a previous `ListConversionEvents` call.
4417
+ # Provide this to retrieve the subsequent page.
4418
+ # When paginating, all other parameters provided to `ListConversionEvents`
4419
+ # must match the call that provided the page token.
4420
+ #
4421
+ # @yield [response, operation] Access the result along with the RPC operation
4422
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
4423
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4424
+ #
4425
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>]
4426
+ #
4427
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4428
+ #
4429
+ def list_conversion_events request, options = nil
4430
+ raise ::ArgumentError, "request must be provided" if request.nil?
4431
+
4432
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest
4433
+
4434
+ # Converts hash and nil to an options object
4435
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4436
+
4437
+ # Customize the options with defaults
4438
+ metadata = @config.rpcs.list_conversion_events.metadata.to_h
4439
+
4440
+ # Set x-goog-api-client and x-goog-user-project headers
4441
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4442
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4443
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4444
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4445
+
4446
+ header_params = {
4447
+ "parent" => request.parent
4448
+ }
4449
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4450
+ metadata[:"x-goog-request-params"] ||= request_params_header
4451
+
4452
+ options.apply_defaults timeout: @config.rpcs.list_conversion_events.timeout,
4453
+ metadata: metadata,
4454
+ retry_policy: @config.rpcs.list_conversion_events.retry_policy
4455
+
4456
+ options.apply_defaults timeout: @config.timeout,
4457
+ metadata: @config.metadata,
4458
+ retry_policy: @config.retry_policy
4459
+
4460
+ @analytics_admin_service_stub.call_rpc :list_conversion_events, request, options: options do |response, operation|
4461
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_conversion_events, request, response, operation, options
4462
+ yield response, operation if block_given?
4463
+ return response
4464
+ end
4465
+ rescue ::GRPC::BadStatus => e
4466
+ raise ::Google::Cloud::Error.from_error(e)
4467
+ end
4468
+
4469
+ ##
4470
+ # Look up a single DisplayVideo360AdvertiserLink
4471
+ #
4472
+ # @overload get_display_video360_advertiser_link(request, options = nil)
4473
+ # Pass arguments to `get_display_video360_advertiser_link` via a request object, either of type
4474
+ # {::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkRequest} or an equivalent Hash.
4475
+ #
4476
+ # @param request [::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkRequest, ::Hash]
4477
+ # A request object representing the call parameters. Required. To specify no
4478
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4479
+ # @param options [::Gapic::CallOptions, ::Hash]
4480
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4481
+ #
4482
+ # @overload get_display_video360_advertiser_link(name: nil)
4483
+ # Pass arguments to `get_display_video360_advertiser_link` via keyword arguments. Note that at
4484
+ # least one keyword argument is required. To specify no parameters, or to keep all
4485
+ # the default parameter values, pass an empty Hash as a request object (see above).
4486
+ #
4487
+ # @param name [::String]
4488
+ # Required. The name of the DisplayVideo360AdvertiserLink to get.
4489
+ # Example format: properties/1234/displayVideo360AdvertiserLink/5678
4490
+ #
4491
+ # @yield [response, operation] Access the result along with the RPC operation
4492
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
4493
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4494
+ #
4495
+ # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
4496
+ #
4497
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4498
+ #
4499
+ def get_display_video360_advertiser_link request, options = nil
4500
+ raise ::ArgumentError, "request must be provided" if request.nil?
4501
+
4502
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkRequest
4503
+
4504
+ # Converts hash and nil to an options object
4505
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4506
+
4507
+ # Customize the options with defaults
4508
+ metadata = @config.rpcs.get_display_video360_advertiser_link.metadata.to_h
4509
+
4510
+ # Set x-goog-api-client and x-goog-user-project headers
4511
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4512
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4513
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4514
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4515
+
4516
+ header_params = {
4517
+ "name" => request.name
4518
+ }
4519
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4520
+ metadata[:"x-goog-request-params"] ||= request_params_header
4521
+
4522
+ options.apply_defaults timeout: @config.rpcs.get_display_video360_advertiser_link.timeout,
4523
+ metadata: metadata,
4524
+ retry_policy: @config.rpcs.get_display_video360_advertiser_link.retry_policy
4525
+
4526
+ options.apply_defaults timeout: @config.timeout,
4527
+ metadata: @config.metadata,
4528
+ retry_policy: @config.retry_policy
4529
+
4530
+ @analytics_admin_service_stub.call_rpc :get_display_video360_advertiser_link, request, options: options do |response, operation|
4531
+ yield response, operation if block_given?
4532
+ return response
4533
+ end
4534
+ rescue ::GRPC::BadStatus => e
4535
+ raise ::Google::Cloud::Error.from_error(e)
4536
+ end
4537
+
4538
+ ##
4539
+ # Lists all DisplayVideo360AdvertiserLinks on a property.
4540
+ #
4541
+ # @overload list_display_video360_advertiser_links(request, options = nil)
4542
+ # Pass arguments to `list_display_video360_advertiser_links` via a request object, either of type
4543
+ # {::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinksRequest} or an equivalent Hash.
4544
+ #
4545
+ # @param request [::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinksRequest, ::Hash]
4546
+ # A request object representing the call parameters. Required. To specify no
4547
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4548
+ # @param options [::Gapic::CallOptions, ::Hash]
4549
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4550
+ #
4551
+ # @overload list_display_video360_advertiser_links(parent: nil, page_size: nil, page_token: nil)
4552
+ # Pass arguments to `list_display_video360_advertiser_links` via keyword arguments. Note that at
4553
+ # least one keyword argument is required. To specify no parameters, or to keep all
4554
+ # the default parameter values, pass an empty Hash as a request object (see above).
4555
+ #
4556
+ # @param parent [::String]
4557
+ # Required. Example format: properties/1234
4558
+ # @param page_size [::Integer]
4559
+ # The maximum number of resources to return.
4560
+ # If unspecified, at most 50 resources will be returned.
4561
+ # The maximum value is 200 (higher values will be coerced to the maximum).
4562
+ # @param page_token [::String]
4563
+ # A page token, received from a previous `ListDisplayVideo360AdvertiserLinks`
4564
+ # call. Provide this to retrieve the subsequent page.
4565
+ #
4566
+ # When paginating, all other parameters provided to
4567
+ # `ListDisplayVideo360AdvertiserLinks` must match the call that provided the
4568
+ # page token.
4569
+ #
4570
+ # @yield [response, operation] Access the result along with the RPC operation
4571
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>]
4572
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4573
+ #
4574
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>]
4575
+ #
4576
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4577
+ #
4578
+ def list_display_video360_advertiser_links request, options = nil
4579
+ raise ::ArgumentError, "request must be provided" if request.nil?
4580
+
4581
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinksRequest
4582
+
4583
+ # Converts hash and nil to an options object
4584
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4585
+
4586
+ # Customize the options with defaults
4587
+ metadata = @config.rpcs.list_display_video360_advertiser_links.metadata.to_h
4588
+
4589
+ # Set x-goog-api-client and x-goog-user-project headers
4590
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4591
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4592
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4593
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4594
+
4595
+ header_params = {
4596
+ "parent" => request.parent
4597
+ }
4598
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4599
+ metadata[:"x-goog-request-params"] ||= request_params_header
4600
+
4601
+ options.apply_defaults timeout: @config.rpcs.list_display_video360_advertiser_links.timeout,
4602
+ metadata: metadata,
4603
+ retry_policy: @config.rpcs.list_display_video360_advertiser_links.retry_policy
4604
+
4605
+ options.apply_defaults timeout: @config.timeout,
4606
+ metadata: @config.metadata,
4607
+ retry_policy: @config.retry_policy
4608
+
4609
+ @analytics_admin_service_stub.call_rpc :list_display_video360_advertiser_links, request, options: options do |response, operation|
4610
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_display_video360_advertiser_links, request, response, operation, options
4611
+ yield response, operation if block_given?
4612
+ return response
4613
+ end
4614
+ rescue ::GRPC::BadStatus => e
4615
+ raise ::Google::Cloud::Error.from_error(e)
4616
+ end
4617
+
4618
+ ##
4619
+ # Creates a DisplayVideo360AdvertiserLink.
4620
+ # This can only be utilized by users who have proper authorization both on
4621
+ # the Google Analytics property and on the Display & Video 360 advertiser.
4622
+ # Users who do not have access to the Display & Video 360 advertiser should
4623
+ # instead seek to create a DisplayVideo360LinkProposal.
4624
+ #
4625
+ # @overload create_display_video360_advertiser_link(request, options = nil)
4626
+ # Pass arguments to `create_display_video360_advertiser_link` via a request object, either of type
4627
+ # {::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkRequest} or an equivalent Hash.
4628
+ #
4629
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkRequest, ::Hash]
4630
+ # A request object representing the call parameters. Required. To specify no
4631
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4632
+ # @param options [::Gapic::CallOptions, ::Hash]
4633
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4634
+ #
4635
+ # @overload create_display_video360_advertiser_link(parent: nil, display_video_360_advertiser_link: nil)
4636
+ # Pass arguments to `create_display_video360_advertiser_link` via keyword arguments. Note that at
4637
+ # least one keyword argument is required. To specify no parameters, or to keep all
4638
+ # the default parameter values, pass an empty Hash as a request object (see above).
4639
+ #
4640
+ # @param parent [::String]
4641
+ # Required. Example format: properties/1234
4642
+ # @param display_video_360_advertiser_link [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink, ::Hash]
4643
+ # Required. The DisplayVideo360AdvertiserLink to create.
4644
+ #
4645
+ # @yield [response, operation] Access the result along with the RPC operation
4646
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
4647
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4648
+ #
4649
+ # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
4650
+ #
4651
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4652
+ #
4653
+ def create_display_video360_advertiser_link request, options = nil
4654
+ raise ::ArgumentError, "request must be provided" if request.nil?
4655
+
4656
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkRequest
4657
+
4658
+ # Converts hash and nil to an options object
4659
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4660
+
4661
+ # Customize the options with defaults
4662
+ metadata = @config.rpcs.create_display_video360_advertiser_link.metadata.to_h
4663
+
4664
+ # Set x-goog-api-client and x-goog-user-project headers
4665
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4666
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4667
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4668
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4669
+
4670
+ header_params = {
4671
+ "parent" => request.parent
4672
+ }
4673
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4674
+ metadata[:"x-goog-request-params"] ||= request_params_header
4675
+
4676
+ options.apply_defaults timeout: @config.rpcs.create_display_video360_advertiser_link.timeout,
4677
+ metadata: metadata,
4678
+ retry_policy: @config.rpcs.create_display_video360_advertiser_link.retry_policy
4679
+
4680
+ options.apply_defaults timeout: @config.timeout,
4681
+ metadata: @config.metadata,
4682
+ retry_policy: @config.retry_policy
4683
+
4684
+ @analytics_admin_service_stub.call_rpc :create_display_video360_advertiser_link, request, options: options do |response, operation|
4685
+ yield response, operation if block_given?
4686
+ return response
4687
+ end
4688
+ rescue ::GRPC::BadStatus => e
4689
+ raise ::Google::Cloud::Error.from_error(e)
4690
+ end
4691
+
4692
+ ##
4693
+ # Deletes a DisplayVideo360AdvertiserLink on a property.
4694
+ #
4695
+ # @overload delete_display_video360_advertiser_link(request, options = nil)
4696
+ # Pass arguments to `delete_display_video360_advertiser_link` via a request object, either of type
4697
+ # {::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkRequest} or an equivalent Hash.
4698
+ #
4699
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkRequest, ::Hash]
4700
+ # A request object representing the call parameters. Required. To specify no
4701
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4702
+ # @param options [::Gapic::CallOptions, ::Hash]
4703
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4704
+ #
4705
+ # @overload delete_display_video360_advertiser_link(name: nil)
4706
+ # Pass arguments to `delete_display_video360_advertiser_link` via keyword arguments. Note that at
4707
+ # least one keyword argument is required. To specify no parameters, or to keep all
4708
+ # the default parameter values, pass an empty Hash as a request object (see above).
4709
+ #
4710
+ # @param name [::String]
4711
+ # Required. The name of the DisplayVideo360AdvertiserLink to delete.
4712
+ # Example format: properties/1234/displayVideo360AdvertiserLinks/5678
4713
+ #
4714
+ # @yield [response, operation] Access the result along with the RPC operation
4715
+ # @yieldparam response [::Google::Protobuf::Empty]
4716
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4717
+ #
4718
+ # @return [::Google::Protobuf::Empty]
4719
+ #
4720
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4721
+ #
4722
+ def delete_display_video360_advertiser_link request, options = nil
4723
+ raise ::ArgumentError, "request must be provided" if request.nil?
4724
+
4725
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkRequest
4726
+
4727
+ # Converts hash and nil to an options object
4728
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4729
+
4730
+ # Customize the options with defaults
4731
+ metadata = @config.rpcs.delete_display_video360_advertiser_link.metadata.to_h
4732
+
4733
+ # Set x-goog-api-client and x-goog-user-project headers
4734
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4735
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4736
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4737
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4738
+
4739
+ header_params = {
4740
+ "name" => request.name
4741
+ }
4742
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4743
+ metadata[:"x-goog-request-params"] ||= request_params_header
4744
+
4745
+ options.apply_defaults timeout: @config.rpcs.delete_display_video360_advertiser_link.timeout,
4746
+ metadata: metadata,
4747
+ retry_policy: @config.rpcs.delete_display_video360_advertiser_link.retry_policy
4748
+
4749
+ options.apply_defaults timeout: @config.timeout,
4750
+ metadata: @config.metadata,
4751
+ retry_policy: @config.retry_policy
4752
+
4753
+ @analytics_admin_service_stub.call_rpc :delete_display_video360_advertiser_link, request, options: options do |response, operation|
4754
+ yield response, operation if block_given?
4755
+ return response
4756
+ end
4757
+ rescue ::GRPC::BadStatus => e
4758
+ raise ::Google::Cloud::Error.from_error(e)
4759
+ end
4760
+
4761
+ ##
4762
+ # Updates a DisplayVideo360AdvertiserLink on a property.
4763
+ #
4764
+ # @overload update_display_video360_advertiser_link(request, options = nil)
4765
+ # Pass arguments to `update_display_video360_advertiser_link` via a request object, either of type
4766
+ # {::Google::Analytics::Admin::V1alpha::UpdateDisplayVideo360AdvertiserLinkRequest} or an equivalent Hash.
4767
+ #
4768
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateDisplayVideo360AdvertiserLinkRequest, ::Hash]
4769
+ # A request object representing the call parameters. Required. To specify no
4770
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4771
+ # @param options [::Gapic::CallOptions, ::Hash]
4772
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4773
+ #
4774
+ # @overload update_display_video360_advertiser_link(display_video_360_advertiser_link: nil, update_mask: nil)
4775
+ # Pass arguments to `update_display_video360_advertiser_link` via keyword arguments. Note that at
4776
+ # least one keyword argument is required. To specify no parameters, or to keep all
4777
+ # the default parameter values, pass an empty Hash as a request object (see above).
4778
+ #
4779
+ # @param display_video_360_advertiser_link [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink, ::Hash]
4780
+ # The DisplayVideo360AdvertiserLink to update
4781
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
4782
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
4783
+ # To replace the entire entity, use one path with the string "*" to match
4784
+ # all fields.
4785
+ #
4786
+ # @yield [response, operation] Access the result along with the RPC operation
4787
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
4788
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4789
+ #
4790
+ # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
4791
+ #
4792
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4793
+ #
4794
+ def update_display_video360_advertiser_link 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::UpdateDisplayVideo360AdvertiserLinkRequest
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.update_display_video360_advertiser_link.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
+ "display_video_360_advertiser_link.name" => request.display_video_360_advertiser_link.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.update_display_video360_advertiser_link.timeout,
4818
+ metadata: metadata,
4819
+ retry_policy: @config.rpcs.update_display_video360_advertiser_link.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 :update_display_video360_advertiser_link, 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 DisplayVideo360AdvertiserLinkProposal.
4835
+ #
4836
+ # @overload get_display_video360_advertiser_link_proposal(request, options = nil)
4837
+ # Pass arguments to `get_display_video360_advertiser_link_proposal` via a request object, either of type
4838
+ # {::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkProposalRequest} or an equivalent Hash.
4839
+ #
4840
+ # @param request [::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkProposalRequest, ::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_display_video360_advertiser_link_proposal(name: nil)
4847
+ # Pass arguments to `get_display_video360_advertiser_link_proposal` 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 DisplayVideo360AdvertiserLinkProposal to get.
4853
+ # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
4854
+ #
4855
+ # @yield [response, operation] Access the result along with the RPC operation
4856
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
4857
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4858
+ #
4859
+ # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
4860
+ #
4861
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4862
+ #
4863
+ def get_display_video360_advertiser_link_proposal 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::GetDisplayVideo360AdvertiserLinkProposalRequest
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_display_video360_advertiser_link_proposal.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_display_video360_advertiser_link_proposal.timeout,
4887
+ metadata: metadata,
4888
+ retry_policy: @config.rpcs.get_display_video360_advertiser_link_proposal.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_display_video360_advertiser_link_proposal, 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
+ # Lists DisplayVideo360AdvertiserLinkProposals on a property.
4904
+ #
4905
+ # @overload list_display_video360_advertiser_link_proposals(request, options = nil)
4906
+ # Pass arguments to `list_display_video360_advertiser_link_proposals` via a request object, either of type
4907
+ # {::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinkProposalsRequest} or an equivalent Hash.
4908
+ #
4909
+ # @param request [::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinkProposalsRequest, ::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 list_display_video360_advertiser_link_proposals(parent: nil, page_size: nil, page_token: nil)
4916
+ # Pass arguments to `list_display_video360_advertiser_link_proposals` 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 page_size [::Integer]
4923
+ # The maximum number of resources to return.
4924
+ # If unspecified, at most 50 resources will be returned.
4925
+ # The maximum value is 200 (higher values will be coerced to the maximum).
4926
+ # @param page_token [::String]
4927
+ # A page token, received from a previous
4928
+ # `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve
4929
+ # the subsequent page.
4930
+ #
4931
+ # When paginating, all other parameters provided to
4932
+ # `ListDisplayVideo360AdvertiserLinkProposals` must match the call that
4933
+ # provided the page token.
4934
+ #
4935
+ # @yield [response, operation] Access the result along with the RPC operation
4936
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>]
4937
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4938
+ #
4939
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>]
4940
+ #
4941
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
4942
+ #
4943
+ def list_display_video360_advertiser_link_proposals request, options = nil
4944
+ raise ::ArgumentError, "request must be provided" if request.nil?
4945
+
4946
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinkProposalsRequest
4947
+
4948
+ # Converts hash and nil to an options object
4949
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4950
+
4951
+ # Customize the options with defaults
4952
+ metadata = @config.rpcs.list_display_video360_advertiser_link_proposals.metadata.to_h
4953
+
4954
+ # Set x-goog-api-client and x-goog-user-project headers
4955
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4956
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4957
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
4958
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4959
+
4960
+ header_params = {
4961
+ "parent" => request.parent
4962
+ }
4963
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
4964
+ metadata[:"x-goog-request-params"] ||= request_params_header
4965
+
4966
+ options.apply_defaults timeout: @config.rpcs.list_display_video360_advertiser_link_proposals.timeout,
4967
+ metadata: metadata,
4968
+ retry_policy: @config.rpcs.list_display_video360_advertiser_link_proposals.retry_policy
4969
+
4970
+ options.apply_defaults timeout: @config.timeout,
4971
+ metadata: @config.metadata,
4972
+ retry_policy: @config.retry_policy
4973
+
4974
+ @analytics_admin_service_stub.call_rpc :list_display_video360_advertiser_link_proposals, request, options: options do |response, operation|
4975
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_display_video360_advertiser_link_proposals, request, response, operation, options
4976
+ yield response, operation if block_given?
4977
+ return response
4978
+ end
4979
+ rescue ::GRPC::BadStatus => e
4980
+ raise ::Google::Cloud::Error.from_error(e)
4981
+ end
4982
+
4983
+ ##
4984
+ # Creates a DisplayVideo360AdvertiserLinkProposal.
4985
+ #
4986
+ # @overload create_display_video360_advertiser_link_proposal(request, options = nil)
4987
+ # Pass arguments to `create_display_video360_advertiser_link_proposal` via a request object, either of type
4988
+ # {::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkProposalRequest} or an equivalent Hash.
4989
+ #
4990
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkProposalRequest, ::Hash]
4991
+ # A request object representing the call parameters. Required. To specify no
4992
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4993
+ # @param options [::Gapic::CallOptions, ::Hash]
4994
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4995
+ #
4996
+ # @overload create_display_video360_advertiser_link_proposal(parent: nil, display_video_360_advertiser_link_proposal: nil)
4997
+ # Pass arguments to `create_display_video360_advertiser_link_proposal` via keyword arguments. Note that at
4998
+ # least one keyword argument is required. To specify no parameters, or to keep all
4999
+ # the default parameter values, pass an empty Hash as a request object (see above).
5000
+ #
5001
+ # @param parent [::String]
5002
+ # Required. Example format: properties/1234
5003
+ # @param display_video_360_advertiser_link_proposal [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal, ::Hash]
5004
+ # Required. The DisplayVideo360AdvertiserLinkProposal to create.
5005
+ #
5006
+ # @yield [response, operation] Access the result along with the RPC operation
5007
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
5008
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5009
+ #
5010
+ # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
5011
+ #
5012
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5013
+ #
5014
+ def create_display_video360_advertiser_link_proposal request, options = nil
5015
+ raise ::ArgumentError, "request must be provided" if request.nil?
5016
+
5017
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkProposalRequest
5018
+
5019
+ # Converts hash and nil to an options object
5020
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5021
+
5022
+ # Customize the options with defaults
5023
+ metadata = @config.rpcs.create_display_video360_advertiser_link_proposal.metadata.to_h
5024
+
5025
+ # Set x-goog-api-client and x-goog-user-project headers
5026
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5027
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5028
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5029
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5030
+
5031
+ header_params = {
5032
+ "parent" => request.parent
5033
+ }
5034
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5035
+ metadata[:"x-goog-request-params"] ||= request_params_header
5036
+
5037
+ options.apply_defaults timeout: @config.rpcs.create_display_video360_advertiser_link_proposal.timeout,
5038
+ metadata: metadata,
5039
+ retry_policy: @config.rpcs.create_display_video360_advertiser_link_proposal.retry_policy
5040
+
5041
+ options.apply_defaults timeout: @config.timeout,
5042
+ metadata: @config.metadata,
5043
+ retry_policy: @config.retry_policy
5044
+
5045
+ @analytics_admin_service_stub.call_rpc :create_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
5046
+ yield response, operation if block_given?
5047
+ return response
5048
+ end
5049
+ rescue ::GRPC::BadStatus => e
5050
+ raise ::Google::Cloud::Error.from_error(e)
5051
+ end
5052
+
5053
+ ##
5054
+ # Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
5055
+ # This can only be used on cancelled proposals.
5056
+ #
5057
+ # @overload delete_display_video360_advertiser_link_proposal(request, options = nil)
5058
+ # Pass arguments to `delete_display_video360_advertiser_link_proposal` via a request object, either of type
5059
+ # {::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkProposalRequest} or an equivalent Hash.
5060
+ #
5061
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkProposalRequest, ::Hash]
5062
+ # A request object representing the call parameters. Required. To specify no
5063
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5064
+ # @param options [::Gapic::CallOptions, ::Hash]
5065
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5066
+ #
5067
+ # @overload delete_display_video360_advertiser_link_proposal(name: nil)
5068
+ # Pass arguments to `delete_display_video360_advertiser_link_proposal` via keyword arguments. Note that at
5069
+ # least one keyword argument is required. To specify no parameters, or to keep all
5070
+ # the default parameter values, pass an empty Hash as a request object (see above).
5071
+ #
5072
+ # @param name [::String]
5073
+ # Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete.
5074
+ # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
5075
+ #
5076
+ # @yield [response, operation] Access the result along with the RPC operation
5077
+ # @yieldparam response [::Google::Protobuf::Empty]
5078
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5079
+ #
5080
+ # @return [::Google::Protobuf::Empty]
5081
+ #
5082
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5083
+ #
5084
+ def delete_display_video360_advertiser_link_proposal request, options = nil
5085
+ raise ::ArgumentError, "request must be provided" if request.nil?
5086
+
5087
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkProposalRequest
5088
+
5089
+ # Converts hash and nil to an options object
5090
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5091
+
5092
+ # Customize the options with defaults
5093
+ metadata = @config.rpcs.delete_display_video360_advertiser_link_proposal.metadata.to_h
5094
+
5095
+ # Set x-goog-api-client and x-goog-user-project headers
5096
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5097
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5098
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5099
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5100
+
5101
+ header_params = {
5102
+ "name" => request.name
5103
+ }
5104
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5105
+ metadata[:"x-goog-request-params"] ||= request_params_header
5106
+
5107
+ options.apply_defaults timeout: @config.rpcs.delete_display_video360_advertiser_link_proposal.timeout,
5108
+ metadata: metadata,
5109
+ retry_policy: @config.rpcs.delete_display_video360_advertiser_link_proposal.retry_policy
5110
+
5111
+ options.apply_defaults timeout: @config.timeout,
5112
+ metadata: @config.metadata,
5113
+ retry_policy: @config.retry_policy
5114
+
5115
+ @analytics_admin_service_stub.call_rpc :delete_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
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
+ # Approves a DisplayVideo360AdvertiserLinkProposal.
5125
+ # The DisplayVideo360AdvertiserLinkProposal will be deleted and a new
5126
+ # DisplayVideo360AdvertiserLink will be created.
5127
+ #
5128
+ # @overload approve_display_video360_advertiser_link_proposal(request, options = nil)
5129
+ # Pass arguments to `approve_display_video360_advertiser_link_proposal` via a request object, either of type
5130
+ # {::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest} or an equivalent Hash.
5131
+ #
5132
+ # @param request [::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest, ::Hash]
5133
+ # A request object representing the call parameters. Required. To specify no
5134
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5135
+ # @param options [::Gapic::CallOptions, ::Hash]
5136
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5137
+ #
5138
+ # @overload approve_display_video360_advertiser_link_proposal(name: nil)
5139
+ # Pass arguments to `approve_display_video360_advertiser_link_proposal` via keyword arguments. Note that at
5140
+ # least one keyword argument is required. To specify no parameters, or to keep all
5141
+ # the default parameter values, pass an empty Hash as a request object (see above).
5142
+ #
5143
+ # @param name [::String]
5144
+ # Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve.
5145
+ # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
5146
+ #
5147
+ # @yield [response, operation] Access the result along with the RPC operation
5148
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse]
5149
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5150
+ #
5151
+ # @return [::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse]
5152
+ #
5153
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5154
+ #
5155
+ def approve_display_video360_advertiser_link_proposal request, options = nil
5156
+ raise ::ArgumentError, "request must be provided" if request.nil?
5157
+
5158
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest
5159
+
5160
+ # Converts hash and nil to an options object
5161
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5162
+
5163
+ # Customize the options with defaults
5164
+ metadata = @config.rpcs.approve_display_video360_advertiser_link_proposal.metadata.to_h
5165
+
5166
+ # Set x-goog-api-client and x-goog-user-project headers
5167
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5168
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5169
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5170
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5171
+
5172
+ header_params = {
5173
+ "name" => request.name
5174
+ }
5175
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5176
+ metadata[:"x-goog-request-params"] ||= request_params_header
5177
+
5178
+ options.apply_defaults timeout: @config.rpcs.approve_display_video360_advertiser_link_proposal.timeout,
5179
+ metadata: metadata,
5180
+ retry_policy: @config.rpcs.approve_display_video360_advertiser_link_proposal.retry_policy
5181
+
5182
+ options.apply_defaults timeout: @config.timeout,
5183
+ metadata: @config.metadata,
5184
+ retry_policy: @config.retry_policy
5185
+
5186
+ @analytics_admin_service_stub.call_rpc :approve_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
5187
+ yield response, operation if block_given?
5188
+ return response
5189
+ end
5190
+ rescue ::GRPC::BadStatus => e
5191
+ raise ::Google::Cloud::Error.from_error(e)
5192
+ end
5193
+
5194
+ ##
5195
+ # Cancels a DisplayVideo360AdvertiserLinkProposal.
5196
+ # Cancelling can mean either:
5197
+ # - Declining a proposal initiated from Display & Video 360
5198
+ # - Withdrawing a proposal initiated from Google Analytics
5199
+ # After being cancelled, a proposal will eventually be deleted automatically.
5200
+ #
5201
+ # @overload cancel_display_video360_advertiser_link_proposal(request, options = nil)
5202
+ # Pass arguments to `cancel_display_video360_advertiser_link_proposal` via a request object, either of type
5203
+ # {::Google::Analytics::Admin::V1alpha::CancelDisplayVideo360AdvertiserLinkProposalRequest} or an equivalent Hash.
5204
+ #
5205
+ # @param request [::Google::Analytics::Admin::V1alpha::CancelDisplayVideo360AdvertiserLinkProposalRequest, ::Hash]
5206
+ # A request object representing the call parameters. Required. To specify no
5207
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5208
+ # @param options [::Gapic::CallOptions, ::Hash]
5209
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5210
+ #
5211
+ # @overload cancel_display_video360_advertiser_link_proposal(name: nil)
5212
+ # Pass arguments to `cancel_display_video360_advertiser_link_proposal` via keyword arguments. Note that at
5213
+ # least one keyword argument is required. To specify no parameters, or to keep all
5214
+ # the default parameter values, pass an empty Hash as a request object (see above).
5215
+ #
5216
+ # @param name [::String]
5217
+ # Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel.
5218
+ # Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
5219
+ #
5220
+ # @yield [response, operation] Access the result along with the RPC operation
5221
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
5222
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5223
+ #
5224
+ # @return [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal]
5225
+ #
5226
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5227
+ #
5228
+ def cancel_display_video360_advertiser_link_proposal request, options = nil
5229
+ raise ::ArgumentError, "request must be provided" if request.nil?
5230
+
5231
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CancelDisplayVideo360AdvertiserLinkProposalRequest
5232
+
5233
+ # Converts hash and nil to an options object
5234
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5235
+
5236
+ # Customize the options with defaults
5237
+ metadata = @config.rpcs.cancel_display_video360_advertiser_link_proposal.metadata.to_h
5238
+
5239
+ # Set x-goog-api-client and x-goog-user-project headers
5240
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5241
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5242
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5243
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5244
+
5245
+ header_params = {
5246
+ "name" => request.name
5247
+ }
5248
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5249
+ metadata[:"x-goog-request-params"] ||= request_params_header
5250
+
5251
+ options.apply_defaults timeout: @config.rpcs.cancel_display_video360_advertiser_link_proposal.timeout,
5252
+ metadata: metadata,
5253
+ retry_policy: @config.rpcs.cancel_display_video360_advertiser_link_proposal.retry_policy
5254
+
5255
+ options.apply_defaults timeout: @config.timeout,
5256
+ metadata: @config.metadata,
5257
+ retry_policy: @config.retry_policy
5258
+
5259
+ @analytics_admin_service_stub.call_rpc :cancel_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
5260
+ yield response, operation if block_given?
5261
+ return response
5262
+ end
5263
+ rescue ::GRPC::BadStatus => e
5264
+ raise ::Google::Cloud::Error.from_error(e)
5265
+ end
5266
+
5267
+ ##
5268
+ # Creates a CustomDimension.
5269
+ #
5270
+ # @overload create_custom_dimension(request, options = nil)
5271
+ # Pass arguments to `create_custom_dimension` via a request object, either of type
5272
+ # {::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest} or an equivalent Hash.
5273
+ #
5274
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest, ::Hash]
5275
+ # A request object representing the call parameters. Required. To specify no
5276
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5277
+ # @param options [::Gapic::CallOptions, ::Hash]
5278
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5279
+ #
5280
+ # @overload create_custom_dimension(parent: nil, custom_dimension: nil)
5281
+ # Pass arguments to `create_custom_dimension` via keyword arguments. Note that at
5282
+ # least one keyword argument is required. To specify no parameters, or to keep all
5283
+ # the default parameter values, pass an empty Hash as a request object (see above).
5284
+ #
5285
+ # @param parent [::String]
5286
+ # Required. Example format: properties/1234
5287
+ # @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
5288
+ # Required. The CustomDimension to create.
5289
+ #
5290
+ # @yield [response, operation] Access the result along with the RPC operation
5291
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
5292
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5293
+ #
5294
+ # @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
5295
+ #
5296
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5297
+ #
5298
+ def create_custom_dimension request, options = nil
5299
+ raise ::ArgumentError, "request must be provided" if request.nil?
5300
+
5301
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest
5302
+
5303
+ # Converts hash and nil to an options object
5304
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5305
+
5306
+ # Customize the options with defaults
5307
+ metadata = @config.rpcs.create_custom_dimension.metadata.to_h
5308
+
5309
+ # Set x-goog-api-client and x-goog-user-project headers
5310
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5311
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5312
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5313
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5314
+
5315
+ header_params = {
5316
+ "parent" => request.parent
5317
+ }
5318
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5319
+ metadata[:"x-goog-request-params"] ||= request_params_header
5320
+
5321
+ options.apply_defaults timeout: @config.rpcs.create_custom_dimension.timeout,
5322
+ metadata: metadata,
5323
+ retry_policy: @config.rpcs.create_custom_dimension.retry_policy
5324
+
5325
+ options.apply_defaults timeout: @config.timeout,
5326
+ metadata: @config.metadata,
5327
+ retry_policy: @config.retry_policy
5328
+
5329
+ @analytics_admin_service_stub.call_rpc :create_custom_dimension, request, options: options do |response, operation|
5330
+ yield response, operation if block_given?
5331
+ return response
5332
+ end
5333
+ rescue ::GRPC::BadStatus => e
5334
+ raise ::Google::Cloud::Error.from_error(e)
5335
+ end
5336
+
5337
+ ##
5338
+ # Updates a CustomDimension on a property.
5339
+ #
5340
+ # @overload update_custom_dimension(request, options = nil)
5341
+ # Pass arguments to `update_custom_dimension` via a request object, either of type
5342
+ # {::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest} or an equivalent Hash.
5343
+ #
5344
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest, ::Hash]
5345
+ # A request object representing the call parameters. Required. To specify no
5346
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5347
+ # @param options [::Gapic::CallOptions, ::Hash]
5348
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5349
+ #
5350
+ # @overload update_custom_dimension(custom_dimension: nil, update_mask: nil)
5351
+ # Pass arguments to `update_custom_dimension` via keyword arguments. Note that at
5352
+ # least one keyword argument is required. To specify no parameters, or to keep all
5353
+ # the default parameter values, pass an empty Hash as a request object (see above).
5354
+ #
5355
+ # @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
5356
+ # The CustomDimension to update
5357
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
5358
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
5359
+ # To replace the entire entity, use one path with the string "*" to match
5360
+ # all fields.
5361
+ #
5362
+ # @yield [response, operation] Access the result along with the RPC operation
5363
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
5364
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5365
+ #
5366
+ # @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
5367
+ #
5368
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5369
+ #
5370
+ def update_custom_dimension request, options = nil
5371
+ raise ::ArgumentError, "request must be provided" if request.nil?
5372
+
5373
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest
5374
+
5375
+ # Converts hash and nil to an options object
5376
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5377
+
5378
+ # Customize the options with defaults
5379
+ metadata = @config.rpcs.update_custom_dimension.metadata.to_h
5380
+
5381
+ # Set x-goog-api-client and x-goog-user-project headers
5382
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5383
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5384
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5385
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5386
+
5387
+ header_params = {
5388
+ "custom_dimension.name" => request.custom_dimension.name
5389
+ }
5390
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5391
+ metadata[:"x-goog-request-params"] ||= request_params_header
5392
+
5393
+ options.apply_defaults timeout: @config.rpcs.update_custom_dimension.timeout,
5394
+ metadata: metadata,
5395
+ retry_policy: @config.rpcs.update_custom_dimension.retry_policy
5396
+
5397
+ options.apply_defaults timeout: @config.timeout,
5398
+ metadata: @config.metadata,
5399
+ retry_policy: @config.retry_policy
5400
+
5401
+ @analytics_admin_service_stub.call_rpc :update_custom_dimension, request, options: options do |response, operation|
5402
+ yield response, operation if block_given?
5403
+ return response
5404
+ end
5405
+ rescue ::GRPC::BadStatus => e
5406
+ raise ::Google::Cloud::Error.from_error(e)
5407
+ end
5408
+
5409
+ ##
5410
+ # Lists CustomDimensions on a property.
5411
+ #
5412
+ # @overload list_custom_dimensions(request, options = nil)
5413
+ # Pass arguments to `list_custom_dimensions` via a request object, either of type
5414
+ # {::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest} or an equivalent Hash.
5415
+ #
5416
+ # @param request [::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest, ::Hash]
5417
+ # A request object representing the call parameters. Required. To specify no
5418
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5419
+ # @param options [::Gapic::CallOptions, ::Hash]
5420
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5421
+ #
5422
+ # @overload list_custom_dimensions(parent: nil, page_size: nil, page_token: nil)
5423
+ # Pass arguments to `list_custom_dimensions` via keyword arguments. Note that at
5424
+ # least one keyword argument is required. To specify no parameters, or to keep all
5425
+ # the default parameter values, pass an empty Hash as a request object (see above).
5426
+ #
5427
+ # @param parent [::String]
5428
+ # Required. Example format: properties/1234
5429
+ # @param page_size [::Integer]
5430
+ # The maximum number of resources to return.
5431
+ # If unspecified, at most 50 resources will be returned.
5432
+ # The maximum value is 200 (higher values will be coerced to the maximum).
5433
+ # @param page_token [::String]
5434
+ # A page token, received from a previous `ListCustomDimensions` call.
5435
+ # Provide this to retrieve the subsequent page.
5436
+ #
5437
+ # When paginating, all other parameters provided to `ListCustomDimensions`
5438
+ # must match the call that provided the page token.
5439
+ #
5440
+ # @yield [response, operation] Access the result along with the RPC operation
5441
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>]
5442
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5443
+ #
5444
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>]
5445
+ #
5446
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5447
+ #
5448
+ def list_custom_dimensions request, options = nil
5449
+ raise ::ArgumentError, "request must be provided" if request.nil?
5450
+
5451
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest
5452
+
5453
+ # Converts hash and nil to an options object
5454
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5455
+
5456
+ # Customize the options with defaults
5457
+ metadata = @config.rpcs.list_custom_dimensions.metadata.to_h
5458
+
5459
+ # Set x-goog-api-client and x-goog-user-project headers
5460
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5461
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5462
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5463
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5464
+
5465
+ header_params = {
5466
+ "parent" => request.parent
5467
+ }
5468
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5469
+ metadata[:"x-goog-request-params"] ||= request_params_header
5470
+
5471
+ options.apply_defaults timeout: @config.rpcs.list_custom_dimensions.timeout,
5472
+ metadata: metadata,
5473
+ retry_policy: @config.rpcs.list_custom_dimensions.retry_policy
5474
+
5475
+ options.apply_defaults timeout: @config.timeout,
5476
+ metadata: @config.metadata,
5477
+ retry_policy: @config.retry_policy
5478
+
5479
+ @analytics_admin_service_stub.call_rpc :list_custom_dimensions, request, options: options do |response, operation|
5480
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_dimensions, request, response, operation, options
5481
+ yield response, operation if block_given?
5482
+ return response
5483
+ end
5484
+ rescue ::GRPC::BadStatus => e
5485
+ raise ::Google::Cloud::Error.from_error(e)
5486
+ end
5487
+
5488
+ ##
5489
+ # Archives a CustomDimension on a property.
5490
+ #
5491
+ # @overload archive_custom_dimension(request, options = nil)
5492
+ # Pass arguments to `archive_custom_dimension` via a request object, either of type
5493
+ # {::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest} or an equivalent Hash.
5494
+ #
5495
+ # @param request [::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest, ::Hash]
5496
+ # A request object representing the call parameters. Required. To specify no
5497
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5498
+ # @param options [::Gapic::CallOptions, ::Hash]
5499
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5500
+ #
5501
+ # @overload archive_custom_dimension(name: nil)
5502
+ # Pass arguments to `archive_custom_dimension` via keyword arguments. Note that at
5503
+ # least one keyword argument is required. To specify no parameters, or to keep all
5504
+ # the default parameter values, pass an empty Hash as a request object (see above).
5505
+ #
5506
+ # @param name [::String]
5507
+ # Required. The name of the CustomDimension to archive.
5508
+ # Example format: properties/1234/customDimensions/5678
5509
+ #
5510
+ # @yield [response, operation] Access the result along with the RPC operation
5511
+ # @yieldparam response [::Google::Protobuf::Empty]
5512
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5513
+ #
5514
+ # @return [::Google::Protobuf::Empty]
5515
+ #
5516
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5517
+ #
5518
+ def archive_custom_dimension request, options = nil
5519
+ raise ::ArgumentError, "request must be provided" if request.nil?
5520
+
5521
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest
5522
+
5523
+ # Converts hash and nil to an options object
5524
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5525
+
5526
+ # Customize the options with defaults
5527
+ metadata = @config.rpcs.archive_custom_dimension.metadata.to_h
5528
+
5529
+ # Set x-goog-api-client and x-goog-user-project headers
5530
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5531
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5532
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5533
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5534
+
5535
+ header_params = {
5536
+ "name" => request.name
5537
+ }
5538
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5539
+ metadata[:"x-goog-request-params"] ||= request_params_header
5540
+
5541
+ options.apply_defaults timeout: @config.rpcs.archive_custom_dimension.timeout,
5542
+ metadata: metadata,
5543
+ retry_policy: @config.rpcs.archive_custom_dimension.retry_policy
5544
+
5545
+ options.apply_defaults timeout: @config.timeout,
5546
+ metadata: @config.metadata,
5547
+ retry_policy: @config.retry_policy
5548
+
5549
+ @analytics_admin_service_stub.call_rpc :archive_custom_dimension, request, options: options do |response, operation|
5550
+ yield response, operation if block_given?
5551
+ return response
5552
+ end
5553
+ rescue ::GRPC::BadStatus => e
5554
+ raise ::Google::Cloud::Error.from_error(e)
5555
+ end
5556
+
5557
+ ##
5558
+ # Lookup for a single CustomDimension.
5559
+ #
5560
+ # @overload get_custom_dimension(request, options = nil)
5561
+ # Pass arguments to `get_custom_dimension` via a request object, either of type
5562
+ # {::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest} or an equivalent Hash.
5563
+ #
5564
+ # @param request [::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest, ::Hash]
5565
+ # A request object representing the call parameters. Required. To specify no
5566
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5567
+ # @param options [::Gapic::CallOptions, ::Hash]
5568
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5569
+ #
5570
+ # @overload get_custom_dimension(name: nil)
5571
+ # Pass arguments to `get_custom_dimension` via keyword arguments. Note that at
5572
+ # least one keyword argument is required. To specify no parameters, or to keep all
5573
+ # the default parameter values, pass an empty Hash as a request object (see above).
5574
+ #
5575
+ # @param name [::String]
5576
+ # Required. The name of the CustomDimension to get.
5577
+ # Example format: properties/1234/customDimensions/5678
5578
+ #
5579
+ # @yield [response, operation] Access the result along with the RPC operation
5580
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
5581
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5582
+ #
5583
+ # @return [::Google::Analytics::Admin::V1alpha::CustomDimension]
5584
+ #
5585
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5586
+ #
5587
+ def get_custom_dimension request, options = nil
5588
+ raise ::ArgumentError, "request must be provided" if request.nil?
5589
+
5590
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest
5591
+
5592
+ # Converts hash and nil to an options object
5593
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5594
+
5595
+ # Customize the options with defaults
5596
+ metadata = @config.rpcs.get_custom_dimension.metadata.to_h
5597
+
5598
+ # Set x-goog-api-client and x-goog-user-project headers
5599
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5600
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5601
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5602
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5603
+
5604
+ header_params = {
5605
+ "name" => request.name
5606
+ }
5607
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5608
+ metadata[:"x-goog-request-params"] ||= request_params_header
5609
+
5610
+ options.apply_defaults timeout: @config.rpcs.get_custom_dimension.timeout,
5611
+ metadata: metadata,
5612
+ retry_policy: @config.rpcs.get_custom_dimension.retry_policy
5613
+
5614
+ options.apply_defaults timeout: @config.timeout,
5615
+ metadata: @config.metadata,
5616
+ retry_policy: @config.retry_policy
5617
+
5618
+ @analytics_admin_service_stub.call_rpc :get_custom_dimension, request, options: options do |response, operation|
5619
+ yield response, operation if block_given?
5620
+ return response
5621
+ end
5622
+ rescue ::GRPC::BadStatus => e
5623
+ raise ::Google::Cloud::Error.from_error(e)
5624
+ end
5625
+
5626
+ ##
5627
+ # Creates a CustomMetric.
5628
+ #
5629
+ # @overload create_custom_metric(request, options = nil)
5630
+ # Pass arguments to `create_custom_metric` via a request object, either of type
5631
+ # {::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest} or an equivalent Hash.
5632
+ #
5633
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest, ::Hash]
5634
+ # A request object representing the call parameters. Required. To specify no
5635
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5636
+ # @param options [::Gapic::CallOptions, ::Hash]
5637
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5638
+ #
5639
+ # @overload create_custom_metric(parent: nil, custom_metric: nil)
5640
+ # Pass arguments to `create_custom_metric` via keyword arguments. Note that at
5641
+ # least one keyword argument is required. To specify no parameters, or to keep all
5642
+ # the default parameter values, pass an empty Hash as a request object (see above).
5643
+ #
5644
+ # @param parent [::String]
5645
+ # Required. Example format: properties/1234
5646
+ # @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
5647
+ # Required. The CustomMetric to create.
5648
+ #
5649
+ # @yield [response, operation] Access the result along with the RPC operation
5650
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
5651
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5652
+ #
5653
+ # @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
5654
+ #
5655
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5656
+ #
5657
+ def create_custom_metric request, options = nil
5658
+ raise ::ArgumentError, "request must be provided" if request.nil?
5659
+
5660
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest
5661
+
5662
+ # Converts hash and nil to an options object
5663
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5664
+
5665
+ # Customize the options with defaults
5666
+ metadata = @config.rpcs.create_custom_metric.metadata.to_h
5667
+
5668
+ # Set x-goog-api-client and x-goog-user-project headers
5669
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5670
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5671
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5672
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5673
+
5674
+ header_params = {
5675
+ "parent" => request.parent
5676
+ }
5677
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5678
+ metadata[:"x-goog-request-params"] ||= request_params_header
5679
+
5680
+ options.apply_defaults timeout: @config.rpcs.create_custom_metric.timeout,
5681
+ metadata: metadata,
5682
+ retry_policy: @config.rpcs.create_custom_metric.retry_policy
5683
+
5684
+ options.apply_defaults timeout: @config.timeout,
5685
+ metadata: @config.metadata,
5686
+ retry_policy: @config.retry_policy
5687
+
5688
+ @analytics_admin_service_stub.call_rpc :create_custom_metric, request, options: options do |response, operation|
5689
+ yield response, operation if block_given?
5690
+ return response
5691
+ end
5692
+ rescue ::GRPC::BadStatus => e
5693
+ raise ::Google::Cloud::Error.from_error(e)
5694
+ end
5695
+
5696
+ ##
5697
+ # Updates a CustomMetric on a property.
5698
+ #
5699
+ # @overload update_custom_metric(request, options = nil)
5700
+ # Pass arguments to `update_custom_metric` via a request object, either of type
5701
+ # {::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest} or an equivalent Hash.
5702
+ #
5703
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest, ::Hash]
5704
+ # A request object representing the call parameters. Required. To specify no
5705
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5706
+ # @param options [::Gapic::CallOptions, ::Hash]
5707
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5708
+ #
5709
+ # @overload update_custom_metric(custom_metric: nil, update_mask: nil)
5710
+ # Pass arguments to `update_custom_metric` via keyword arguments. Note that at
5711
+ # least one keyword argument is required. To specify no parameters, or to keep all
5712
+ # the default parameter values, pass an empty Hash as a request object (see above).
5713
+ #
5714
+ # @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
5715
+ # The CustomMetric to update
5716
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
5717
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
5718
+ # To replace the entire entity, use one path with the string "*" to match
5719
+ # all fields.
5720
+ #
5721
+ # @yield [response, operation] Access the result along with the RPC operation
5722
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
5723
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5724
+ #
5725
+ # @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
5726
+ #
5727
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5728
+ #
5729
+ def update_custom_metric request, options = nil
5730
+ raise ::ArgumentError, "request must be provided" if request.nil?
5731
+
5732
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest
5733
+
5734
+ # Converts hash and nil to an options object
5735
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5736
+
5737
+ # Customize the options with defaults
5738
+ metadata = @config.rpcs.update_custom_metric.metadata.to_h
5739
+
5740
+ # Set x-goog-api-client and x-goog-user-project headers
5741
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5742
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5743
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5744
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5745
+
5746
+ header_params = {
5747
+ "custom_metric.name" => request.custom_metric.name
5748
+ }
5749
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5750
+ metadata[:"x-goog-request-params"] ||= request_params_header
5751
+
5752
+ options.apply_defaults timeout: @config.rpcs.update_custom_metric.timeout,
5753
+ metadata: metadata,
5754
+ retry_policy: @config.rpcs.update_custom_metric.retry_policy
5755
+
5756
+ options.apply_defaults timeout: @config.timeout,
5757
+ metadata: @config.metadata,
5758
+ retry_policy: @config.retry_policy
5759
+
5760
+ @analytics_admin_service_stub.call_rpc :update_custom_metric, request, options: options do |response, operation|
5761
+ yield response, operation if block_given?
5762
+ return response
5763
+ end
5764
+ rescue ::GRPC::BadStatus => e
5765
+ raise ::Google::Cloud::Error.from_error(e)
5766
+ end
5767
+
5768
+ ##
5769
+ # Lists CustomMetrics on a property.
5770
+ #
5771
+ # @overload list_custom_metrics(request, options = nil)
5772
+ # Pass arguments to `list_custom_metrics` via a request object, either of type
5773
+ # {::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest} or an equivalent Hash.
5774
+ #
5775
+ # @param request [::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest, ::Hash]
5776
+ # A request object representing the call parameters. Required. To specify no
5777
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5778
+ # @param options [::Gapic::CallOptions, ::Hash]
5779
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5780
+ #
5781
+ # @overload list_custom_metrics(parent: nil, page_size: nil, page_token: nil)
5782
+ # Pass arguments to `list_custom_metrics` via keyword arguments. Note that at
5783
+ # least one keyword argument is required. To specify no parameters, or to keep all
5784
+ # the default parameter values, pass an empty Hash as a request object (see above).
5785
+ #
5786
+ # @param parent [::String]
5787
+ # Required. Example format: properties/1234
5788
+ # @param page_size [::Integer]
5789
+ # The maximum number of resources to return.
5790
+ # If unspecified, at most 50 resources will be returned.
5791
+ # The maximum value is 200 (higher values will be coerced to the maximum).
5792
+ # @param page_token [::String]
5793
+ # A page token, received from a previous `ListCustomMetrics` call.
5794
+ # Provide this to retrieve the subsequent page.
5795
+ #
5796
+ # When paginating, all other parameters provided to `ListCustomMetrics` must
5797
+ # match the call that provided the page token.
5798
+ #
5799
+ # @yield [response, operation] Access the result along with the RPC operation
5800
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>]
5801
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5802
+ #
5803
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>]
5804
+ #
5805
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5806
+ #
5807
+ def list_custom_metrics request, options = nil
5808
+ raise ::ArgumentError, "request must be provided" if request.nil?
5809
+
5810
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest
5811
+
5812
+ # Converts hash and nil to an options object
5813
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5814
+
5815
+ # Customize the options with defaults
5816
+ metadata = @config.rpcs.list_custom_metrics.metadata.to_h
5817
+
5818
+ # Set x-goog-api-client and x-goog-user-project headers
5819
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5820
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5821
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5822
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5823
+
5824
+ header_params = {
5825
+ "parent" => request.parent
5826
+ }
5827
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5828
+ metadata[:"x-goog-request-params"] ||= request_params_header
5829
+
5830
+ options.apply_defaults timeout: @config.rpcs.list_custom_metrics.timeout,
5831
+ metadata: metadata,
5832
+ retry_policy: @config.rpcs.list_custom_metrics.retry_policy
5833
+
5834
+ options.apply_defaults timeout: @config.timeout,
5835
+ metadata: @config.metadata,
5836
+ retry_policy: @config.retry_policy
5837
+
5838
+ @analytics_admin_service_stub.call_rpc :list_custom_metrics, request, options: options do |response, operation|
5839
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_metrics, request, response, operation, options
5840
+ yield response, operation if block_given?
5841
+ return response
5842
+ end
5843
+ rescue ::GRPC::BadStatus => e
5844
+ raise ::Google::Cloud::Error.from_error(e)
5845
+ end
5846
+
5847
+ ##
5848
+ # Archives a CustomMetric on a property.
5849
+ #
5850
+ # @overload archive_custom_metric(request, options = nil)
5851
+ # Pass arguments to `archive_custom_metric` via a request object, either of type
5852
+ # {::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest} or an equivalent Hash.
5853
+ #
5854
+ # @param request [::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest, ::Hash]
5855
+ # A request object representing the call parameters. Required. To specify no
5856
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5857
+ # @param options [::Gapic::CallOptions, ::Hash]
5858
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5859
+ #
5860
+ # @overload archive_custom_metric(name: nil)
5861
+ # Pass arguments to `archive_custom_metric` via keyword arguments. Note that at
5862
+ # least one keyword argument is required. To specify no parameters, or to keep all
5863
+ # the default parameter values, pass an empty Hash as a request object (see above).
5864
+ #
5865
+ # @param name [::String]
5866
+ # Required. The name of the CustomMetric to archive.
5867
+ # Example format: properties/1234/customMetrics/5678
5868
+ #
5869
+ # @yield [response, operation] Access the result along with the RPC operation
5870
+ # @yieldparam response [::Google::Protobuf::Empty]
5871
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5872
+ #
5873
+ # @return [::Google::Protobuf::Empty]
5874
+ #
5875
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5876
+ #
5877
+ def archive_custom_metric request, options = nil
5878
+ raise ::ArgumentError, "request must be provided" if request.nil?
5879
+
5880
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest
5881
+
5882
+ # Converts hash and nil to an options object
5883
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5884
+
5885
+ # Customize the options with defaults
5886
+ metadata = @config.rpcs.archive_custom_metric.metadata.to_h
5887
+
5888
+ # Set x-goog-api-client and x-goog-user-project headers
5889
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5890
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5891
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5892
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5893
+
5894
+ header_params = {
5895
+ "name" => request.name
5896
+ }
5897
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5898
+ metadata[:"x-goog-request-params"] ||= request_params_header
5899
+
5900
+ options.apply_defaults timeout: @config.rpcs.archive_custom_metric.timeout,
5901
+ metadata: metadata,
5902
+ retry_policy: @config.rpcs.archive_custom_metric.retry_policy
5903
+
5904
+ options.apply_defaults timeout: @config.timeout,
5905
+ metadata: @config.metadata,
5906
+ retry_policy: @config.retry_policy
5907
+
5908
+ @analytics_admin_service_stub.call_rpc :archive_custom_metric, request, options: options do |response, operation|
5909
+ yield response, operation if block_given?
5910
+ return response
5911
+ end
5912
+ rescue ::GRPC::BadStatus => e
5913
+ raise ::Google::Cloud::Error.from_error(e)
5914
+ end
5915
+
5916
+ ##
5917
+ # Lookup for a single CustomMetric.
5918
+ #
5919
+ # @overload get_custom_metric(request, options = nil)
5920
+ # Pass arguments to `get_custom_metric` via a request object, either of type
5921
+ # {::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest} or an equivalent Hash.
5922
+ #
5923
+ # @param request [::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest, ::Hash]
5924
+ # A request object representing the call parameters. Required. To specify no
5925
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5926
+ # @param options [::Gapic::CallOptions, ::Hash]
5927
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5928
+ #
5929
+ # @overload get_custom_metric(name: nil)
5930
+ # Pass arguments to `get_custom_metric` via keyword arguments. Note that at
5931
+ # least one keyword argument is required. To specify no parameters, or to keep all
5932
+ # the default parameter values, pass an empty Hash as a request object (see above).
5933
+ #
5934
+ # @param name [::String]
5935
+ # Required. The name of the CustomMetric to get.
5936
+ # Example format: properties/1234/customMetrics/5678
5937
+ #
5938
+ # @yield [response, operation] Access the result along with the RPC operation
5939
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
5940
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5941
+ #
5942
+ # @return [::Google::Analytics::Admin::V1alpha::CustomMetric]
5943
+ #
5944
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5945
+ #
5946
+ def get_custom_metric request, options = nil
5947
+ raise ::ArgumentError, "request must be provided" if request.nil?
5948
+
5949
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest
5950
+
5951
+ # Converts hash and nil to an options object
5952
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5953
+
5954
+ # Customize the options with defaults
5955
+ metadata = @config.rpcs.get_custom_metric.metadata.to_h
5956
+
5957
+ # Set x-goog-api-client and x-goog-user-project headers
5958
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5959
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5960
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
5961
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5962
+
5963
+ header_params = {
5964
+ "name" => request.name
5965
+ }
5966
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5967
+ metadata[:"x-goog-request-params"] ||= request_params_header
5968
+
5969
+ options.apply_defaults timeout: @config.rpcs.get_custom_metric.timeout,
5970
+ metadata: metadata,
5971
+ retry_policy: @config.rpcs.get_custom_metric.retry_policy
5972
+
5973
+ options.apply_defaults timeout: @config.timeout,
5974
+ metadata: @config.metadata,
5975
+ retry_policy: @config.retry_policy
5976
+
5977
+ @analytics_admin_service_stub.call_rpc :get_custom_metric, request, options: options do |response, operation|
5978
+ yield response, operation if block_given?
5979
+ return response
5980
+ end
5981
+ rescue ::GRPC::BadStatus => e
5982
+ raise ::Google::Cloud::Error.from_error(e)
5983
+ end
5984
+
5985
+ ##
5986
+ # Returns the singleton data retention settings for this property.
5987
+ #
5988
+ # @overload get_data_retention_settings(request, options = nil)
5989
+ # Pass arguments to `get_data_retention_settings` via a request object, either of type
5990
+ # {::Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest} or an equivalent Hash.
5991
+ #
5992
+ # @param request [::Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest, ::Hash]
5993
+ # A request object representing the call parameters. Required. To specify no
5994
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5995
+ # @param options [::Gapic::CallOptions, ::Hash]
5996
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5997
+ #
5998
+ # @overload get_data_retention_settings(name: nil)
5999
+ # Pass arguments to `get_data_retention_settings` via keyword arguments. Note that at
6000
+ # least one keyword argument is required. To specify no parameters, or to keep all
6001
+ # the default parameter values, pass an empty Hash as a request object (see above).
6002
+ #
6003
+ # @param name [::String]
6004
+ # Required. The name of the settings to lookup.
6005
+ # Format:
6006
+ # properties/\\{property}/dataRetentionSettings
6007
+ # Example: "properties/1000/dataRetentionSettings"
6008
+ #
6009
+ # @yield [response, operation] Access the result along with the RPC operation
6010
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
6011
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6012
+ #
6013
+ # @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
6014
+ #
6015
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6016
+ #
6017
+ def get_data_retention_settings request, options = nil
6018
+ raise ::ArgumentError, "request must be provided" if request.nil?
6019
+
6020
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest
6021
+
6022
+ # Converts hash and nil to an options object
6023
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6024
+
6025
+ # Customize the options with defaults
6026
+ metadata = @config.rpcs.get_data_retention_settings.metadata.to_h
6027
+
6028
+ # Set x-goog-api-client and x-goog-user-project headers
6029
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6030
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6031
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
6032
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6033
+
6034
+ header_params = {
6035
+ "name" => request.name
6036
+ }
6037
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6038
+ metadata[:"x-goog-request-params"] ||= request_params_header
6039
+
6040
+ options.apply_defaults timeout: @config.rpcs.get_data_retention_settings.timeout,
6041
+ metadata: metadata,
6042
+ retry_policy: @config.rpcs.get_data_retention_settings.retry_policy
6043
+
6044
+ options.apply_defaults timeout: @config.timeout,
6045
+ metadata: @config.metadata,
6046
+ retry_policy: @config.retry_policy
6047
+
6048
+ @analytics_admin_service_stub.call_rpc :get_data_retention_settings, request, options: options do |response, operation|
6049
+ yield response, operation if block_given?
6050
+ return response
6051
+ end
6052
+ rescue ::GRPC::BadStatus => e
6053
+ raise ::Google::Cloud::Error.from_error(e)
6054
+ end
6055
+
6056
+ ##
6057
+ # Updates the singleton data retention settings for this property.
6058
+ #
6059
+ # @overload update_data_retention_settings(request, options = nil)
6060
+ # Pass arguments to `update_data_retention_settings` via a request object, either of type
6061
+ # {::Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest} or an equivalent Hash.
6062
+ #
6063
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest, ::Hash]
6064
+ # A request object representing the call parameters. Required. To specify no
6065
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6066
+ # @param options [::Gapic::CallOptions, ::Hash]
6067
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6068
+ #
6069
+ # @overload update_data_retention_settings(data_retention_settings: nil, update_mask: nil)
6070
+ # Pass arguments to `update_data_retention_settings` via keyword arguments. Note that at
6071
+ # least one keyword argument is required. To specify no parameters, or to keep all
6072
+ # the default parameter values, pass an empty Hash as a request object (see above).
6073
+ #
6074
+ # @param data_retention_settings [::Google::Analytics::Admin::V1alpha::DataRetentionSettings, ::Hash]
6075
+ # Required. The settings to update.
6076
+ # The `name` field is used to identify the settings to be updated.
6077
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
6078
+ # Required. The list of fields to be updated. Field names must be in snake case
6079
+ # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
6080
+ # the entire entity, use one path with the string "*" to match all fields.
6081
+ #
6082
+ # @yield [response, operation] Access the result along with the RPC operation
6083
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
6084
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6085
+ #
6086
+ # @return [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
6087
+ #
6088
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6089
+ #
6090
+ def update_data_retention_settings request, options = nil
6091
+ raise ::ArgumentError, "request must be provided" if request.nil?
6092
+
6093
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest
6094
+
6095
+ # Converts hash and nil to an options object
6096
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6097
+
6098
+ # Customize the options with defaults
6099
+ metadata = @config.rpcs.update_data_retention_settings.metadata.to_h
6100
+
6101
+ # Set x-goog-api-client and x-goog-user-project headers
6102
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6103
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6104
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
6105
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6106
+
6107
+ header_params = {
6108
+ "data_retention_settings.name" => request.data_retention_settings.name
6109
+ }
6110
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6111
+ metadata[:"x-goog-request-params"] ||= request_params_header
6112
+
6113
+ options.apply_defaults timeout: @config.rpcs.update_data_retention_settings.timeout,
6114
+ metadata: metadata,
6115
+ retry_policy: @config.rpcs.update_data_retention_settings.retry_policy
6116
+
6117
+ options.apply_defaults timeout: @config.timeout,
6118
+ metadata: @config.metadata,
6119
+ retry_policy: @config.retry_policy
6120
+
6121
+ @analytics_admin_service_stub.call_rpc :update_data_retention_settings, request, options: options do |response, operation|
6122
+ yield response, operation if block_given?
6123
+ return response
6124
+ end
6125
+ rescue ::GRPC::BadStatus => e
6126
+ raise ::Google::Cloud::Error.from_error(e)
6127
+ end
6128
+
6129
+ ##
6130
+ # Configuration class for the AnalyticsAdminService API.
6131
+ #
6132
+ # This class represents the configuration for AnalyticsAdminService,
6133
+ # providing control over timeouts, retry behavior, logging, transport
6134
+ # parameters, and other low-level controls. Certain parameters can also be
6135
+ # applied individually to specific RPCs. See
6136
+ # {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
6137
+ # for a list of RPCs that can be configured independently.
6138
+ #
6139
+ # Configuration can be applied globally to all clients, or to a single client
6140
+ # on construction.
6141
+ #
6142
+ # @example
6143
+ #
6144
+ # # Modify the global config, setting the timeout for
6145
+ # # get_account to 20 seconds,
6146
+ # # and all remaining timeouts to 10 seconds.
6147
+ # ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
6148
+ # config.timeout = 10.0
6149
+ # config.rpcs.get_account.timeout = 20.0
6150
+ # end
6151
+ #
6152
+ # # Apply the above configuration only to a new client.
6153
+ # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
6154
+ # config.timeout = 10.0
6155
+ # config.rpcs.get_account.timeout = 20.0
6156
+ # end
6157
+ #
6158
+ # @!attribute [rw] endpoint
6159
+ # The hostname or hostname:port of the service endpoint.
6160
+ # Defaults to `"analyticsadmin.googleapis.com"`.
6161
+ # @return [::String]
6162
+ # @!attribute [rw] credentials
6163
+ # Credentials to send with calls. You may provide any of the following types:
6164
+ # * (`String`) The path to a service account key file in JSON format
6165
+ # * (`Hash`) A service account key as a Hash
6166
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
6167
+ # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
6168
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
6169
+ # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
6170
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
6171
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
6172
+ # * (`nil`) indicating no credentials
6173
+ # @return [::Object]
6174
+ # @!attribute [rw] scope
6175
+ # The OAuth scopes
6176
+ # @return [::Array<::String>]
6177
+ # @!attribute [rw] lib_name
6178
+ # The library name as recorded in instrumentation and logging
6179
+ # @return [::String]
6180
+ # @!attribute [rw] lib_version
6181
+ # The library version as recorded in instrumentation and logging
6182
+ # @return [::String]
6183
+ # @!attribute [rw] channel_args
6184
+ # Extra parameters passed to the gRPC channel. Note: this is ignored if a
6185
+ # `GRPC::Core::Channel` object is provided as the credential.
6186
+ # @return [::Hash]
6187
+ # @!attribute [rw] interceptors
6188
+ # An array of interceptors that are run before calls are executed.
6189
+ # @return [::Array<::GRPC::ClientInterceptor>]
6190
+ # @!attribute [rw] timeout
6191
+ # The call timeout in seconds.
6192
+ # @return [::Numeric]
6193
+ # @!attribute [rw] metadata
6194
+ # Additional gRPC headers to be sent with the call.
6195
+ # @return [::Hash{::Symbol=>::String}]
6196
+ # @!attribute [rw] retry_policy
6197
+ # The retry policy. The value is a hash with the following keys:
6198
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
6199
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
6200
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
6201
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
6202
+ # trigger a retry.
6203
+ # @return [::Hash]
6204
+ # @!attribute [rw] quota_project
6205
+ # A separate project against which to charge quota.
6206
+ # @return [::String]
6207
+ #
6208
+ class Configuration
6209
+ extend ::Gapic::Config
6210
+
6211
+ config_attr :endpoint, "analyticsadmin.googleapis.com", ::String
6212
+ config_attr :credentials, nil do |value|
6213
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
6214
+ allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
6215
+ allowed.any? { |klass| klass === value }
6216
+ end
6217
+ config_attr :scope, nil, ::String, ::Array, nil
6218
+ config_attr :lib_name, nil, ::String, nil
6219
+ config_attr :lib_version, nil, ::String, nil
6220
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
6221
+ config_attr :interceptors, nil, ::Array, nil
6222
+ config_attr :timeout, nil, ::Numeric, nil
6223
+ config_attr :metadata, nil, ::Hash, nil
6224
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
6225
+ config_attr :quota_project, nil, ::String, nil
6226
+
6227
+ # @private
6228
+ def initialize parent_config = nil
6229
+ @parent_config = parent_config unless parent_config.nil?
6230
+
6231
+ yield self if block_given?
6232
+ end
6233
+
6234
+ ##
6235
+ # Configurations for individual RPCs
6236
+ # @return [Rpcs]
6237
+ #
6238
+ def rpcs
3765
6239
  @rpcs ||= begin
3766
6240
  parent_rpcs = nil
3767
6241
  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
@@ -3973,11 +6447,6 @@ module Google
3973
6447
  #
3974
6448
  attr_reader :create_firebase_link
3975
6449
  ##
3976
- # RPC-specific configuration for `update_firebase_link`
3977
- # @return [::Gapic::Config::Method]
3978
- #
3979
- attr_reader :update_firebase_link
3980
- ##
3981
6450
  # RPC-specific configuration for `delete_firebase_link`
3982
6451
  # @return [::Gapic::Config::Method]
3983
6452
  #
@@ -4018,10 +6487,180 @@ module Google
4018
6487
  #
4019
6488
  attr_reader :get_data_sharing_settings
4020
6489
  ##
6490
+ # RPC-specific configuration for `get_measurement_protocol_secret`
6491
+ # @return [::Gapic::Config::Method]
6492
+ #
6493
+ attr_reader :get_measurement_protocol_secret
6494
+ ##
6495
+ # RPC-specific configuration for `list_measurement_protocol_secrets`
6496
+ # @return [::Gapic::Config::Method]
6497
+ #
6498
+ attr_reader :list_measurement_protocol_secrets
6499
+ ##
6500
+ # RPC-specific configuration for `create_measurement_protocol_secret`
6501
+ # @return [::Gapic::Config::Method]
6502
+ #
6503
+ attr_reader :create_measurement_protocol_secret
6504
+ ##
6505
+ # RPC-specific configuration for `delete_measurement_protocol_secret`
6506
+ # @return [::Gapic::Config::Method]
6507
+ #
6508
+ attr_reader :delete_measurement_protocol_secret
6509
+ ##
6510
+ # RPC-specific configuration for `update_measurement_protocol_secret`
6511
+ # @return [::Gapic::Config::Method]
6512
+ #
6513
+ attr_reader :update_measurement_protocol_secret
6514
+ ##
4021
6515
  # RPC-specific configuration for `search_change_history_events`
4022
6516
  # @return [::Gapic::Config::Method]
4023
6517
  #
4024
6518
  attr_reader :search_change_history_events
6519
+ ##
6520
+ # RPC-specific configuration for `get_google_signals_settings`
6521
+ # @return [::Gapic::Config::Method]
6522
+ #
6523
+ attr_reader :get_google_signals_settings
6524
+ ##
6525
+ # RPC-specific configuration for `update_google_signals_settings`
6526
+ # @return [::Gapic::Config::Method]
6527
+ #
6528
+ attr_reader :update_google_signals_settings
6529
+ ##
6530
+ # RPC-specific configuration for `create_conversion_event`
6531
+ # @return [::Gapic::Config::Method]
6532
+ #
6533
+ attr_reader :create_conversion_event
6534
+ ##
6535
+ # RPC-specific configuration for `get_conversion_event`
6536
+ # @return [::Gapic::Config::Method]
6537
+ #
6538
+ attr_reader :get_conversion_event
6539
+ ##
6540
+ # RPC-specific configuration for `delete_conversion_event`
6541
+ # @return [::Gapic::Config::Method]
6542
+ #
6543
+ attr_reader :delete_conversion_event
6544
+ ##
6545
+ # RPC-specific configuration for `list_conversion_events`
6546
+ # @return [::Gapic::Config::Method]
6547
+ #
6548
+ attr_reader :list_conversion_events
6549
+ ##
6550
+ # RPC-specific configuration for `get_display_video360_advertiser_link`
6551
+ # @return [::Gapic::Config::Method]
6552
+ #
6553
+ attr_reader :get_display_video360_advertiser_link
6554
+ ##
6555
+ # RPC-specific configuration for `list_display_video360_advertiser_links`
6556
+ # @return [::Gapic::Config::Method]
6557
+ #
6558
+ attr_reader :list_display_video360_advertiser_links
6559
+ ##
6560
+ # RPC-specific configuration for `create_display_video360_advertiser_link`
6561
+ # @return [::Gapic::Config::Method]
6562
+ #
6563
+ attr_reader :create_display_video360_advertiser_link
6564
+ ##
6565
+ # RPC-specific configuration for `delete_display_video360_advertiser_link`
6566
+ # @return [::Gapic::Config::Method]
6567
+ #
6568
+ attr_reader :delete_display_video360_advertiser_link
6569
+ ##
6570
+ # RPC-specific configuration for `update_display_video360_advertiser_link`
6571
+ # @return [::Gapic::Config::Method]
6572
+ #
6573
+ attr_reader :update_display_video360_advertiser_link
6574
+ ##
6575
+ # RPC-specific configuration for `get_display_video360_advertiser_link_proposal`
6576
+ # @return [::Gapic::Config::Method]
6577
+ #
6578
+ attr_reader :get_display_video360_advertiser_link_proposal
6579
+ ##
6580
+ # RPC-specific configuration for `list_display_video360_advertiser_link_proposals`
6581
+ # @return [::Gapic::Config::Method]
6582
+ #
6583
+ attr_reader :list_display_video360_advertiser_link_proposals
6584
+ ##
6585
+ # RPC-specific configuration for `create_display_video360_advertiser_link_proposal`
6586
+ # @return [::Gapic::Config::Method]
6587
+ #
6588
+ attr_reader :create_display_video360_advertiser_link_proposal
6589
+ ##
6590
+ # RPC-specific configuration for `delete_display_video360_advertiser_link_proposal`
6591
+ # @return [::Gapic::Config::Method]
6592
+ #
6593
+ attr_reader :delete_display_video360_advertiser_link_proposal
6594
+ ##
6595
+ # RPC-specific configuration for `approve_display_video360_advertiser_link_proposal`
6596
+ # @return [::Gapic::Config::Method]
6597
+ #
6598
+ attr_reader :approve_display_video360_advertiser_link_proposal
6599
+ ##
6600
+ # RPC-specific configuration for `cancel_display_video360_advertiser_link_proposal`
6601
+ # @return [::Gapic::Config::Method]
6602
+ #
6603
+ attr_reader :cancel_display_video360_advertiser_link_proposal
6604
+ ##
6605
+ # RPC-specific configuration for `create_custom_dimension`
6606
+ # @return [::Gapic::Config::Method]
6607
+ #
6608
+ attr_reader :create_custom_dimension
6609
+ ##
6610
+ # RPC-specific configuration for `update_custom_dimension`
6611
+ # @return [::Gapic::Config::Method]
6612
+ #
6613
+ attr_reader :update_custom_dimension
6614
+ ##
6615
+ # RPC-specific configuration for `list_custom_dimensions`
6616
+ # @return [::Gapic::Config::Method]
6617
+ #
6618
+ attr_reader :list_custom_dimensions
6619
+ ##
6620
+ # RPC-specific configuration for `archive_custom_dimension`
6621
+ # @return [::Gapic::Config::Method]
6622
+ #
6623
+ attr_reader :archive_custom_dimension
6624
+ ##
6625
+ # RPC-specific configuration for `get_custom_dimension`
6626
+ # @return [::Gapic::Config::Method]
6627
+ #
6628
+ attr_reader :get_custom_dimension
6629
+ ##
6630
+ # RPC-specific configuration for `create_custom_metric`
6631
+ # @return [::Gapic::Config::Method]
6632
+ #
6633
+ attr_reader :create_custom_metric
6634
+ ##
6635
+ # RPC-specific configuration for `update_custom_metric`
6636
+ # @return [::Gapic::Config::Method]
6637
+ #
6638
+ attr_reader :update_custom_metric
6639
+ ##
6640
+ # RPC-specific configuration for `list_custom_metrics`
6641
+ # @return [::Gapic::Config::Method]
6642
+ #
6643
+ attr_reader :list_custom_metrics
6644
+ ##
6645
+ # RPC-specific configuration for `archive_custom_metric`
6646
+ # @return [::Gapic::Config::Method]
6647
+ #
6648
+ attr_reader :archive_custom_metric
6649
+ ##
6650
+ # RPC-specific configuration for `get_custom_metric`
6651
+ # @return [::Gapic::Config::Method]
6652
+ #
6653
+ attr_reader :get_custom_metric
6654
+ ##
6655
+ # RPC-specific configuration for `get_data_retention_settings`
6656
+ # @return [::Gapic::Config::Method]
6657
+ #
6658
+ attr_reader :get_data_retention_settings
6659
+ ##
6660
+ # RPC-specific configuration for `update_data_retention_settings`
6661
+ # @return [::Gapic::Config::Method]
6662
+ #
6663
+ attr_reader :update_data_retention_settings
4025
6664
 
4026
6665
  # @private
4027
6666
  def initialize parent_rpcs = nil
@@ -4099,8 +6738,6 @@ module Google
4099
6738
  @update_enhanced_measurement_settings = ::Gapic::Config::Method.new update_enhanced_measurement_settings_config
4100
6739
  create_firebase_link_config = parent_rpcs.create_firebase_link if parent_rpcs.respond_to? :create_firebase_link
4101
6740
  @create_firebase_link = ::Gapic::Config::Method.new create_firebase_link_config
4102
- update_firebase_link_config = parent_rpcs.update_firebase_link if parent_rpcs.respond_to? :update_firebase_link
4103
- @update_firebase_link = ::Gapic::Config::Method.new update_firebase_link_config
4104
6741
  delete_firebase_link_config = parent_rpcs.delete_firebase_link if parent_rpcs.respond_to? :delete_firebase_link
4105
6742
  @delete_firebase_link = ::Gapic::Config::Method.new delete_firebase_link_config
4106
6743
  list_firebase_links_config = parent_rpcs.list_firebase_links if parent_rpcs.respond_to? :list_firebase_links
@@ -4117,8 +6754,76 @@ module Google
4117
6754
  @list_google_ads_links = ::Gapic::Config::Method.new list_google_ads_links_config
4118
6755
  get_data_sharing_settings_config = parent_rpcs.get_data_sharing_settings if parent_rpcs.respond_to? :get_data_sharing_settings
4119
6756
  @get_data_sharing_settings = ::Gapic::Config::Method.new get_data_sharing_settings_config
6757
+ get_measurement_protocol_secret_config = parent_rpcs.get_measurement_protocol_secret if parent_rpcs.respond_to? :get_measurement_protocol_secret
6758
+ @get_measurement_protocol_secret = ::Gapic::Config::Method.new get_measurement_protocol_secret_config
6759
+ list_measurement_protocol_secrets_config = parent_rpcs.list_measurement_protocol_secrets if parent_rpcs.respond_to? :list_measurement_protocol_secrets
6760
+ @list_measurement_protocol_secrets = ::Gapic::Config::Method.new list_measurement_protocol_secrets_config
6761
+ create_measurement_protocol_secret_config = parent_rpcs.create_measurement_protocol_secret if parent_rpcs.respond_to? :create_measurement_protocol_secret
6762
+ @create_measurement_protocol_secret = ::Gapic::Config::Method.new create_measurement_protocol_secret_config
6763
+ delete_measurement_protocol_secret_config = parent_rpcs.delete_measurement_protocol_secret if parent_rpcs.respond_to? :delete_measurement_protocol_secret
6764
+ @delete_measurement_protocol_secret = ::Gapic::Config::Method.new delete_measurement_protocol_secret_config
6765
+ update_measurement_protocol_secret_config = parent_rpcs.update_measurement_protocol_secret if parent_rpcs.respond_to? :update_measurement_protocol_secret
6766
+ @update_measurement_protocol_secret = ::Gapic::Config::Method.new update_measurement_protocol_secret_config
4120
6767
  search_change_history_events_config = parent_rpcs.search_change_history_events if parent_rpcs.respond_to? :search_change_history_events
4121
6768
  @search_change_history_events = ::Gapic::Config::Method.new search_change_history_events_config
6769
+ get_google_signals_settings_config = parent_rpcs.get_google_signals_settings if parent_rpcs.respond_to? :get_google_signals_settings
6770
+ @get_google_signals_settings = ::Gapic::Config::Method.new get_google_signals_settings_config
6771
+ update_google_signals_settings_config = parent_rpcs.update_google_signals_settings if parent_rpcs.respond_to? :update_google_signals_settings
6772
+ @update_google_signals_settings = ::Gapic::Config::Method.new update_google_signals_settings_config
6773
+ create_conversion_event_config = parent_rpcs.create_conversion_event if parent_rpcs.respond_to? :create_conversion_event
6774
+ @create_conversion_event = ::Gapic::Config::Method.new create_conversion_event_config
6775
+ get_conversion_event_config = parent_rpcs.get_conversion_event if parent_rpcs.respond_to? :get_conversion_event
6776
+ @get_conversion_event = ::Gapic::Config::Method.new get_conversion_event_config
6777
+ delete_conversion_event_config = parent_rpcs.delete_conversion_event if parent_rpcs.respond_to? :delete_conversion_event
6778
+ @delete_conversion_event = ::Gapic::Config::Method.new delete_conversion_event_config
6779
+ list_conversion_events_config = parent_rpcs.list_conversion_events if parent_rpcs.respond_to? :list_conversion_events
6780
+ @list_conversion_events = ::Gapic::Config::Method.new list_conversion_events_config
6781
+ get_display_video360_advertiser_link_config = parent_rpcs.get_display_video360_advertiser_link if parent_rpcs.respond_to? :get_display_video360_advertiser_link
6782
+ @get_display_video360_advertiser_link = ::Gapic::Config::Method.new get_display_video360_advertiser_link_config
6783
+ list_display_video360_advertiser_links_config = parent_rpcs.list_display_video360_advertiser_links if parent_rpcs.respond_to? :list_display_video360_advertiser_links
6784
+ @list_display_video360_advertiser_links = ::Gapic::Config::Method.new list_display_video360_advertiser_links_config
6785
+ create_display_video360_advertiser_link_config = parent_rpcs.create_display_video360_advertiser_link if parent_rpcs.respond_to? :create_display_video360_advertiser_link
6786
+ @create_display_video360_advertiser_link = ::Gapic::Config::Method.new create_display_video360_advertiser_link_config
6787
+ delete_display_video360_advertiser_link_config = parent_rpcs.delete_display_video360_advertiser_link if parent_rpcs.respond_to? :delete_display_video360_advertiser_link
6788
+ @delete_display_video360_advertiser_link = ::Gapic::Config::Method.new delete_display_video360_advertiser_link_config
6789
+ update_display_video360_advertiser_link_config = parent_rpcs.update_display_video360_advertiser_link if parent_rpcs.respond_to? :update_display_video360_advertiser_link
6790
+ @update_display_video360_advertiser_link = ::Gapic::Config::Method.new update_display_video360_advertiser_link_config
6791
+ get_display_video360_advertiser_link_proposal_config = parent_rpcs.get_display_video360_advertiser_link_proposal if parent_rpcs.respond_to? :get_display_video360_advertiser_link_proposal
6792
+ @get_display_video360_advertiser_link_proposal = ::Gapic::Config::Method.new get_display_video360_advertiser_link_proposal_config
6793
+ list_display_video360_advertiser_link_proposals_config = parent_rpcs.list_display_video360_advertiser_link_proposals if parent_rpcs.respond_to? :list_display_video360_advertiser_link_proposals
6794
+ @list_display_video360_advertiser_link_proposals = ::Gapic::Config::Method.new list_display_video360_advertiser_link_proposals_config
6795
+ create_display_video360_advertiser_link_proposal_config = parent_rpcs.create_display_video360_advertiser_link_proposal if parent_rpcs.respond_to? :create_display_video360_advertiser_link_proposal
6796
+ @create_display_video360_advertiser_link_proposal = ::Gapic::Config::Method.new create_display_video360_advertiser_link_proposal_config
6797
+ delete_display_video360_advertiser_link_proposal_config = parent_rpcs.delete_display_video360_advertiser_link_proposal if parent_rpcs.respond_to? :delete_display_video360_advertiser_link_proposal
6798
+ @delete_display_video360_advertiser_link_proposal = ::Gapic::Config::Method.new delete_display_video360_advertiser_link_proposal_config
6799
+ approve_display_video360_advertiser_link_proposal_config = parent_rpcs.approve_display_video360_advertiser_link_proposal if parent_rpcs.respond_to? :approve_display_video360_advertiser_link_proposal
6800
+ @approve_display_video360_advertiser_link_proposal = ::Gapic::Config::Method.new approve_display_video360_advertiser_link_proposal_config
6801
+ cancel_display_video360_advertiser_link_proposal_config = parent_rpcs.cancel_display_video360_advertiser_link_proposal if parent_rpcs.respond_to? :cancel_display_video360_advertiser_link_proposal
6802
+ @cancel_display_video360_advertiser_link_proposal = ::Gapic::Config::Method.new cancel_display_video360_advertiser_link_proposal_config
6803
+ create_custom_dimension_config = parent_rpcs.create_custom_dimension if parent_rpcs.respond_to? :create_custom_dimension
6804
+ @create_custom_dimension = ::Gapic::Config::Method.new create_custom_dimension_config
6805
+ update_custom_dimension_config = parent_rpcs.update_custom_dimension if parent_rpcs.respond_to? :update_custom_dimension
6806
+ @update_custom_dimension = ::Gapic::Config::Method.new update_custom_dimension_config
6807
+ list_custom_dimensions_config = parent_rpcs.list_custom_dimensions if parent_rpcs.respond_to? :list_custom_dimensions
6808
+ @list_custom_dimensions = ::Gapic::Config::Method.new list_custom_dimensions_config
6809
+ archive_custom_dimension_config = parent_rpcs.archive_custom_dimension if parent_rpcs.respond_to? :archive_custom_dimension
6810
+ @archive_custom_dimension = ::Gapic::Config::Method.new archive_custom_dimension_config
6811
+ get_custom_dimension_config = parent_rpcs.get_custom_dimension if parent_rpcs.respond_to? :get_custom_dimension
6812
+ @get_custom_dimension = ::Gapic::Config::Method.new get_custom_dimension_config
6813
+ create_custom_metric_config = parent_rpcs.create_custom_metric if parent_rpcs.respond_to? :create_custom_metric
6814
+ @create_custom_metric = ::Gapic::Config::Method.new create_custom_metric_config
6815
+ update_custom_metric_config = parent_rpcs.update_custom_metric if parent_rpcs.respond_to? :update_custom_metric
6816
+ @update_custom_metric = ::Gapic::Config::Method.new update_custom_metric_config
6817
+ list_custom_metrics_config = parent_rpcs.list_custom_metrics if parent_rpcs.respond_to? :list_custom_metrics
6818
+ @list_custom_metrics = ::Gapic::Config::Method.new list_custom_metrics_config
6819
+ archive_custom_metric_config = parent_rpcs.archive_custom_metric if parent_rpcs.respond_to? :archive_custom_metric
6820
+ @archive_custom_metric = ::Gapic::Config::Method.new archive_custom_metric_config
6821
+ get_custom_metric_config = parent_rpcs.get_custom_metric if parent_rpcs.respond_to? :get_custom_metric
6822
+ @get_custom_metric = ::Gapic::Config::Method.new get_custom_metric_config
6823
+ get_data_retention_settings_config = parent_rpcs.get_data_retention_settings if parent_rpcs.respond_to? :get_data_retention_settings
6824
+ @get_data_retention_settings = ::Gapic::Config::Method.new get_data_retention_settings_config
6825
+ update_data_retention_settings_config = parent_rpcs.update_data_retention_settings if parent_rpcs.respond_to? :update_data_retention_settings
6826
+ @update_data_retention_settings = ::Gapic::Config::Method.new update_data_retention_settings_config
4122
6827
 
4123
6828
  yield self if block_given?
4124
6829
  end