google-apis-analyticsadmin_v1alpha 0.1.0 → 0.6.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.
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AnalyticsadminV1alpha
18
18
  # Version of the google-apis-analyticsadmin_v1alpha gem
19
- GEM_VERSION = "0.1.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210106"
25
+ REVISION = "20210508"
26
26
  end
27
27
  end
28
28
  end
@@ -40,6 +40,18 @@ module Google
40
40
  include Google::Apis::Core::JsonObjectSupport
41
41
  end
42
42
 
43
+ class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
43
55
  class GoogleAnalyticsAdminV1alphaAuditUserLink
44
56
  class Representation < Google::Apis::Core::JsonRepresentation; end
45
57
 
@@ -94,12 +106,48 @@ module Google
94
106
  include Google::Apis::Core::JsonObjectSupport
95
107
  end
96
108
 
109
+ class GoogleAnalyticsAdminV1alphaChangeHistoryChange
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
121
+ class GoogleAnalyticsAdminV1alphaChangeHistoryEvent
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class GoogleAnalyticsAdminV1alphaConversionEvent
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
97
133
  class GoogleAnalyticsAdminV1alphaCreateUserLinkRequest
98
134
  class Representation < Google::Apis::Core::JsonRepresentation; end
99
135
 
100
136
  include Google::Apis::Core::JsonObjectSupport
101
137
  end
102
138
 
139
+ class GoogleAnalyticsAdminV1alphaCustomDimension
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
145
+ class GoogleAnalyticsAdminV1alphaCustomMetric
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
103
151
  class GoogleAnalyticsAdminV1alphaDataSharingSettings
104
152
  class Representation < Google::Apis::Core::JsonRepresentation; end
105
153
 
@@ -160,6 +208,24 @@ module Google
160
208
  include Google::Apis::Core::JsonObjectSupport
161
209
  end
162
210
 
211
+ class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
217
+ class GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
218
+ class Representation < Google::Apis::Core::JsonRepresentation; end
219
+
220
+ include Google::Apis::Core::JsonObjectSupport
221
+ end
222
+
223
+ class GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
224
+ class Representation < Google::Apis::Core::JsonRepresentation; end
225
+
226
+ include Google::Apis::Core::JsonObjectSupport
227
+ end
228
+
163
229
  class GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse
164
230
  class Representation < Google::Apis::Core::JsonRepresentation; end
165
231
 
@@ -220,6 +286,18 @@ module Google
220
286
  include Google::Apis::Core::JsonObjectSupport
221
287
  end
222
288
 
289
+ class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
295
+ class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse
296
+ class Representation < Google::Apis::Core::JsonRepresentation; end
297
+
298
+ include Google::Apis::Core::JsonObjectSupport
299
+ end
300
+
223
301
  class GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest
224
302
  class Representation < Google::Apis::Core::JsonRepresentation; end
225
303
 
@@ -247,11 +325,11 @@ module Google
247
325
  class GoogleAnalyticsAdminV1alphaAccount
248
326
  # @private
249
327
  class Representation < Google::Apis::Core::JsonRepresentation
250
- property :country_code, as: 'countryCode'
251
328
  property :create_time, as: 'createTime'
252
329
  property :deleted, as: 'deleted'
253
330
  property :display_name, as: 'displayName'
254
331
  property :name, as: 'name'
332
+ property :region_code, as: 'regionCode'
255
333
  property :update_time, as: 'updateTime'
256
334
  end
257
335
  end
@@ -279,6 +357,18 @@ module Google
279
357
  end
280
358
  end
281
359
 
360
+ class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
361
+ # @private
362
+ class Representation < Google::Apis::Core::JsonRepresentation
363
+ end
364
+ end
365
+
366
+ class GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest
367
+ # @private
368
+ class Representation < Google::Apis::Core::JsonRepresentation
369
+ end
370
+ end
371
+
282
372
  class GoogleAnalyticsAdminV1alphaAuditUserLink
283
373
  # @private
284
374
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -355,6 +445,67 @@ module Google
355
445
  end
356
446
  end
357
447
 
448
+ class GoogleAnalyticsAdminV1alphaChangeHistoryChange
449
+ # @private
450
+ class Representation < Google::Apis::Core::JsonRepresentation
451
+ property :action, as: 'action'
452
+ property :resource, as: 'resource'
453
+ property :resource_after_change, as: 'resourceAfterChange', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource::Representation
454
+
455
+ property :resource_before_change, as: 'resourceBeforeChange', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource::Representation
456
+
457
+ end
458
+ end
459
+
460
+ class GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource
461
+ # @private
462
+ class Representation < Google::Apis::Core::JsonRepresentation
463
+ property :account, as: 'account', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount::Representation
464
+
465
+ property :android_app_data_stream, as: 'androidAppDataStream', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
466
+
467
+ property :conversion_event, as: 'conversionEvent', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
468
+
469
+ property :custom_dimension, as: 'customDimension', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
470
+
471
+ property :custom_metric, as: 'customMetric', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
472
+
473
+ property :firebase_link, as: 'firebaseLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink::Representation
474
+
475
+ property :google_ads_link, as: 'googleAdsLink', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink::Representation
476
+
477
+ property :ios_app_data_stream, as: 'iosAppDataStream', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
478
+
479
+ property :property, as: 'property', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
480
+
481
+ property :web_data_stream, as: 'webDataStream', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
482
+
483
+ end
484
+ end
485
+
486
+ class GoogleAnalyticsAdminV1alphaChangeHistoryEvent
487
+ # @private
488
+ class Representation < Google::Apis::Core::JsonRepresentation
489
+ property :actor_type, as: 'actorType'
490
+ property :change_time, as: 'changeTime'
491
+ collection :changes, as: 'changes', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryChange, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryChange::Representation
492
+
493
+ property :changes_filtered, as: 'changesFiltered'
494
+ property :id, as: 'id'
495
+ property :user_actor_email, as: 'userActorEmail'
496
+ end
497
+ end
498
+
499
+ class GoogleAnalyticsAdminV1alphaConversionEvent
500
+ # @private
501
+ class Representation < Google::Apis::Core::JsonRepresentation
502
+ property :create_time, as: 'createTime'
503
+ property :event_name, as: 'eventName'
504
+ property :is_deletable, as: 'isDeletable'
505
+ property :name, as: 'name'
506
+ end
507
+ end
508
+
358
509
  class GoogleAnalyticsAdminV1alphaCreateUserLinkRequest
