-
Notifications
You must be signed in to change notification settings - Fork 865
/
classes.rb
1362 lines (1129 loc) · 56.9 KB
/
classes.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module AnalyticsadminV1alpha
# A resource message representing a Google Analytics account.
class GoogleAnalyticsAdminV1alphaAccount
include Google::Apis::Core::Hashable
# Country of business. Must be a non-deprecated code for a UN M.49 region. https:
# //unicode.org/cldr/charts/latest/supplem // ental/
# territory_containment_un_m_49.html
# Corresponds to the JSON property `countryCode`
# @return [String]
attr_accessor :country_code
# Output only. Time when this account was originally created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. Indicates whether this Account is soft-deleted or not. Deleted
# accounts are excluded from List results unless specifically requested.
# Corresponds to the JSON property `deleted`
# @return [Boolean]
attr_accessor :deleted
alias_method :deleted?, :deleted
# Required. Human-readable display name for this account.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Output only. Resource name of this account. Format: accounts/`account` Example:
# "accounts/100"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. Time when account payload fields were last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@country_code = args[:country_code] if args.key?(:country_code)
@create_time = args[:create_time] if args.key?(:create_time)
@deleted = args[:deleted] if args.key?(:deleted)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# A virtual resource representing an overview of an account and all its child
# GA4 properties.
class GoogleAnalyticsAdminV1alphaAccountSummary
include Google::Apis::Core::Hashable
# Resource name of account referred to by this account summary Format: accounts/`
# account_id` Example: "accounts/1000"
# Corresponds to the JSON property `account`
# @return [String]
attr_accessor :account
# Display name for the account referred to in this account summary.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Resource name for this account summary. Format: accountSummaries/`account_id`
# Example: "accountSummaries/1000"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# List of summaries for child accounts of this account.
# Corresponds to the JSON property `propertySummaries`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaPropertySummary>]
attr_accessor :property_summaries
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@account = args[:account] if args.key?(:account)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@property_summaries = args[:property_summaries] if args.key?(:property_summaries)
end
end
# A resource message representing a Google Analytics Android app stream.
class GoogleAnalyticsAdminV1alphaAndroidAppDataStream
include Google::Apis::Core::Hashable
# Output only. Time when this stream was originally created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Human-readable display name for the Data Stream. The max allowed display name
# length is 255 UTF-16 code units.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Output only. ID of the corresponding Android app in Firebase, if any. This ID
# can change if the Android app is deleted and recreated.
# Corresponds to the JSON property `firebaseAppId`
# @return [String]
attr_accessor :firebase_app_id
# Output only. Resource name of this Data Stream. Format: properties/`
# property_id`/androidAppDataStreams/`stream_id` Example: "properties/1000/
# androidAppDataStreams/2000"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Immutable. The package name for the app being measured. Example: "com.example.
# myandroidapp"
# Corresponds to the JSON property `packageName`
# @return [String]
attr_accessor :package_name
# Output only. Time when stream payload fields were last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@display_name = args[:display_name] if args.key?(:display_name)
@firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
@name = args[:name] if args.key?(:name)
@package_name = args[:package_name] if args.key?(:package_name)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# Read-only resource used to summarize a principal's effective roles.
class GoogleAnalyticsAdminV1alphaAuditUserLink
include Google::Apis::Core::Hashable
# Roles directly assigned to this user for this entity. Format: predefinedRoles/
# read Excludes roles that are inherited from an account (if this is for a
# property), group, or organization admin role.
# Corresponds to the JSON property `directRoles`
# @return [Array<String>]
attr_accessor :direct_roles
# Union of all permissions a user has at this account or property (includes
# direct permissions, group-inherited permissions, etc.). Format:
# predefinedRoles/read
# Corresponds to the JSON property `effectiveRoles`
# @return [Array<String>]
attr_accessor :effective_roles
# Email address of the linked user
# Corresponds to the JSON property `emailAddress`
# @return [String]
attr_accessor :email_address
# Example format: properties/1234/userLinks/5678
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@direct_roles = args[:direct_roles] if args.key?(:direct_roles)
@effective_roles = args[:effective_roles] if args.key?(:effective_roles)
@email_address = args[:email_address] if args.key?(:email_address)
@name = args[:name] if args.key?(:name)
end
end
# Request message for AuditUserLinks RPC.
class GoogleAnalyticsAdminV1alphaAuditUserLinksRequest
include Google::Apis::Core::Hashable
# The maximum number of user links to return. The service may return fewer than
# this value. If unspecified, at most 1000 user links will be returned. The
# maximum value is 5000; values above 5000 will be coerced to 5000.
# Corresponds to the JSON property `pageSize`
# @return [Fixnum]
attr_accessor :page_size
# A page token, received from a previous `AuditUserLinks` call. Provide this to
# retrieve the subsequent page. When paginating, all other parameters provided
# to `AuditUserLinks` must match the call that provided the page token.
# Corresponds to the JSON property `pageToken`
# @return [String]
attr_accessor :page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@page_size = args[:page_size] if args.key?(:page_size)
@page_token = args[:page_token] if args.key?(:page_token)
end
end
# Response message for AuditUserLinks RPC.
class GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
include Google::Apis::Core::Hashable
# A token, which can be sent as `page_token` to retrieve the next page. If this
# field is omitted, there are no subsequent pages.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# List of AuditUserLinks. These will be ordered stably, but in an arbitrary
# order.
# Corresponds to the JSON property `userLinks`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLink>]
attr_accessor :user_links
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@user_links = args[:user_links] if args.key?(:user_links)
end
end
# Request message for BatchCreateUserLinks RPC.
class GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest
include Google::Apis::Core::Hashable
# Optional. If set, then email the new users notifying them that they've been
# granted permissions to the resource. Regardless of whether this is set or not,
# notify_new_user field inside each individual request is ignored.
# Corresponds to the JSON property `notifyNewUsers`
# @return [Boolean]
attr_accessor :notify_new_users
alias_method :notify_new_users?, :notify_new_users
# Required. The requests specifying the user links to create. A maximum of 1000
# user links can be created in a batch.
# Corresponds to the JSON property `requests`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateUserLinkRequest>]
attr_accessor :requests
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@notify_new_users = args[:notify_new_users] if args.key?(:notify_new_users)
@requests = args[:requests] if args.key?(:requests)
end
end
# Response message for BatchCreateUserLinks RPC.
class GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
include Google::Apis::Core::Hashable
# The user links created.
# Corresponds to the JSON property `userLinks`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink>]
attr_accessor :user_links
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@user_links = args[:user_links] if args.key?(:user_links)
end
end
# Request message for BatchDeleteUserLinks RPC.
class GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest
include Google::Apis::Core::Hashable
# Required. The requests specifying the user links to update. A maximum of 1000
# user links can be updated in a batch.
# Corresponds to the JSON property `requests`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest>]
attr_accessor :requests
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@requests = args[:requests] if args.key?(:requests)
end
end
# Response message for BatchGetUserLinks RPC.
class GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
include Google::Apis::Core::Hashable
# The requested user links.
# Corresponds to the JSON property `userLinks`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink>]
attr_accessor :user_links
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@user_links = args[:user_links] if args.key?(:user_links)
end
end
# Request message for BatchUpdateUserLinks RPC.
class GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest
include Google::Apis::Core::Hashable
# Required. The requests specifying the user links to update. A maximum of 1000
# user links can be updated in a batch.
# Corresponds to the JSON property `requests`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest>]
attr_accessor :requests
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@requests = args[:requests] if args.key?(:requests)
end
end
# Response message for BatchUpdateUserLinks RPC.
class GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
include Google::Apis::Core::Hashable
# The user links updated.
# Corresponds to the JSON property `userLinks`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink>]
attr_accessor :user_links
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@user_links = args[:user_links] if args.key?(:user_links)
end
end
# Request message for CreateUserLink RPC. Users can have multiple email
# addresses associated with their Google account, and one of these email
# addresses is the "primary" email address. Any of the email addresses
# associated with a Google account may be used for a new UserLink, but the
# returned UserLink will always contain the "primary" email address. As a result,
# the input and output email address for this request may differ.
class GoogleAnalyticsAdminV1alphaCreateUserLinkRequest
include Google::Apis::Core::Hashable
# Optional. If set, then email the new user notifying them that they've been
# granted permissions to the resource.
# Corresponds to the JSON property `notifyNewUser`
# @return [Boolean]
attr_accessor :notify_new_user
alias_method :notify_new_user?, :notify_new_user
# Required. Example format: accounts/1234
# Corresponds to the JSON property `parent`
# @return [String]
attr_accessor :parent
# A resource message representing a user's permissions on an Account or Property
# resource.
# Corresponds to the JSON property `userLink`
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
attr_accessor :user_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@notify_new_user = args[:notify_new_user] if args.key?(:notify_new_user)
@parent = args[:parent] if args.key?(:parent)
@user_link = args[:user_link] if args.key?(:user_link)
end
end
# A resource message representing data sharing settings of a Google Analytics
# account.
class GoogleAnalyticsAdminV1alphaDataSharingSettings
include Google::Apis::Core::Hashable
# Output only. Resource name. Format: accounts/`account`/dataSharingSettings
# Example: "accounts/1000/dataSharingSettings"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Allows any of Google sales to access the data in order to suggest
# configuration changes to improve results.
# Corresponds to the JSON property `sharingWithGoogleAnySalesEnabled`
# @return [Boolean]
attr_accessor :sharing_with_google_any_sales_enabled
alias_method :sharing_with_google_any_sales_enabled?, :sharing_with_google_any_sales_enabled
# Allows Google sales teams that are assigned to the customer to access the data
# in order to suggest configuration changes to improve results. Sales team
# restrictions still apply when enabled.
# Corresponds to the JSON property `sharingWithGoogleAssignedSalesEnabled`
# @return [Boolean]
attr_accessor :sharing_with_google_assigned_sales_enabled
alias_method :sharing_with_google_assigned_sales_enabled?, :sharing_with_google_assigned_sales_enabled
# Allows Google to use the data to improve other Google products or services.
# Corresponds to the JSON property `sharingWithGoogleProductsEnabled`
# @return [Boolean]
attr_accessor :sharing_with_google_products_enabled
alias_method :sharing_with_google_products_enabled?, :sharing_with_google_products_enabled
# Allows Google support to access the data in order to help troubleshoot issues.
# Corresponds to the JSON property `sharingWithGoogleSupportEnabled`
# @return [Boolean]
attr_accessor :sharing_with_google_support_enabled
alias_method :sharing_with_google_support_enabled?, :sharing_with_google_support_enabled
# Allows Google to share the data anonymously in aggregate form with others.
# Corresponds to the JSON property `sharingWithOthersEnabled`
# @return [Boolean]
attr_accessor :sharing_with_others_enabled
alias_method :sharing_with_others_enabled?, :sharing_with_others_enabled
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@sharing_with_google_any_sales_enabled = args[:sharing_with_google_any_sales_enabled] if args.key?(:sharing_with_google_any_sales_enabled)
@sharing_with_google_assigned_sales_enabled = args[:sharing_with_google_assigned_sales_enabled] if args.key?(:sharing_with_google_assigned_sales_enabled)
@sharing_with_google_products_enabled = args[:sharing_with_google_products_enabled] if args.key?(:sharing_with_google_products_enabled)
@sharing_with_google_support_enabled = args[:sharing_with_google_support_enabled] if args.key?(:sharing_with_google_support_enabled)
@sharing_with_others_enabled = args[:sharing_with_others_enabled] if args.key?(:sharing_with_others_enabled)
end
end
# Request message for DeleteUserLink RPC.
class GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest
include Google::Apis::Core::Hashable
# Required. Example format: accounts/1234/userLinks/5678
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
end
end
# Singleton resource under a WebDataStream, configuring measurement of
# additional site interactions and content.
class GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
include Google::Apis::Core::Hashable
# Capture events when your visitors view content on your site that has articles
# or blog posts.
# Corresponds to the JSON property `articlesAndBlogsEnabled`
# @return [Boolean]
attr_accessor :articles_and_blogs_enabled
alias_method :articles_and_blogs_enabled?, :articles_and_blogs_enabled
# Capture events when your visitors view content on your site that has
# structured data (eg, articles, blog posts, product details screens, etc.).
# Corresponds to the JSON property `contentViewsEnabled`
# @return [Boolean]
attr_accessor :content_views_enabled
alias_method :content_views_enabled?, :content_views_enabled
# If enabled, capture a click event each time a visitor clicks a link or element
# that has data attributes beginning with "data-ga".
# Corresponds to the JSON property `dataTaggedElementClicksEnabled`
# @return [Boolean]
attr_accessor :data_tagged_element_clicks_enabled
alias_method :data_tagged_element_clicks_enabled?, :data_tagged_element_clicks_enabled
# Domains to exclude from measurement. Max length is 1024 characters.
# Corresponds to the JSON property `excludedDomains`
# @return [String]
attr_accessor :excluded_domains
# If enabled, capture a file download event each time a link is clicked with a
# common document, compressed file, application, video, or audio extension.
# Corresponds to the JSON property `fileDownloadsEnabled`
# @return [Boolean]
attr_accessor :file_downloads_enabled
alias_method :file_downloads_enabled?, :file_downloads_enabled
# If enabled, capture a view search results event each time a visitor interacts
# with a form on your site.
# Corresponds to the JSON property `formInteractionsEnabled`
# @return [Boolean]
attr_accessor :form_interactions_enabled
alias_method :form_interactions_enabled?, :form_interactions_enabled
# Output only. Resource name of this Data Stream. Format: properties/`
# property_id`/webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "
# properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# If enabled, capture an outbound click event each time a visitor clicks a link
# that leads them away from your domain.
# Corresponds to the JSON property `outboundClicksEnabled`
# @return [Boolean]
attr_accessor :outbound_clicks_enabled
alias_method :outbound_clicks_enabled?, :outbound_clicks_enabled
# If enabled, capture a page view event each time the website changes the
# browser history state.
# Corresponds to the JSON property `pageChangesEnabled`
# @return [Boolean]
attr_accessor :page_changes_enabled
alias_method :page_changes_enabled?, :page_changes_enabled
# If enabled, capture a page view event each time a page loads.
# Corresponds to the JSON property `pageLoadsEnabled`
# @return [Boolean]
attr_accessor :page_loads_enabled
alias_method :page_loads_enabled?, :page_loads_enabled
# Output only. If enabled, capture a page view event each time a page loads or
# the website changes the browser history state.
# Corresponds to the JSON property `pageViewsEnabled`
# @return [Boolean]
attr_accessor :page_views_enabled
alias_method :page_views_enabled?, :page_views_enabled
# Capture events when your visitors view content on your site that has product
# details screens, etc.
# Corresponds to the JSON property `productsAndEcommerceEnabled`
# @return [Boolean]
attr_accessor :products_and_ecommerce_enabled
alias_method :products_and_ecommerce_enabled?, :products_and_ecommerce_enabled
# If enabled, capture scroll events each time a visitor gets to the bottom of a
# page.
# Corresponds to the JSON property `scrollsEnabled`
# @return [Boolean]
attr_accessor :scrolls_enabled
alias_method :scrolls_enabled?, :scrolls_enabled
# Required. URL query parameters to interpret as site search parameters. Max
# length is 1024 characters. Must not be empty.
# Corresponds to the JSON property `searchQueryParameter`
# @return [String]
attr_accessor :search_query_parameter
# If enabled, capture a view search results event each time a visitor performs a
# search on your site (based on a query parameter).
# Corresponds to the JSON property `siteSearchEnabled`
# @return [Boolean]
attr_accessor :site_search_enabled
alias_method :site_search_enabled?, :site_search_enabled
# Indicates whether Enhanced Measurement Settings will be used to automatically
# measure interactions and content on this web stream. Changing this value does
# not affect the settings themselves, but determines whether they are respected.
# Corresponds to the JSON property `streamEnabled`
# @return [Boolean]
attr_accessor :stream_enabled
alias_method :stream_enabled?, :stream_enabled
# Additional URL query parameters. Max length is 1024 characters.
# Corresponds to the JSON property `urlQueryParameter`
# @return [String]
attr_accessor :url_query_parameter
# If enabled, capture video play, progress, and complete events as visitors view
# embedded videos on your site.
# Corresponds to the JSON property `videoEngagementEnabled`
# @return [Boolean]
attr_accessor :video_engagement_enabled
alias_method :video_engagement_enabled?, :video_engagement_enabled
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@articles_and_blogs_enabled = args[:articles_and_blogs_enabled] if args.key?(:articles_and_blogs_enabled)
@content_views_enabled = args[:content_views_enabled] if args.key?(:content_views_enabled)
@data_tagged_element_clicks_enabled = args[:data_tagged_element_clicks_enabled] if args.key?(:data_tagged_element_clicks_enabled)
@excluded_domains = args[:excluded_domains] if args.key?(:excluded_domains)
@file_downloads_enabled = args[:file_downloads_enabled] if args.key?(:file_downloads_enabled)
@form_interactions_enabled = args[:form_interactions_enabled] if args.key?(:form_interactions_enabled)
@name = args[:name] if args.key?(:name)
@outbound_clicks_enabled = args[:outbound_clicks_enabled] if args.key?(:outbound_clicks_enabled)
@page_changes_enabled = args[:page_changes_enabled] if args.key?(:page_changes_enabled)
@page_loads_enabled = args[:page_loads_enabled] if args.key?(:page_loads_enabled)
@page_views_enabled = args[:page_views_enabled] if args.key?(:page_views_enabled)
@products_and_ecommerce_enabled = args[:products_and_ecommerce_enabled] if args.key?(:products_and_ecommerce_enabled)
@scrolls_enabled = args[:scrolls_enabled] if args.key?(:scrolls_enabled)
@search_query_parameter = args[:search_query_parameter] if args.key?(:search_query_parameter)
@site_search_enabled = args[:site_search_enabled] if args.key?(:site_search_enabled)
@stream_enabled = args[:stream_enabled] if args.key?(:stream_enabled)
@url_query_parameter = args[:url_query_parameter] if args.key?(:url_query_parameter)
@video_engagement_enabled = args[:video_engagement_enabled] if args.key?(:video_engagement_enabled)
end
end
# A link between an GA4 property and a Firebase project.
class GoogleAnalyticsAdminV1alphaFirebaseLink
include Google::Apis::Core::Hashable
# Output only. Time when this FirebaseLink was originally created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Maximum user access to the GA4 property allowed to admins of the linked
# Firebase project.
# Corresponds to the JSON property `maximumUserAccess`
# @return [String]
attr_accessor :maximum_user_access
# Output only. Example format: properties/1234/firebaseLinks/5678
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Immutable. Firebase project resource name. When creating a FirebaseLink, you
# may provide this resource name using either a project number or project ID.
# Once this resource has been created, returned FirebaseLinks will always have a
# project_name that contains a project number. Format: 'projects/`project number`
# ' Example: 'projects/1234'
# Corresponds to the JSON property `project`
# @return [String]
attr_accessor :project
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@maximum_user_access = args[:maximum_user_access] if args.key?(:maximum_user_access)
@name = args[:name] if args.key?(:name)
@project = args[:project] if args.key?(:project)
end
end
# Read-only resource with the tag for sending data from a website to a
# WebDataStream.
class GoogleAnalyticsAdminV1alphaGlobalSiteTag
include Google::Apis::Core::Hashable
# Immutable. JavaScript code snippet to be pasted as the first item into the
# head tag of every webpage to measure.
# Corresponds to the JSON property `snippet`
# @return [String]
attr_accessor :snippet
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@snippet = args[:snippet] if args.key?(:snippet)
end
end
# A link between an GA4 property and a Google Ads account.
class GoogleAnalyticsAdminV1alphaGoogleAdsLink
include Google::Apis::Core::Hashable
# Enable personalized advertising features with this integration. Automatically
# publish my Google Analytics audience lists and Google Analytics remarketing
# events/parameters to the linked Google Ads account. If this field is not set
# on create/update it will be defaulted to true.
# Corresponds to the JSON property `adsPersonalizationEnabled`
# @return [Boolean]
attr_accessor :ads_personalization_enabled
alias_method :ads_personalization_enabled?, :ads_personalization_enabled
# Output only. If true, this link is for a Google Ads manager account.
# Corresponds to the JSON property `canManageClients`
# @return [Boolean]
attr_accessor :can_manage_clients
alias_method :can_manage_clients?, :can_manage_clients
# Output only. Time when this link was originally created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Immutable. Google Ads customer ID.
# Corresponds to the JSON property `customerId`
# @return [String]
attr_accessor :customer_id
# Output only. Email address of the user that created the link. An empty string
# will be returned if the email address can't be retrieved.
# Corresponds to the JSON property `emailAddress`
# @return [String]
attr_accessor :email_address
# Output only. Format: properties/`propertyId`/googleAdsLinks/`googleAdsLinkId`
# Note: googleAdsLinkId is not the Google Ads customer ID.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Immutable. Format: properties/`propertyId`
# Corresponds to the JSON property `parent`
# @return [String]
attr_accessor :parent
# Output only. Time when this link was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
@can_manage_clients = args[:can_manage_clients] if args.key?(:can_manage_clients)
@create_time = args[:create_time] if args.key?(:create_time)
@customer_id = args[:customer_id] if args.key?(:customer_id)
@email_address = args[:email_address] if args.key?(:email_address)
@name = args[:name] if args.key?(:name)
@parent = args[:parent] if args.key?(:parent)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# A resource message representing a Google Analytics IOS app stream.
class GoogleAnalyticsAdminV1alphaIosAppDataStream
include Google::Apis::Core::Hashable
# Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.
# example.myiosapp"
# Corresponds to the JSON property `bundleId`
# @return [String]
attr_accessor :bundle_id
# Output only. Time when this stream was originally created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Human-readable display name for the Data Stream. The max allowed display name
# length is 255 UTF-16 code units.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Output only. ID of the corresponding iOS app in Firebase, if any. This ID can
# change if the iOS app is deleted and recreated.
# Corresponds to the JSON property `firebaseAppId`
# @return [String]
attr_accessor :firebase_app_id
# Output only. Resource name of this Data Stream. Format: properties/`
# property_id`/iosAppDataStreams/`stream_id` Example: "properties/1000/
# iosAppDataStreams/2000"
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. Time when stream payload fields were last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bundle_id = args[:bundle_id] if args.key?(:bundle_id)
@create_time = args[:create_time] if args.key?(:create_time)
@display_name = args[:display_name] if args.key?(:display_name)
@firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
@name = args[:name] if args.key?(:name)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# Response message for ListAccountSummaries RPC.
class GoogleAnalyticsAdminV1alphaListAccountSummariesResponse
include Google::Apis::Core::Hashable
# Account summaries of all accounts the caller has access to.
# Corresponds to the JSON property `accountSummaries`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccountSummary>]
attr_accessor :account_summaries
# A token, which can be sent as `page_token` to retrieve the next page. If this
# field is omitted, there are no subsequent pages.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@account_summaries = args[:account_summaries] if args.key?(:account_summaries)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for ListAccounts RPC.
class GoogleAnalyticsAdminV1alphaListAccountsResponse
include Google::Apis::Core::Hashable
# Results that were accessible to the caller.
# Corresponds to the JSON property `accounts`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount>]
attr_accessor :accounts
# A token, which can be sent as `page_token` to retrieve the next page. If this
# field is omitted, there are no subsequent pages.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accounts = args[:accounts] if args.key?(:accounts)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for ListAndroidDataStreams RPC.
class GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse
include Google::Apis::Core::Hashable
# Results that matched the filter criteria and were accessible to the caller.
# Corresponds to the JSON property `androidAppDataStreams`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream>]
attr_accessor :android_app_data_streams
# A token, which can be sent as `page_token` to retrieve the next page. If this
# field is omitted, there are no subsequent pages.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@android_app_data_streams = args[:android_app_data_streams] if args.key?(:android_app_data_streams)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response message for ListFirebaseLinks RPC
class GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse
include Google::Apis::Core::Hashable
# List of FirebaseLinks. This will have at most one value.
# Corresponds to the JSON property `firebaseLinks`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink>]
attr_accessor :firebase_links
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@firebase_links = args[:firebase_links] if args.key?(:firebase_links)
end
end
# Response message for ListGoogleAdsLinks RPC.
class GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse
include Google::Apis::Core::Hashable
# List of GoogleAdsLinks.
# Corresponds to the JSON property `googleAdsLinks`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink>]
attr_accessor :google_ads_links
# A token, which can be sent as `page_token` to retrieve the next page. If this
# field is omitted, there are no subsequent pages.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@google_ads_links = args[:google_ads_links] if args.key?(:google_ads_links)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for ListIosAppDataStreams RPC.
class GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse
include Google::Apis::Core::Hashable
# Results that matched the filter criteria and were accessible to the caller.
# Corresponds to the JSON property `iosAppDataStreams`
# @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream>]
attr_accessor :ios_app_data_streams
# A token, which can be sent as `page_token` to retrieve the next page. If this
# field is omitted, there are no subsequent pages.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ios_app_data_streams = args[:ios_app_data_streams] if args.key?(:ios_app_data_streams)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response message for ListProperties RPC.