359
510
  # @private
360
511
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -365,6 +516,30 @@ module Google
365
516
  end
366
517
  end
367
518
 
519
+ class GoogleAnalyticsAdminV1alphaCustomDimension
520
+ # @private
521
+ class Representation < Google::Apis::Core::JsonRepresentation
522
+ property :description, as: 'description'
523
+ property :disallow_ads_personalization, as: 'disallowAdsPersonalization'
524
+ property :display_name, as: 'displayName'
525
+ property :name, as: 'name'
526
+ property :parameter_name, as: 'parameterName'
527
+ property :scope, as: 'scope'
528
+ end
529
+ end
530
+
531
+ class GoogleAnalyticsAdminV1alphaCustomMetric
532
+ # @private
533
+ class Representation < Google::Apis::Core::JsonRepresentation
534
+ property :description, as: 'description'
535
+ property :display_name, as: 'displayName'
536
+ property :measurement_unit, as: 'measurementUnit'
537
+ property :name, as: 'name'
538
+ property :parameter_name, as: 'parameterName'
539
+ property :scope, as: 'scope'
540
+ end
541
+ end
542
+
368
543
  class GoogleAnalyticsAdminV1alphaDataSharingSettings
369
544
  # @private
370
545
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -387,23 +562,17 @@ module Google
387
562
  class GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
388
563
  # @private
389
564
  class Representation < Google::Apis::Core::JsonRepresentation
390
- property :articles_and_blogs_enabled, as: 'articlesAndBlogsEnabled'
391
- property :content_views_enabled, as: 'contentViewsEnabled'
392
- property :data_tagged_element_clicks_enabled, as: 'dataTaggedElementClicksEnabled'
393
- property :excluded_domains, as: 'excludedDomains'
394
565
  property :file_downloads_enabled, as: 'fileDownloadsEnabled'
395
- property :form_interactions_enabled, as: 'formInteractionsEnabled'
396
566
  property :name, as: 'name'
397
567
  property :outbound_clicks_enabled, as: 'outboundClicksEnabled'
398
568
  property :page_changes_enabled, as: 'pageChangesEnabled'
399
569
  property :page_loads_enabled, as: 'pageLoadsEnabled'
400
570
  property :page_views_enabled, as: 'pageViewsEnabled'
401
- property :products_and_ecommerce_enabled, as: 'productsAndEcommerceEnabled'
402
571
  property :scrolls_enabled, as: 'scrollsEnabled'
403
572
  property :search_query_parameter, as: 'searchQueryParameter'
404
573
  property :site_search_enabled, as: 'siteSearchEnabled'
405
574
  property :stream_enabled, as: 'streamEnabled'
406
- property :url_query_parameter, as: 'urlQueryParameter'
575
+ property :uri_query_parameter, as: 'uriQueryParameter'
407
576
  property :video_engagement_enabled, as: 'videoEngagementEnabled'
408
577
  end
409
578
  end
@@ -421,6 +590,7 @@ module Google
421
590
  class GoogleAnalyticsAdminV1alphaGlobalSiteTag
422
591
  # @private
423
592
  class Representation < Google::Apis::Core::JsonRepresentation
593
+ property :name, as: 'name'
424
594
  property :snippet, as: 'snippet'
425
595
  end
426
596
  end
@@ -434,7 +604,6 @@ module Google
434
604
  property :customer_id, as: 'customerId'
435
605
  property :email_address, as: 'emailAddress'
436
606
  property :name, as: 'name'
437
- property :parent, as: 'parent'
438
607
  property :update_time, as: 'updateTime'
439
608
  end
440
609
  end
@@ -478,6 +647,33 @@ module Google
478
647
  end
479
648
  end
480
649
 
650
+ class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
651
+ # @private
652
+ class Representation < Google::Apis::Core::JsonRepresentation
653
+ collection :conversion_events, as: 'conversionEvents', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
654
+
655
+ property :next_page_token, as: 'nextPageToken'
656
+ end
657
+ end
658
+
659
+ class GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
660
+ # @private
661
+ class Representation < Google::Apis::Core::JsonRepresentation
662
+ collection :custom_dimensions, as: 'customDimensions', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
663
+
664
+ property :next_page_token, as: 'nextPageToken'
665
+ end
666
+ end
667
+
668
+ class GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
669
+ # @private
670
+ class Representation < Google::Apis::Core::JsonRepresentation
671
+ collection :custom_metrics, as: 'customMetrics', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
672
+
673
+ property :next_page_token, as: 'nextPageToken'
674
+ end
675
+ end
676
+
481
677
  class GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse
482
678
  # @private
483
679
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -537,8 +733,9 @@ module Google
537
733
  class Representation < Google::Apis::Core::JsonRepresentation
538
734
  property :create_time, as: 'createTime'
539
735
  property :currency_code, as: 'currencyCode'
540
- property :deleted, as: 'deleted'
736
+ property :delete_time, as: 'deleteTime'
541
737
  property :display_name, as: 'displayName'
738
+ property :expire_time, as: 'expireTime'
542
739
  property :industry_category, as: 'industryCategory'
543
740
  property :name, as: 'name'
544
741
  property :parent, as: 'parent'
@@ -571,6 +768,29 @@ module Google
571
768
  end
572
769
  end
573
770
 
771
+ class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
772
+ # @private
773
+ class Representation < Google::Apis::Core::JsonRepresentation
774
+ collection :action, as: 'action'
775
+ collection :actor_email, as: 'actorEmail'
776
+ property :earliest_change_time, as: 'earliestChangeTime'
777
+ property :latest_change_time, as: 'latestChangeTime'
778
+ property :page_size, as: 'pageSize'
779
+ property :page_token, as: 'pageToken'
780
+ property :property, as: 'property'
781
+ collection :resource_type, as: 'resourceType'
782
+ end
783
+ end
784
+
785
+ class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse
786
+ # @private
787
+ class Representation < Google::Apis::Core::JsonRepresentation
788
+ collection :change_history_events, as: 'changeHistoryEvents', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryEvent, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChangeHistoryEvent::Representation
789
+
790
+ property :next_page_token, as: 'nextPageToken'
791
+ end
792
+ end
793
+
574
794
  class GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest
575
795
  # @private
576
796
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -237,9 +237,9 @@ module Google
237
237
  # "accounts/100"
238
238
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount] google_analytics_admin_v1alpha_account_object
239
239
  # @param [String] update_mask
240
- # Required. The list of fields to be updated. Omitted fields will not be updated.
241
- # To replace the entire entity, use one path with the string "*" to match all
242
- # fields.
240
+ # Required. The list of fields to be updated. Field names must be in snake case (
241
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
242
+ # entire entity, use one path with the string "*" to match all fields.
243
243
  # @param [String] fields
244
244
  # Selector specifying which fields to include in a partial response.
245
245
  # @param [String] quota_user
@@ -300,6 +300,40 @@ module Google
300
300
  execute_or_queue_command(command, &block)
301
301
  end
302
302
 
303
+ # Searches through all changes to an account or its children given the specified
304
+ # set of filters.
305
+ # @param [String] account
306
+ # Required. The account resource for which to return change history resources.
307
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest] google_analytics_admin_v1alpha_search_change_history_events_request_object
308
+ # @param [String] fields
309
+ # Selector specifying which fields to include in a partial response.
310
+ # @param [String] quota_user
311
+ # Available to use for quota purposes for server-side applications. Can be any
312
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
313
+ # @param [Google::Apis::RequestOptions] options
314
+ # Request-specific options
315
+ #
316
+ # @yield [result, err] Result & error if block supplied
317
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse] parsed result object
318
+ # @yieldparam err [StandardError] error object if request failed
319
+ #
320
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse]
321
+ #
322
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
323
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
324
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
325
+ def search_account_change_history_events(account, google_analytics_admin_v1alpha_search_change_history_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
326
+ command = make_simple_command(:post, 'v1alpha/{+account}:searchChangeHistoryEvents', options)
327
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest::Representation
328
+ command.request_object = google_analytics_admin_v1alpha_search_change_history_events_request_object
329
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse::Representation
330
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse
331
+ command.params['account'] = account unless account.nil?
332
+ command.query['fields'] = fields unless fields.nil?
333
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
334
+ execute_or_queue_command(command, &block)
335
+ end
336
+
303
337
  # Lists all user links on an account or property, including implicit ones that
304
338
  # come from effective permissions granted by groups or organization admin roles.
305
339
  # If a returned user link does not have direct permissions, they cannot be
@@ -624,7 +658,7 @@ module Google
624
658
 
625
659
  # Updates a user link on an account or property.
626
660
  # @param [String] name
627
- # Example format: properties/1234/userLinks/5678
661
+ # Output only. Example format: properties/1234/userLinks/5678
628
662
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
629
663
  # @param [String] fields
630
664
  # Selector specifying which fields to include in a partial response.
@@ -704,18 +738,18 @@ module Google
704
738
  # Request-specific options
705
739
  #
706
740
  # @yield [result, err] Result & error if block supplied
707
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
741
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] parsed result object
708
742
  # @yieldparam err [StandardError] error object if request failed
709
743
  #
710
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
744
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
711
745
  #
712
746
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
713
747
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
714
748
  # @raise [Google::Apis::AuthorizationError] Authorization is required
715
749
  def delete_property(name, fields: nil, quota_user: nil, options: nil, &block)
716
750
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
717
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
718
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
751
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
752
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty
719
753
  command.params['name'] = name unless name.nil?
720
754
  command.query['fields'] = fields unless fields.nil?
721
755
  command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -814,9 +848,9 @@ module Google
814
848
  # Example: "properties/1000"
815
849
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
816
850
  # @param [String] update_mask
817
- # Required. The list of fields to be updated. Omitted fields will not be updated.
818
- # To replace the entire entity, use one path with the string "*" to match all
819
- # fields.
851
+ # Required. The list of fields to be updated. Field names must be in snake case (
852
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
853
+ # entire entity, use one path with the string "*" to match all fields.
820
854
  # @param [String] fields
821
855
  # Selector specifying which fields to include in a partial response.
822
856
  # @param [String] quota_user
@@ -847,40 +881,6 @@ module Google
847
881
  execute_or_queue_command(command, &block)
848
882
  end
849
883
 
850
- # Creates an android app stream with the specified location and attributes.
851
- # @param [String] parent
852
- # Required. The parent resource where this android app data stream will be
853
- # created. Format: properties/123
854
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] google_analytics_admin_v1alpha_android_app_data_stream_object
855
- # @param [String] fields
856
- # Selector specifying which fields to include in a partial response.
857
- # @param [String] quota_user
858
- # Available to use for quota purposes for server-side applications. Can be any
859
- # arbitrary string assigned to a user, but should not exceed 40 characters.
860
- # @param [Google::Apis::RequestOptions] options
861
- # Request-specific options
862
- #
863
- # @yield [result, err] Result & error if block supplied
864
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] parsed result object
865
- # @yieldparam err [StandardError] error object if request failed
866
- #
867
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
868
- #
869
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
870
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
871
- # @raise [Google::Apis::AuthorizationError] Authorization is required
872
- def create_property_android_app_data_stream(parent, google_analytics_admin_v1alpha_android_app_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
873
- command = make_simple_command(:post, 'v1alpha/{+parent}/androidAppDataStreams', options)
874
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
875
- command.request_object = google_analytics_admin_v1alpha_android_app_data_stream_object
876
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
877
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream
878
- command.params['parent'] = parent unless parent.nil?
879
- command.query['fields'] = fields unless fields.nil?
880
- command.query['quotaUser'] = quota_user unless quota_user.nil?
881
- execute_or_queue_command(command, &block)
882
- end
883
-
884
884
  # Deletes an android app stream on a property.
885
885
  # @param [String] name
886
886
  # Required. The name of the android app data stream to delete. Format:
@@ -995,9 +995,9 @@ module Google
995
995
  # androidAppDataStreams/2000"
996
996
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] google_analytics_admin_v1alpha_android_app_data_stream_object
997
997
  # @param [String] update_mask
998
- # Required. The list of fields to be updated. Omitted fields will not be updated.
999
- # To replace the entire entity, use one path with the string "*" to match all
1000
- # fields.
998
+ # Required. The list of fields to be updated. Field names must be in snake case (
999
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1000
+ # entire entity, use one path with the string "*" to match all fields.
1001
1001
  # @param [String] fields
1002
1002
  # Selector specifying which fields to include in a partial response.
1003
1003
  # @param [String] quota_user
@@ -1028,6 +1028,502 @@ module Google
1028
1028
  execute_or_queue_command(command, &block)
1029
1029
  end
1030
1030
 
1031
+ # Creates a conversion event with the specified attributes.
1032
+ # @param [String] parent
1033
+ # Required. The resource name of the parent property where this conversion event
1034
+ # will be created. Format: properties/123
1035
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] google_analytics_admin_v1alpha_conversion_event_object
1036
+ # @param [String] fields
1037
+ # Selector specifying which fields to include in a partial response.
1038
+ # @param [String] quota_user
1039
+ # Available to use for quota purposes for server-side applications. Can be any
1040
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1041
+ # @param [Google::Apis::RequestOptions] options
1042
+ # Request-specific options
1043
+ #
1044
+ # @yield [result, err] Result & error if block supplied
1045
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] parsed result object
1046
+ # @yieldparam err [StandardError] error object if request failed
1047
+ #
1048
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
1049
+ #
1050
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1051
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1052
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1053
+ def create_property_conversion_event(parent, google_analytics_admin_v1alpha_conversion_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1054
+ command = make_simple_command(:post, 'v1alpha/{+parent}/conversionEvents', options)
1055
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1056
+ command.request_object = google_analytics_admin_v1alpha_conversion_event_object
1057
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1058
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent
1059
+ command.params['parent'] = parent unless parent.nil?
1060
+ command.query['fields'] = fields unless fields.nil?
1061
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1062
+ execute_or_queue_command(command, &block)
1063
+ end
1064
+
1065
+ # Deletes a conversion event in a property.
1066
+ # @param [String] name
1067
+ # Required. The resource name of the conversion event to delete. Format:
1068
+ # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
1069
+ # 123/conversionEvents/456"
1070
+ # @param [String] fields
1071
+ # Selector specifying which fields to include in a partial response.
1072
+ # @param [String] quota_user
1073
+ # Available to use for quota purposes for server-side applications. Can be any
1074
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1075
+ # @param [Google::Apis::RequestOptions] options
1076
+ # Request-specific options
1077
+ #
1078
+ # @yield [result, err] Result & error if block supplied
1079
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1080
+ # @yieldparam err [StandardError] error object if request failed
1081
+ #
1082
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1083
+ #
1084
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1085
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1086
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1087
+ def delete_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
1088
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1089
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1090
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1091
+ command.params['name'] = name unless name.nil?
1092
+ command.query['fields'] = fields unless fields.nil?
1093
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1094
+ execute_or_queue_command(command, &block)
1095
+ end
1096
+
1097
+ # Retrieve a single conversion event.
1098
+ # @param [String] name
1099
+ # Required. The resource name of the conversion event to retrieve. Format:
1100
+ # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
1101
+ # 123/conversionEvents/456"
1102
+ # @param [String] fields
1103
+ # Selector specifying which fields to include in a partial response.
1104
+ # @param [String] quota_user
1105
+ # Available to use for quota purposes for server-side applications. Can be any
1106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1107
+ # @param [Google::Apis::RequestOptions] options
1108
+ # Request-specific options
1109
+ #
1110
+ # @yield [result, err] Result & error if block supplied
1111
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent] parsed result object
1112
+ # @yieldparam err [StandardError] error object if request failed
1113
+ #
1114
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
1115
+ #
1116
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1117
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1118
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1119
+ def get_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
1120
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1121
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent::Representation
1122
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent
1123
+ command.params['name'] = name unless name.nil?
1124
+ command.query['fields'] = fields unless fields.nil?
1125
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1126
+ execute_or_queue_command(command, &block)
1127
+ end
1128
+
1129
+ # Returns a list of conversion events in the specified parent property. Returns
1130
+ # an empty list if no conversion events are found.
1131
+ # @param [String] parent
1132
+ # Required. The resource name of the parent property. Example: 'properties/123'
1133
+ # @param [Fixnum] page_size
1134
+ # The maximum number of resources to return. If unspecified, at most 50
1135
+ # resources will be returned. The maximum value is 200; (higher values will be
1136
+ # coerced to the maximum)
1137
+ # @param [String] page_token
1138
+ # A page token, received from a previous `ListConversionEvents` call. Provide
1139
+ # this to retrieve the subsequent page. When paginating, all other parameters
1140
+ # provided to `ListConversionEvents` must match the call that provided the page
1141
+ # token.
1142
+ # @param [String] fields
1143
+ # Selector specifying which fields to include in a partial response.
1144
+ # @param [String] quota_user
1145
+ # Available to use for quota purposes for server-side applications. Can be any
1146
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1147
+ # @param [Google::Apis::RequestOptions] options
1148
+ # Request-specific options
1149
+ #
1150
+ # @yield [result, err] Result & error if block supplied
1151
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse] parsed result object
1152
+ # @yieldparam err [StandardError] error object if request failed
1153
+ #
1154
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse]
1155
+ #
1156
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1157
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1158
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1159
+ def list_property_conversion_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1160
+ command = make_simple_command(:get, 'v1alpha/{+parent}/conversionEvents', options)
1161
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse::Representation
1162
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1163
+ command.params['parent'] = parent unless parent.nil?
1164
+ command.query['pageSize'] = page_size unless page_size.nil?
1165
+ command.query['pageToken'] = page_token unless page_token.nil?
1166
+ command.query['fields'] = fields unless fields.nil?
1167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1168
+ execute_or_queue_command(command, &block)
1169
+ end
1170
+
1171
+ # Archives a CustomDimension on a property.
1172
+ # @param [String] name
1173
+ # Required. The name of the CustomDimension to archive. Example format:
1174
+ # properties/1234/customDimensions/5678
1175
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest] google_analytics_admin_v1alpha_archive_custom_dimension_request_object
1176
+ # @param [String] fields
1177
+ # Selector specifying which fields to include in a partial response.
1178
+ # @param [String] quota_user
1179
+ # Available to use for quota purposes for server-side applications. Can be any
1180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1181
+ # @param [Google::Apis::RequestOptions] options
1182
+ # Request-specific options
1183
+ #
1184
+ # @yield [result, err] Result & error if block supplied
1185
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1186
+ # @yieldparam err [StandardError] error object if request failed
1187
+ #
1188
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1189
+ #
1190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1193
+ def archive_property_custom_dimension(name, google_analytics_admin_v1alpha_archive_custom_dimension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1194
+ command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1195
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest::Representation
1196
+ command.request_object = google_analytics_admin_v1alpha_archive_custom_dimension_request_object
1197
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1198
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1199
+ command.params['name'] = name unless name.nil?
1200
+ command.query['fields'] = fields unless fields.nil?
1201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1202
+ execute_or_queue_command(command, &block)
1203
+ end
1204
+
1205
+ # Creates a CustomDimension.
1206
+ # @param [String] parent
1207
+ # Required. Example format: properties/1234
1208
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] google_analytics_admin_v1alpha_custom_dimension_object
1209
+ # @param [String] fields
1210
+ # Selector specifying which fields to include in a partial response.
1211
+ # @param [String] quota_user
1212
+ # Available to use for quota purposes for server-side applications. Can be any
1213
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1214
+ # @param [Google::Apis::RequestOptions] options
1215
+ # Request-specific options
1216
+ #
1217
+ # @yield [result, err] Result & error if block supplied
1218
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1219
+ # @yieldparam err [StandardError] error object if request failed
1220
+ #
1221
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1222
+ #
1223
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1224
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1225
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1226
+ def create_property_custom_dimension(parent, google_analytics_admin_v1alpha_custom_dimension_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1227
+ command = make_simple_command(:post, 'v1alpha/{+parent}/customDimensions', options)
1228
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1229
+ command.request_object = google_analytics_admin_v1alpha_custom_dimension_object
1230
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1231
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1232
+ command.params['parent'] = parent unless parent.nil?
1233
+ command.query['fields'] = fields unless fields.nil?
1234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1235
+ execute_or_queue_command(command, &block)
1236
+ end
1237
+
1238
+ # Lookup for a single CustomDimension.
1239
+ # @param [String] name
1240
+ # Required. The name of the CustomDimension to get. Example format: properties/
1241
+ # 1234/customDimensions/5678
1242
+ # @param [String] fields
1243
+ # Selector specifying which fields to include in a partial response.
1244
+ # @param [String] quota_user
1245
+ # Available to use for quota purposes for server-side applications. Can be any
1246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1247
+ # @param [Google::Apis::RequestOptions] options
1248
+ # Request-specific options
1249
+ #
1250
+ # @yield [result, err] Result & error if block supplied
1251
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1252
+ # @yieldparam err [StandardError] error object if request failed
1253
+ #
1254
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1255
+ #
1256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1259
+ def get_property_custom_dimension(name, fields: nil, quota_user: nil, options: nil, &block)
1260
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1261
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1262
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1263
+ command.params['name'] = name unless name.nil?
1264
+ command.query['fields'] = fields unless fields.nil?
1265
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1266
+ execute_or_queue_command(command, &block)
1267
+ end
1268
+
1269
+ # Lists CustomDimensions on a property.
1270
+ # @param [String] parent
1271
+ # Required. Example format: properties/1234
1272
+ # @param [Fixnum] page_size
1273
+ # The maximum number of resources to return. If unspecified, at most 50
1274
+ # resources will be returned. The maximum value is 200 (higher values will be
1275
+ # coerced to the maximum).
1276
+ # @param [String] page_token
1277
+ # A page token, received from a previous `ListCustomDimensions` call. Provide
1278
+ # this to retrieve the subsequent page. When paginating, all other parameters
1279
+ # provided to `ListCustomDimensions` must match the call that provided the page
1280
+ # token.
1281
+ # @param [String] fields
1282
+ # Selector specifying which fields to include in a partial response.
1283
+ # @param [String] quota_user
1284
+ # Available to use for quota purposes for server-side applications. Can be any
1285
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1286
+ # @param [Google::Apis::RequestOptions] options
1287
+ # Request-specific options
1288
+ #
1289
+ # @yield [result, err] Result & error if block supplied
1290
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse] parsed result object
1291
+ # @yieldparam err [StandardError] error object if request failed
1292
+ #
1293
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse]
1294
+ #
1295
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1296
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1297
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1298
+ def list_property_custom_dimensions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1299
+ command = make_simple_command(:get, 'v1alpha/{+parent}/customDimensions', options)
1300
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse::Representation
1301
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
1302
+ command.params['parent'] = parent unless parent.nil?
1303
+ command.query['pageSize'] = page_size unless page_size.nil?
1304
+ command.query['pageToken'] = page_token unless page_token.nil?
1305
+ command.query['fields'] = fields unless fields.nil?
1306
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1307
+ execute_or_queue_command(command, &block)
1308
+ end
1309
+
1310
+ # Updates a CustomDimension on a property.
1311
+ # @param [String] name
1312
+ # Output only. Resource name for this CustomDimension resource. Format:
1313
+ # properties/`property`/customDimensions/`customDimension`
1314
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] google_analytics_admin_v1alpha_custom_dimension_object
1315
+ # @param [String] update_mask
1316
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1317
+ # To replace the entire entity, use one path with the string "*" to match all
1318
+ # fields.
1319
+ # @param [String] fields
1320
+ # Selector specifying which fields to include in a partial response.
1321
+ # @param [String] quota_user
1322
+ # Available to use for quota purposes for server-side applications. Can be any
1323
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1324
+ # @param [Google::Apis::RequestOptions] options
1325
+ # Request-specific options
1326
+ #
1327
+ # @yield [result, err] Result & error if block supplied
1328
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension] parsed result object
1329
+ # @yieldparam err [StandardError] error object if request failed
1330
+ #
1331
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension]
1332
+ #
1333
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1334
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1335
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1336
+ def patch_property_custom_dimension(name, google_analytics_admin_v1alpha_custom_dimension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1337
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1338
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1339
+ command.request_object = google_analytics_admin_v1alpha_custom_dimension_object
1340
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension::Representation
1341
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
1342
+ command.params['name'] = name unless name.nil?
1343
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1344
+ command.query['fields'] = fields unless fields.nil?
1345
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1346
+ execute_or_queue_command(command, &block)
1347
+ end
1348
+
1349
+ # Archives a CustomMetric on a property.
1350
+ # @param [String] name
1351
+ # Required. The name of the CustomMetric to archive. Example format: properties/
1352
+ # 1234/customMetrics/5678
1353
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest] google_analytics_admin_v1alpha_archive_custom_metric_request_object
1354
+ # @param [String] fields
1355
+ # Selector specifying which fields to include in a partial response.
1356
+ # @param [String] quota_user
1357
+ # Available to use for quota purposes for server-side applications. Can be any
1358
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1359
+ # @param [Google::Apis::RequestOptions] options
1360
+ # Request-specific options
1361
+ #
1362
+ # @yield [result, err] Result & error if block supplied
1363
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1364
+ # @yieldparam err [StandardError] error object if request failed
1365
+ #
1366
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1367
+ #
1368
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1369
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1370
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1371
+ def archive_property_custom_metric(name, google_analytics_admin_v1alpha_archive_custom_metric_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1372
+ command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1373
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest::Representation
1374
+ command.request_object = google_analytics_admin_v1alpha_archive_custom_metric_request_object
1375
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1376
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1377
+ command.params['name'] = name unless name.nil?
1378
+ command.query['fields'] = fields unless fields.nil?
1379
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1380
+ execute_or_queue_command(command, &block)
1381
+ end
1382
+
1383
+ # Creates a CustomMetric.
1384
+ # @param [String] parent
1385
+ # Required. Example format: properties/1234
1386
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] google_analytics_admin_v1alpha_custom_metric_object
1387
+ # @param [String] fields
1388
+ # Selector specifying which fields to include in a partial response.
1389
+ # @param [String] quota_user
1390
+ # Available to use for quota purposes for server-side applications. Can be any
1391
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1392
+ # @param [Google::Apis::RequestOptions] options
1393
+ # Request-specific options
1394
+ #
1395
+ # @yield [result, err] Result & error if block supplied
1396
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1397
+ # @yieldparam err [StandardError] error object if request failed
1398
+ #
1399
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1400
+ #
1401
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1402
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1403
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1404
+ def create_property_custom_metric(parent, google_analytics_admin_v1alpha_custom_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1405
+ command = make_simple_command(:post, 'v1alpha/{+parent}/customMetrics', options)
1406
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1407
+ command.request_object = google_analytics_admin_v1alpha_custom_metric_object
1408
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1409
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1410
+ command.params['parent'] = parent unless parent.nil?
1411
+ command.query['fields'] = fields unless fields.nil?
1412
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1413
+ execute_or_queue_command(command, &block)
1414
+ end
1415
+
1416
+ # Lookup for a single CustomMetric.
1417
+ # @param [String] name
1418
+ # Required. The name of the CustomMetric to get. Example format: properties/1234/
1419
+ # customMetrics/5678
1420
+ # @param [String] fields
1421
+ # Selector specifying which fields to include in a partial response.
1422
+ # @param [String] quota_user
1423
+ # Available to use for quota purposes for server-side applications. Can be any
1424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1425
+ # @param [Google::Apis::RequestOptions] options
1426
+ # Request-specific options
1427
+ #
1428
+ # @yield [result, err] Result & error if block supplied
1429
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1430
+ # @yieldparam err [StandardError] error object if request failed
1431
+ #
1432
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1433
+ #
1434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1437
+ def get_property_custom_metric(name, fields: nil, quota_user: nil, options: nil, &block)
1438
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1439
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1440
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1441
+ command.params['name'] = name unless name.nil?
1442
+ command.query['fields'] = fields unless fields.nil?
1443
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1444
+ execute_or_queue_command(command, &block)
1445
+ end
1446
+
1447
+ # Lists CustomMetrics on a property.
1448
+ # @param [String] parent
1449
+ # Required. Example format: properties/1234
1450
+ # @param [Fixnum] page_size
1451
+ # The maximum number of resources to return. If unspecified, at most 50
1452
+ # resources will be returned. The maximum value is 200 (higher values will be
1453
+ # coerced to the maximum).
1454
+ # @param [String] page_token
1455
+ # A page token, received from a previous `ListCustomMetrics` call. Provide this
1456
+ # to retrieve the subsequent page. When paginating, all other parameters
1457
+ # provided to `ListCustomMetrics` must match the call that provided the page
1458
+ # token.
1459
+ # @param [String] fields
1460
+ # Selector specifying which fields to include in a partial response.
1461
+ # @param [String] quota_user
1462
+ # Available to use for quota purposes for server-side applications. Can be any
1463
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1464
+ # @param [Google::Apis::RequestOptions] options
1465
+ # Request-specific options
1466
+ #
1467
+ # @yield [result, err] Result & error if block supplied
1468
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse] parsed result object
1469
+ # @yieldparam err [StandardError] error object if request failed
1470
+ #
1471
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse]
1472
+ #
1473
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1474
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1475
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1476
+ def list_property_custom_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1477
+ command = make_simple_command(:get, 'v1alpha/{+parent}/customMetrics', options)
1478
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse::Representation
1479
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
1480
+ command.params['parent'] = parent unless parent.nil?
1481
+ command.query['pageSize'] = page_size unless page_size.nil?
1482
+ command.query['pageToken'] = page_token unless page_token.nil?
1483
+ command.query['fields'] = fields unless fields.nil?
1484
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1485
+ execute_or_queue_command(command, &block)
1486
+ end
1487
+
1488
+ # Updates a CustomMetric on a property.
1489
+ # @param [String] name
1490
+ # Output only. Resource name for this CustomMetric resource. Format: properties/`
1491
+ # property`/customMetrics/`customMetric`
1492
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] google_analytics_admin_v1alpha_custom_metric_object
1493
+ # @param [String] update_mask
1494
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1495
+ # To replace the entire entity, use one path with the string "*" to match all
1496
+ # fields.
1497
+ # @param [String] fields
1498
+ # Selector specifying which fields to include in a partial response.
1499
+ # @param [String] quota_user
1500
+ # Available to use for quota purposes for server-side applications. Can be any
1501
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1502
+ # @param [Google::Apis::RequestOptions] options
1503
+ # Request-specific options
1504
+ #
1505
+ # @yield [result, err] Result & error if block supplied
1506
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric] parsed result object
1507
+ # @yieldparam err [StandardError] error object if request failed
1508
+ #
1509
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric]
1510
+ #
1511
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1512
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1513
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1514
+ def patch_property_custom_metric(name, google_analytics_admin_v1alpha_custom_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1515
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1516
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1517
+ command.request_object = google_analytics_admin_v1alpha_custom_metric_object
1518
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric::Representation
1519
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric
1520
+ command.params['name'] = name unless name.nil?
1521
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1522
+ command.query['fields'] = fields unless fields.nil?
1523
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1524
+ execute_or_queue_command(command, &block)
1525
+ end
1526
+
1031
1527
  # Creates a FirebaseLink. Properties can have at most one FirebaseLink.
1032
1528
  # @param [String] parent
1033
1529
  # Required. Format: properties/`property_id` Example: properties/1234
@@ -1139,9 +1635,9 @@ module Google
1139
1635
  # Output only. Example format: properties/1234/firebaseLinks/5678
1140
1636
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink] google_analytics_admin_v1alpha_firebase_link_object
1141
1637
  # @param [String] update_mask
1142
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1143
- # To replace the entire entity, use one path with the string "*" to match all
1144
- # fields.
1638
+ # Required. The list of fields to be updated. Field names must be in snake case (
1639
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1640
+ # entire entity, use one path with the string "*" to match all fields.
1145
1641
  # @param [String] fields
1146
1642
  # Selector specifying which fields to include in a partial response.
1147
1643
  # @param [String] quota_user
@@ -1282,9 +1778,9 @@ module Google
1282
1778
  # Note: googleAdsLinkId is not the Google Ads customer ID.
1283
1779
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink] google_analytics_admin_v1alpha_google_ads_link_object
1284
1780
  # @param [String] update_mask
1285
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1286
- # To replace the entire entity, use one path with the string "*" to match all
1287
- # fields.
1781
+ # Required. The list of fields to be updated. Field names must be in snake case (
1782
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1783
+ # entire entity, use one path with the string "*" to match all fields.
1288
1784
  # @param [String] fields
1289
1785
  # Selector specifying which fields to include in a partial response.
1290
1786
  # @param [String] quota_user
@@ -1315,40 +1811,6 @@ module Google
1315
1811
  execute_or_queue_command(command, &block)
1316
1812
  end
1317
1813
 
1318
- # Creates an iOS app data stream with the specified location and attributes.
1319
- # @param [String] parent
1320
- # Required. The parent resource where this ios app data stream will be created.
1321
- # Format: properties/123
1322
- # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] google_analytics_admin_v1alpha_ios_app_data_stream_object
1323
- # @param [String] fields
1324
- # Selector specifying which fields to include in a partial response.
1325
- # @param [String] quota_user
1326
- # Available to use for quota purposes for server-side applications. Can be any
1327
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1328
- # @param [Google::Apis::RequestOptions] options
1329
- # Request-specific options
1330
- #
1331
- # @yield [result, err] Result & error if block supplied
1332
- # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] parsed result object
1333
- # @yieldparam err [StandardError] error object if request failed
1334
- #
1335
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
1336
- #
1337
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1338
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1339
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1340
- def create_property_ios_app_data_stream(parent, google_analytics_admin_v1alpha_ios_app_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1341
- command = make_simple_command(:post, 'v1alpha/{+parent}/iosAppDataStreams', options)
1342
- command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
1343
- command.request_object = google_analytics_admin_v1alpha_ios_app_data_stream_object
1344
- command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
1345
- command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream
1346
- command.params['parent'] = parent unless parent.nil?
1347
- command.query['fields'] = fields unless fields.nil?
1348
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1349
- execute_or_queue_command(command, &block)
1350
- end
1351
-
1352
1814
  # Deletes an iOS app stream on a property.
1353
1815
  # @param [String] name
1354
1816
  # Required. The name of the iOS app data stream to delete. Format: properties/`
@@ -1464,9 +1926,9 @@ module Google
1464
1926
  # iosAppDataStreams/2000"
1465
1927
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] google_analytics_admin_v1alpha_ios_app_data_stream_object
1466
1928
  # @param [String] update_mask
1467
- # Required. The list of fields to be updated. Omitted fields will not be updated.
1468
- # To replace the entire entity, use one path with the string "*" to match all
1469
- # fields.
1929
+ # Required. The list of fields to be updated. Field names must be in snake case (
1930
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1931
+ # entire entity, use one path with the string "*" to match all fields.
1470
1932
  # @param [String] fields
1471
1933
  # Selector specifying which fields to include in a partial response.
1472
1934
  # @param [String] quota_user
@@ -1821,7 +2283,7 @@ module Google
1821
2283
 
1822
2284
  # Updates a user link on an account or property.
1823
2285
  # @param [String] name
1824
- # Example format: properties/1234/userLinks/5678
2286
+ # Output only. Example format: properties/1234/userLinks/5678
1825
2287
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
1826
2288
  # @param [String] fields
1827
2289
  # Selector specifying which fields to include in a partial response.
@@ -2069,9 +2531,9 @@ module Google
2069
2531
  # webDataStreams/2000"
2070
2532
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] google_analytics_admin_v1alpha_web_data_stream_object
2071
2533
  # @param [String] update_mask
2072
- # Required. The list of fields to be updated. Omitted fields will not be updated.
2073
- # To replace the entire entity, use one path with the string "*" to match all
2074
- # fields.
2534
+ # Required. The list of fields to be updated. Field names must be in snake case (
2535
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
2536
+ # entire entity, use one path with the string "*" to match all fields.
2075
2537
  # @param [String] fields
2076
2538
  # Selector specifying which fields to include in a partial response.
2077
2539
  # @param [String] quota_user
@@ -2111,9 +2573,9 @@ module Google
2111
2573
  # properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
2112
2574
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] google_analytics_admin_v1alpha_enhanced_measurement_settings_object
2113
2575
  # @param [String] update_mask
2114
- # Required. The list of fields to be updated. Omitted fields will not be updated.
2115
- # To replace the entire entity, use one path with the string "*" to match all
2116
- # fields.
2576
+ # Required. The list of fields to be updated. Field names must be in snake case (
2577
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
2578
+ # entire entity, use one path with the string "*" to match all fields.
2117
2579
  # @param [String] fields
2118
2580
  # Selector specifying which fields to include in a partial response.
2119
2581
  # @param [String] quota_user