google-apis-analyticsadmin_v1alpha 0.14.0 → 0.26.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.
@@ -114,44 +114,33 @@ module Google
114
114
  end
115
115
  end
116
116
 
117
- # A resource message representing a Google Analytics Android app stream.
118
- class GoogleAnalyticsAdminV1alphaAndroidAppDataStream
117
+ # Request message for AcknowledgeUserDataCollection RPC.
118
+ class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
119
119
  include Google::Apis::Core::Hashable
120
120
 
121
- # Output only. Time when this stream was originally created.
122
- # Corresponds to the JSON property `createTime`
121
+ # Required. An acknowledgement that the caller of this method understands the
122
+ # terms of user data collection. This field must contain the exact value: "I
123
+ # acknowledge that I have the necessary privacy disclosures and rights from my
124
+ # end users for the collection and processing of their data, including the
125
+ # association of such data with the visitation information Google Analytics
126
+ # collects from my site and/or app property."
127
+ # Corresponds to the JSON property `acknowledgement`
123
128
  # @return [String]
124
- attr_accessor :create_time
125
-
126
- # Human-readable display name for the Data Stream. The max allowed display name
127
- # length is 255 UTF-16 code units.
128
- # Corresponds to the JSON property `displayName`
129
- # @return [String]
130
- attr_accessor :display_name
131
-
132
- # Output only. ID of the corresponding Android app in Firebase, if any. This ID
133
- # can change if the Android app is deleted and recreated.
134
- # Corresponds to the JSON property `firebaseAppId`
135
- # @return [String]
136
- attr_accessor :firebase_app_id
129
+ attr_accessor :acknowledgement
137
130
 
138
- # Output only. Resource name of this Data Stream. Format: properties/`
139
- # property_id`/androidAppDataStreams/`stream_id` Example: "properties/1000/
140
- # androidAppDataStreams/2000"
141
- # Corresponds to the JSON property `name`
142
- # @return [String]
143
- attr_accessor :name
131
+ def initialize(**args)
132
+ update!(**args)
133
+ end
144
134
 
145
- # Immutable. The package name for the app being measured. Example: "com.example.
146
- # myandroidapp"
147
- # Corresponds to the JSON property `packageName`
148
- # @return [String]
149
- attr_accessor :package_name
135
+ # Update properties of this object
136
+ def update!(**args)
137
+ @acknowledgement = args[:acknowledgement] if args.key?(:acknowledgement)
138
+ end
139
+ end
150
140
 
151
- # Output only. Time when stream payload fields were last updated.
152
- # Corresponds to the JSON property `updateTime`
153
- # @return [String]
154
- attr_accessor :update_time
141
+ # Response message for AcknowledgeUserDataCollection RPC.
142
+ class GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
143
+ include Google::Apis::Core::Hashable
155
144
 
156
145
  def initialize(**args)
157
146
  update!(**args)
@@ -159,12 +148,6 @@ module Google
159
148
 
160
149
  # Update properties of this object
161
150
  def update!(**args)
162
- @create_time = args[:create_time] if args.key?(:create_time)
163
- @display_name = args[:display_name] if args.key?(:display_name)
164
- @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
165
- @name = args[:name] if args.key?(:name)
166
- @package_name = args[:package_name] if args.key?(:package_name)
167
- @update_time = args[:update_time] if args.key?(:update_time)
168
151
  end
169
152
  end
170
153
 
@@ -231,7 +214,7 @@ module Google
231
214
  include Google::Apis::Core::Hashable
232
215
 
233
216
  # Roles directly assigned to this user for this entity. Format: predefinedRoles/
234
- # read Excludes roles that are inherited from an account (if this is for a
217
+ # viewer Excludes roles that are inherited from an account (if this is for a
235
218
  # property), group, or organization admin role.
236
219
  # Corresponds to the JSON property `directRoles`
237
220
  # @return [Array<String>]
@@ -239,7 +222,7 @@ module Google
239
222
 
240
223
  # Union of all permissions a user has at this account or property (includes
241
224
  # direct permissions, group-inherited permissions, etc.). Format:
242
- # predefinedRoles/read
225
+ # predefinedRoles/viewer
243
226
  # Corresponds to the JSON property `effectiveRoles`
244
227
  # @return [Array<String>]
245
228
  attr_accessor :effective_roles
@@ -511,11 +494,6 @@ module Google
511
494
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount]
512
495
  attr_accessor :account
513
496
 
514
- # A resource message representing a Google Analytics Android app stream.
515
- # Corresponds to the JSON property `androidAppDataStream`
516
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
517
- attr_accessor :android_app_data_stream
518
-
519
497
  # A conversion event in a Google Analytics property.
520
498
  # Corresponds to the JSON property `conversionEvent`
521
499
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent]
@@ -536,12 +514,17 @@ module Google
536
514
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRetentionSettings]
537
515
  attr_accessor :data_retention_settings
538
516
 
517
+ # A resource message representing a data stream.
518
+ # Corresponds to the JSON property `dataStream`
519
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream]
520
+ attr_accessor :data_stream
521
+
539
522
  # A link between a GA4 property and a Display & Video 360 advertiser.
540
523
  # Corresponds to the JSON property `displayVideo360AdvertiserLink`
541
524
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink]
542
525
  attr_accessor :display_video360_advertiser_link
543
526
 
544
- # A proposal for a link between an GA4 property and a Display & Video 360
527
+ # A proposal for a link between a GA4 property and a Display & Video 360
545
528
  # advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once
546
529
  # approved. Google Analytics admins approve inbound proposals while Display &
547
530
  # Video 360 admins approve outbound proposals.
@@ -549,12 +532,12 @@ module Google
549
532
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal]
550
533
  attr_accessor :display_video360_advertiser_link_proposal
551
534
 
552
- # A link between an GA4 property and a Firebase project.
535
+ # A link between a GA4 property and a Firebase project.
553
536
  # Corresponds to the JSON property `firebaseLink`
554
537
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink]
555
538
  attr_accessor :firebase_link
556
539
 
557
- # A link between an GA4 property and a Google Ads account.
540
+ # A link between a GA4 property and a Google Ads account.
558
541
  # Corresponds to the JSON property `googleAdsLink`
559
542
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink]
560
543
  attr_accessor :google_ads_link
@@ -564,11 +547,6 @@ module Google
564
547
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleSignalsSettings]
565
548
  attr_accessor :google_signals_settings
566
549
 
567
- # A resource message representing a Google Analytics IOS app stream.
568
- # Corresponds to the JSON property `iosAppDataStream`
569
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
570
- attr_accessor :ios_app_data_stream
571
-
572
550
  # A secret value used for sending hits to Measurement Protocol.
573
551
  # Corresponds to the JSON property `measurementProtocolSecret`
574
552
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret]
@@ -579,11 +557,6 @@ module Google
579
557
  # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
580
558
  attr_accessor :property
581
559
 
582
- # A resource message representing a Google Analytics web stream.
583
- # Corresponds to the JSON property `webDataStream`
584
- # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
585
- attr_accessor :web_data_stream
586
-
587
560
  def initialize(**args)
588
561
  update!(**args)
589
562
  end
@@ -591,20 +564,18 @@ module Google
591
564
  # Update properties of this object
592
565
  def update!(**args)
593
566
  @account = args[:account] if args.key?(:account)
594
- @android_app_data_stream = args[:android_app_data_stream] if args.key?(:android_app_data_stream)
595
567
  @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
596
568
  @custom_dimension = args[:custom_dimension] if args.key?(:custom_dimension)
597
569
  @custom_metric = args[:custom_metric] if args.key?(:custom_metric)
598
570
  @data_retention_settings = args[:data_retention_settings] if args.key?(:data_retention_settings)
571
+ @data_stream = args[:data_stream] if args.key?(:data_stream)
599
572
  @display_video360_advertiser_link = args[:display_video360_advertiser_link] if args.key?(:display_video360_advertiser_link)
600
573
  @display_video360_advertiser_link_proposal = args[:display_video360_advertiser_link_proposal] if args.key?(:display_video360_advertiser_link_proposal)
601
574
  @firebase_link = args[:firebase_link] if args.key?(:firebase_link)
602
575
  @google_ads_link = args[:google_ads_link] if args.key?(:google_ads_link)
603
576
  @google_signals_settings = args[:google_signals_settings] if args.key?(:google_signals_settings)
604
- @ios_app_data_stream = args[:ios_app_data_stream] if args.key?(:ios_app_data_stream)
605
577
  @measurement_protocol_secret = args[:measurement_protocol_secret] if args.key?(:measurement_protocol_secret)
606
578
  @property = args[:property] if args.key?(:property)
607
- @web_data_stream = args[:web_data_stream] if args.key?(:web_data_stream)
608
579
  end
609
580
  end
610
581
 
@@ -854,6 +825,13 @@ module Google
854
825
  # @return [String]
855
826
  attr_accessor :parameter_name
856
827
 
828
+ # Optional. Types of restricted data that this metric may contain. Required for
829
+ # metrics with CURRENCY measurement unit. Must be empty for metrics with a non-
830
+ # CURRENCY measurement unit.
831
+ # Corresponds to the JSON property `restrictedMetricType`
832
+ # @return [Array<String>]
833
+ attr_accessor :restricted_metric_type
834
+
857
835
  # Required. Immutable. The scope of this custom metric.
858
836
  # Corresponds to the JSON property `scope`
859
837
  # @return [String]
@@ -870,6 +848,7 @@ module Google
870
848
  @measurement_unit = args[:measurement_unit] if args.key?(:measurement_unit)
871
849
  @name = args[:name] if args.key?(:name)
872
850
  @parameter_name = args[:parameter_name] if args.key?(:parameter_name)
851
+ @restricted_metric_type = args[:restricted_metric_type] if args.key?(:restricted_metric_type)
873
852
  @scope = args[:scope] if args.key?(:scope)
874
853
  end
875
854
  end
@@ -967,6 +946,158 @@ module Google
967
946
  end
968
947
  end
969
948
 
949
+ # A resource message representing a data stream.
950
+ class GoogleAnalyticsAdminV1alphaDataStream
951
+ include Google::Apis::Core::Hashable
952
+
953
+ # Data specific to Android app streams.
954
+ # Corresponds to the JSON property `androidAppStreamData`
955
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData]
956
+ attr_accessor :android_app_stream_data
957
+
958
+ # Output only. Time when this stream was originally created.
959
+ # Corresponds to the JSON property `createTime`
960
+ # @return [String]
961
+ attr_accessor :create_time
962
+
963
+ # Human-readable display name for the Data Stream. Required for web data streams.
964
+ # The max allowed display name length is 255 UTF-16 code units.
965
+ # Corresponds to the JSON property `displayName`
966
+ # @return [String]
967
+ attr_accessor :display_name
968
+
969
+ # Data specific to iOS app streams.
970
+ # Corresponds to the JSON property `iosAppStreamData`
971
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData]
972
+ attr_accessor :ios_app_stream_data
973
+
974
+ # Output only. Resource name of this Data Stream. Format: properties/`
975
+ # property_id`/dataStreams/`stream_id` Example: "properties/1000/dataStreams/
976
+ # 2000"
977
+ # Corresponds to the JSON property `name`
978
+ # @return [String]
979
+ attr_accessor :name
980
+
981
+ # Required. Immutable. The type of this DataStream resource.
982
+ # Corresponds to the JSON property `type`
983
+ # @return [String]
984
+ attr_accessor :type
985
+
986
+ # Output only. Time when stream payload fields were last updated.
987
+ # Corresponds to the JSON property `updateTime`
988
+ # @return [String]
989
+ attr_accessor :update_time
990
+
991
+ # Data specific to web streams.
992
+ # Corresponds to the JSON property `webStreamData`
993
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStreamWebStreamData]
994
+ attr_accessor :web_stream_data
995
+
996
+ def initialize(**args)
997
+ update!(**args)
998
+ end
999
+
1000
+ # Update properties of this object
1001
+ def update!(**args)
1002
+ @android_app_stream_data = args[:android_app_stream_data] if args.key?(:android_app_stream_data)
1003
+ @create_time = args[:create_time] if args.key?(:create_time)
1004
+ @display_name = args[:display_name] if args.key?(:display_name)
1005
+ @ios_app_stream_data = args[:ios_app_stream_data] if args.key?(:ios_app_stream_data)
1006
+ @name = args[:name] if args.key?(:name)
1007
+ @type = args[:type] if args.key?(:type)
1008
+ @update_time = args[:update_time] if args.key?(:update_time)
1009
+ @web_stream_data = args[:web_stream_data] if args.key?(:web_stream_data)
1010
+ end
1011
+ end
1012
+
1013
+ # Data specific to Android app streams.
1014
+ class GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData
1015
+ include Google::Apis::Core::Hashable
1016
+
1017
+ # Output only. ID of the corresponding Android app in Firebase, if any. This ID
1018
+ # can change if the Android app is deleted and recreated.
1019
+ # Corresponds to the JSON property `firebaseAppId`
1020
+ # @return [String]
1021
+ attr_accessor :firebase_app_id
1022
+
1023
+ # Immutable. The package name for the app being measured. Example: "com.example.
1024
+ # myandroidapp"
1025
+ # Corresponds to the JSON property `packageName`
1026
+ # @return [String]
1027
+ attr_accessor :package_name
1028
+
1029
+ def initialize(**args)
1030
+ update!(**args)
1031
+ end
1032
+
1033
+ # Update properties of this object
1034
+ def update!(**args)
1035
+ @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
1036
+ @package_name = args[:package_name] if args.key?(:package_name)
1037
+ end
1038
+ end
1039
+
1040
+ # Data specific to iOS app streams.
1041
+ class GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData
1042
+ include Google::Apis::Core::Hashable
1043
+
1044
+ # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.
1045
+ # example.myiosapp"
1046
+ # Corresponds to the JSON property `bundleId`
1047
+ # @return [String]
1048
+ attr_accessor :bundle_id
1049
+
1050
+ # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can
1051
+ # change if the iOS app is deleted and recreated.
1052
+ # Corresponds to the JSON property `firebaseAppId`
1053
+ # @return [String]
1054
+ attr_accessor :firebase_app_id
1055
+
1056
+ def initialize(**args)
1057
+ update!(**args)
1058
+ end
1059
+
1060
+ # Update properties of this object
1061
+ def update!(**args)
1062
+ @bundle_id = args[:bundle_id] if args.key?(:bundle_id)
1063
+ @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
1064
+ end
1065
+ end
1066
+
1067
+ # Data specific to web streams.
1068
+ class GoogleAnalyticsAdminV1alphaDataStreamWebStreamData
1069
+ include Google::Apis::Core::Hashable
1070
+
1071
+ # Immutable. Domain name of the web app being measured, or empty. Example: "http:
1072
+ # //www.google.com", "https://www.google.com"
1073
+ # Corresponds to the JSON property `defaultUri`
1074
+ # @return [String]
1075
+ attr_accessor :default_uri
1076
+
1077
+ # Output only. ID of the corresponding web app in Firebase, if any. This ID can
1078
+ # change if the web app is deleted and recreated.
1079
+ # Corresponds to the JSON property `firebaseAppId`
1080
+ # @return [String]
1081
+ attr_accessor :firebase_app_id
1082
+
1083
+ # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-
1084
+ # 1A2BCD345E" would just be "1A2BCD345E"
1085
+ # Corresponds to the JSON property `measurementId`
1086
+ # @return [String]
1087
+ attr_accessor :measurement_id
1088
+
1089
+ def initialize(**args)
1090
+ update!(**args)
1091
+ end
1092
+
1093
+ # Update properties of this object
1094
+ def update!(**args)
1095
+ @default_uri = args[:default_uri] if args.key?(:default_uri)
1096
+ @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
1097
+ @measurement_id = args[:measurement_id] if args.key?(:measurement_id)
1098
+ end
1099
+ end
1100
+
970
1101
  # Request message for DeleteUserLink RPC.
971
1102
  class GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest
972
1103
  include Google::Apis::Core::Hashable
@@ -1017,7 +1148,7 @@ module Google
1017
1148
  alias_method :campaign_data_sharing_enabled?, :campaign_data_sharing_enabled
1018
1149
 
1019
1150
  # Immutable. Enables the import of cost data from Display & Video 360 into the
1020
- # GA4 property. This can only be enabled if campaign_data_import_enabled is
1151
+ # GA4 property. This can only be enabled if campaign_data_sharing_enabled is
1021
1152
  # enabled. After link creation, this can only be updated from the Display &
1022
1153
  # Video 360 product. If this field is not set on create, it will be defaulted to
1023
1154
  # true.
@@ -1048,7 +1179,7 @@ module Google
1048
1179
  end
1049
1180
  end
1050
1181
 
1051
- # A proposal for a link between an GA4 property and a Display & Video 360
1182
+ # A proposal for a link between a GA4 property and a Display & Video 360
1052
1183
  # advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once
1053
1184
  # approved. Google Analytics admins approve inbound proposals while Display &
1054
1185
  # Video 360 admins approve outbound proposals.
@@ -1081,7 +1212,7 @@ module Google
1081
1212
  alias_method :campaign_data_sharing_enabled?, :campaign_data_sharing_enabled
1082
1213
 
1083
1214
  # Immutable. Enables the import of cost data from Display & Video 360. This can
1084
- # only be enabled if campaign_data_import_enabled is enabled. If this field is
1215
+ # only be enabled if campaign_data_sharing_enabled is enabled. If this field is
1085
1216
  # not set on create, it will be defaulted to true.
1086
1217
  # Corresponds to the JSON property `costDataSharingEnabled`
1087
1218
  # @return [Boolean]
@@ -1128,114 +1259,7 @@ module Google
1128
1259
  end
1129
1260
  end
1130
1261
 
1131
- # Singleton resource under a WebDataStream, configuring measurement of
1132
- # additional site interactions and content.
1133
- class GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
1134
- include Google::Apis::Core::Hashable
1135
-
1136
- # If enabled, capture a file download event each time a link is clicked with a
1137
- # common document, compressed file, application, video, or audio extension.
1138
- # Corresponds to the JSON property `fileDownloadsEnabled`
1139
- # @return [Boolean]
1140
- attr_accessor :file_downloads_enabled
1141
- alias_method :file_downloads_enabled?, :file_downloads_enabled
1142
-
1143
- # Output only. Resource name of this Data Stream. Format: properties/`
1144
- # property_id`/webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "
1145
- # properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
1146
- # Corresponds to the JSON property `name`
1147
- # @return [String]
1148
- attr_accessor :name
1149
-
1150
- # If enabled, capture an outbound click event each time a visitor clicks a link
1151
- # that leads them away from your domain.
1152
- # Corresponds to the JSON property `outboundClicksEnabled`
1153
- # @return [Boolean]
1154
- attr_accessor :outbound_clicks_enabled
1155
- alias_method :outbound_clicks_enabled?, :outbound_clicks_enabled
1156
-
1157
- # If enabled, capture a page view event each time the website changes the
1158
- # browser history state.
1159
- # Corresponds to the JSON property `pageChangesEnabled`
1160
- # @return [Boolean]
1161
- attr_accessor :page_changes_enabled
1162
- alias_method :page_changes_enabled?, :page_changes_enabled
1163
-
1164
- # Output only. If enabled, capture a page view event each time a page loads.
1165
- # Corresponds to the JSON property `pageLoadsEnabled`
1166
- # @return [Boolean]
1167
- attr_accessor :page_loads_enabled
1168
- alias_method :page_loads_enabled?, :page_loads_enabled
1169
-
1170
- # Output only. If enabled, capture a page view event each time a page loads or
1171
- # the website changes the browser history state.
1172
- # Corresponds to the JSON property `pageViewsEnabled`
1173
- # @return [Boolean]
1174
- attr_accessor :page_views_enabled
1175
- alias_method :page_views_enabled?, :page_views_enabled
1176
-
1177
- # If enabled, capture scroll events each time a visitor gets to the bottom of a
1178
- # page.
1179
- # Corresponds to the JSON property `scrollsEnabled`
1180
- # @return [Boolean]
1181
- attr_accessor :scrolls_enabled
1182
- alias_method :scrolls_enabled?, :scrolls_enabled
1183
-
1184
- # Required. URL query parameters to interpret as site search parameters. Max
1185
- # length is 1024 characters. Must not be empty.
1186
- # Corresponds to the JSON property `searchQueryParameter`
1187
- # @return [String]
1188
- attr_accessor :search_query_parameter
1189
-
1190
- # If enabled, capture a view search results event each time a visitor performs a
1191
- # search on your site (based on a query parameter).
1192
- # Corresponds to the JSON property `siteSearchEnabled`
1193
- # @return [Boolean]
1194
- attr_accessor :site_search_enabled
1195
- alias_method :site_search_enabled?, :site_search_enabled
1196
-
1197
- # Indicates whether Enhanced Measurement Settings will be used to automatically
1198
- # measure interactions and content on this web stream. Changing this value does
1199
- # not affect the settings themselves, but determines whether they are respected.
1200
- # Corresponds to the JSON property `streamEnabled`
1201
- # @return [Boolean]
1202
- attr_accessor :stream_enabled
1203
- alias_method :stream_enabled?, :stream_enabled
1204
-
1205
- # Additional URL query parameters. Max length is 1024 characters.
1206
- # Corresponds to the JSON property `uriQueryParameter`
1207
- # @return [String]
1208
- attr_accessor :uri_query_parameter
1209
-
1210
- # If enabled, capture video play, progress, and complete events as visitors view
1211
- # embedded videos on your site.
1212
- # Corresponds to the JSON property `videoEngagementEnabled`
1213
- # @return [Boolean]
1214
- attr_accessor :video_engagement_enabled
1215
- alias_method :video_engagement_enabled?, :video_engagement_enabled
1216
-
1217
- def initialize(**args)
1218
- update!(**args)
1219
- end
1220
-
1221
- # Update properties of this object
1222
- def update!(**args)
1223
- @file_downloads_enabled = args[:file_downloads_enabled] if args.key?(:file_downloads_enabled)
1224
- @name = args[:name] if args.key?(:name)
1225
- @outbound_clicks_enabled = args[:outbound_clicks_enabled] if args.key?(:outbound_clicks_enabled)
1226
- @page_changes_enabled = args[:page_changes_enabled] if args.key?(:page_changes_enabled)
1227
- @page_loads_enabled = args[:page_loads_enabled] if args.key?(:page_loads_enabled)
1228
- @page_views_enabled = args[:page_views_enabled] if args.key?(:page_views_enabled)
1229
- @scrolls_enabled = args[:scrolls_enabled] if args.key?(:scrolls_enabled)
1230
- @search_query_parameter = args[:search_query_parameter] if args.key?(:search_query_parameter)
1231
- @site_search_enabled = args[:site_search_enabled] if args.key?(:site_search_enabled)
1232
- @stream_enabled = args[:stream_enabled] if args.key?(:stream_enabled)
1233
- @uri_query_parameter = args[:uri_query_parameter] if args.key?(:uri_query_parameter)
1234
- @video_engagement_enabled = args[:video_engagement_enabled] if args.key?(:video_engagement_enabled)
1235
- end
1236
- end
1237
-
1238
- # A link between an GA4 property and a Firebase project.
1262
+ # A link between a GA4 property and a Firebase project.
1239
1263
  class GoogleAnalyticsAdminV1alphaFirebaseLink
1240
1264
  include Google::Apis::Core::Hashable
1241
1265
 
@@ -1271,12 +1295,13 @@ module Google
1271
1295
  end
1272
1296
 
1273
1297
  # Read-only resource with the tag for sending data from a website to a
1274
- # WebDataStream.
1298
+ # DataStream. Only present for web DataStream resources.
1275
1299
  class GoogleAnalyticsAdminV1alphaGlobalSiteTag
1276
1300
  include Google::Apis::Core::Hashable
1277
1301
 
1278
1302
  # Output only. Resource name for this GlobalSiteTag resource. Format: properties/
1279
- # `propertyId`/globalSiteTag
1303
+ # `property_id`/dataStreams/`stream_id`/globalSiteTag Example: "properties/123/
1304
+ # dataStreams/456/globalSiteTag"
1280
1305
  # Corresponds to the JSON property `name`
1281
1306
  # @return [String]
1282
1307
  attr_accessor :name
@@ -1298,7 +1323,7 @@ module Google
1298
1323
  end
1299
1324
  end
1300
1325
 
1301
- # A link between an GA4 property and a Google Ads account.
1326
+ # A link between a GA4 property and a Google Ads account.
1302
1327
  class GoogleAnalyticsAdminV1alphaGoogleAdsLink
1303
1328
  include Google::Apis::Core::Hashable
1304
1329
 
@@ -1392,60 +1417,6 @@ module Google
1392
1417
  end
1393
1418
  end
1394
1419
 
1395
- # A resource message representing a Google Analytics IOS app stream.
1396
- class GoogleAnalyticsAdminV1alphaIosAppDataStream
1397
- include Google::Apis::Core::Hashable
1398
-
1399
- # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.
1400
- # example.myiosapp"
1401
- # Corresponds to the JSON property `bundleId`
1402
- # @return [String]
1403
- attr_accessor :bundle_id
1404
-
1405
- # Output only. Time when this stream was originally created.
1406
- # Corresponds to the JSON property `createTime`
1407
- # @return [String]
1408
- attr_accessor :create_time
1409
-
1410
- # Human-readable display name for the Data Stream. The max allowed display name
1411
- # length is 255 UTF-16 code units.
1412
- # Corresponds to the JSON property `displayName`
1413
- # @return [String]
1414
- attr_accessor :display_name
1415
-
1416
- # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can
1417
- # change if the iOS app is deleted and recreated.
1418
- # Corresponds to the JSON property `firebaseAppId`
1419
- # @return [String]
1420
- attr_accessor :firebase_app_id
1421
-
1422
- # Output only. Resource name of this Data Stream. Format: properties/`
1423
- # property_id`/iosAppDataStreams/`stream_id` Example: "properties/1000/
1424
- # iosAppDataStreams/2000"
1425
- # Corresponds to the JSON property `name`
1426
- # @return [String]
1427
- attr_accessor :name
1428
-
1429
- # Output only. Time when stream payload fields were last updated.
1430
- # Corresponds to the JSON property `updateTime`
1431
- # @return [String]
1432
- attr_accessor :update_time
1433
-
1434
- def initialize(**args)
1435
- update!(**args)
1436
- end
1437
-
1438
- # Update properties of this object
1439
- def update!(**args)
1440
- @bundle_id = args[:bundle_id] if args.key?(:bundle_id)
1441
- @create_time = args[:create_time] if args.key?(:create_time)
1442
- @display_name = args[:display_name] if args.key?(:display_name)
1443
- @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
1444
- @name = args[:name] if args.key?(:name)
1445
- @update_time = args[:update_time] if args.key?(:update_time)
1446
- end
1447
- end
1448
-
1449
1420
  # Status information for a link proposal.
1450
1421
  class GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
1451
1422
  include Google::Apis::Core::Hashable
@@ -1529,32 +1500,6 @@ module Google
1529
1500
  end
1530
1501
  end
1531
1502
 
1532
- # Request message for ListAndroidDataStreams RPC.
1533
- class GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse
1534
- include Google::Apis::Core::Hashable
1535
-
1536
- # Results that matched the filter criteria and were accessible to the caller.
1537
- # Corresponds to the JSON property `androidAppDataStreams`
1538
- # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream>]
1539
- attr_accessor :android_app_data_streams
1540
-
1541
- # A token, which can be sent as `page_token` to retrieve the next page. If this
1542
- # field is omitted, there are no subsequent pages.
1543
- # Corresponds to the JSON property `nextPageToken`
1544
- # @return [String]
1545
- attr_accessor :next_page_token
1546
-
1547
- def initialize(**args)
1548
- update!(**args)
1549
- end
1550
-
1551
- # Update properties of this object
1552
- def update!(**args)
1553
- @android_app_data_streams = args[:android_app_data_streams] if args.key?(:android_app_data_streams)
1554
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1555
- end
1556
- end
1557
-
1558
1503
  # Response message for ListConversionEvents RPC.
1559
1504
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1560
1505
  include Google::Apis::Core::Hashable
@@ -1633,6 +1578,32 @@ module Google
1633
1578
  end
1634
1579
  end
1635
1580
 
1581
+ # Response message for ListDataStreams RPC.
1582
+ class GoogleAnalyticsAdminV1alphaListDataStreamsResponse
1583
+ include Google::Apis::Core::Hashable
1584
+
1585
+ # List of DataStreams.
1586
+ # Corresponds to the JSON property `dataStreams`
1587
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataStream>]
1588
+ attr_accessor :data_streams
1589
+
1590
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1591
+ # field is omitted, there are no subsequent pages.
1592
+ # Corresponds to the JSON property `nextPageToken`
1593
+ # @return [String]
1594
+ attr_accessor :next_page_token
1595
+
1596
+ def initialize(**args)
1597
+ update!(**args)
1598
+ end
1599
+
1600
+ # Update properties of this object
1601
+ def update!(**args)
1602
+ @data_streams = args[:data_streams] if args.key?(:data_streams)
1603
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1604
+ end
1605
+ end
1606
+
1636
1607
  # Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
1637
1608
  class GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse
1638
1609
  include Google::Apis::Core::Hashable
@@ -1738,32 +1709,6 @@ module Google
1738
1709
  end
1739
1710
  end
1740
1711
 
1741
- # Request message for ListIosAppDataStreams RPC.
1742
- class GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse
1743
- include Google::Apis::Core::Hashable
1744
-
1745
- # Results that matched the filter criteria and were accessible to the caller.
1746
- # Corresponds to the JSON property `iosAppDataStreams`
1747
- # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream>]
1748
- attr_accessor :ios_app_data_streams
1749
-
1750
- # A token, which can be sent as `page_token` to retrieve the next page. If this
1751
- # field is omitted, there are no subsequent pages.
1752
- # Corresponds to the JSON property `nextPageToken`
1753
- # @return [String]
1754
- attr_accessor :next_page_token
1755
-
1756
- def initialize(**args)
1757
- update!(**args)
1758
- end
1759
-
1760
- # Update properties of this object
1761
- def update!(**args)
1762
- @ios_app_data_streams = args[:ios_app_data_streams] if args.key?(:ios_app_data_streams)
1763
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1764
- end
1765
- end
1766
-
1767
1712
  # Response message for ListMeasurementProtocolSecret RPC
1768
1713
  class GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
1769
1714
  include Google::Apis::Core::Hashable
@@ -1842,32 +1787,6 @@ module Google
1842
1787
  end
1843
1788
  end
1844
1789
 
1845
- # Request message for ListWebDataStreams RPC.
1846
- class GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse
1847
- include Google::Apis::Core::Hashable
1848
-
1849
- # A token, which can be sent as `page_token` to retrieve the next page. If this
1850
- # field is omitted, there are no subsequent pages.
1851
- # Corresponds to the JSON property `nextPageToken`
1852
- # @return [String]
1853
- attr_accessor :next_page_token
1854
-
1855
- # Results that matched the filter criteria and were accessible to the caller.
1856
- # Corresponds to the JSON property `webDataStreams`
1857
- # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream>]
1858
- attr_accessor :web_data_streams
1859
-
1860
- def initialize(**args)
1861
- update!(**args)
1862
- end
1863
-
1864
- # Update properties of this object
1865
- def update!(**args)
1866
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1867
- @web_data_streams = args[:web_data_streams] if args.key?(:web_data_streams)
1868
- end
1869
- end
1870
-
1871
1790
  # A secret value used for sending hits to Measurement Protocol.
1872
1791
  class GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
1873
1792
  include Google::Apis::Core::Hashable
@@ -1907,6 +1826,12 @@ module Google
1907
1826
  class GoogleAnalyticsAdminV1alphaProperty
1908
1827
  include Google::Apis::Core::Hashable
1909
1828
 
1829
+ # Immutable. The resource name of the parent account Format: accounts/`
1830
+ # account_id` Example: "accounts/123"
1831
+ # Corresponds to the JSON property `account`
1832
+ # @return [String]
1833
+ attr_accessor :account
1834
+
1910
1835
  # Output only. Time when the entity was originally created.
1911
1836
  # Corresponds to the JSON property `createTime`
1912
1837
  # @return [String]
@@ -1980,6 +1905,7 @@ module Google
1980
1905
 
1981
1906
  # Update properties of this object
1982
1907
  def update!(**args)
1908
+ @account = args[:account] if args.key?(:account)
1983
1909
  @create_time = args[:create_time] if args.key?(:create_time)
1984
1910
  @currency_code = args[:currency_code] if args.key?(:currency_code)
1985
1911
  @delete_time = args[:delete_time] if args.key?(:delete_time)
@@ -1994,11 +1920,11 @@ module Google
1994
1920
  end
1995
1921
  end
1996
1922
 
1997
- # A virtual resource representing metadata for an GA4 property.
1923
+ # A virtual resource representing metadata for a GA4 property.
1998
1924
  class GoogleAnalyticsAdminV1alphaPropertySummary
1999
1925
  include Google::Apis::Core::Hashable
2000
1926
 
2001
- # Display name for the property referred to in this account summary.
1927
+ # Display name for the property referred to in this property summary.
2002
1928
  # Corresponds to the JSON property `displayName`
2003
1929
  # @return [String]
2004
1930
  attr_accessor :display_name
@@ -2187,10 +2113,11 @@ module Google
2187
2113
  include Google::Apis::Core::Hashable
2188
2114
 
2189
2115
  # Roles directly assigned to this user for this account or property. Valid
2190
- # values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit
2191
- # predefinedRoles/manage-users Excludes roles that are inherited from a higher-
2192
- # level entity, group, or organization admin role. A UserLink that is updated to
2193
- # have an empty list of direct_roles will be deleted.
2116
+ # values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor
2117
+ # predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-
2118
+ # data Excludes roles that are inherited from a higher-level entity, group, or
2119
+ # organization admin role. A UserLink that is updated to have an empty list of
2120
+ # direct_roles will be deleted.
2194
2121
  # Corresponds to the JSON property `directRoles`
2195
2122
  # @return [Array<String>]
2196
2123
  attr_accessor :direct_roles
@@ -2217,67 +2144,6 @@ module Google
2217
2144
  end
2218
2145
  end
2219
2146
 
2220
- # A resource message representing a Google Analytics web stream.
2221
- class GoogleAnalyticsAdminV1alphaWebDataStream
2222
- include Google::Apis::Core::Hashable
2223
-
2224
- # Output only. Time when this stream was originally created.
2225
- # Corresponds to the JSON property `createTime`
2226
- # @return [String]
2227
- attr_accessor :create_time
2228
-
2229
- # Immutable. Domain name of the web app being measured, or empty. Example: "http:
2230
- # //www.google.com", "https://www.google.com"
2231
- # Corresponds to the JSON property `defaultUri`
2232
- # @return [String]
2233
- attr_accessor :default_uri
2234
-
2235
- # Required. Human-readable display name for the Data Stream. The max allowed
2236
- # display name length is 100 UTF-16 code units.
2237
- # Corresponds to the JSON property `displayName`
2238
- # @return [String]
2239
- attr_accessor :display_name
2240
-
2241
- # Output only. ID of the corresponding web app in Firebase, if any. This ID can
2242
- # change if the web app is deleted and recreated.
2243
- # Corresponds to the JSON property `firebaseAppId`
2244
- # @return [String]
2245
- attr_accessor :firebase_app_id
2246
-
2247
- # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-
2248
- # 1A2BCD345E" would just be "1A2BCD345E"
2249
- # Corresponds to the JSON property `measurementId`
2250
- # @return [String]
2251
- attr_accessor :measurement_id
2252
-
2253
- # Output only. Resource name of this Data Stream. Format: properties/`
2254
- # property_id`/webDataStreams/`stream_id` Example: "properties/1000/
2255
- # webDataStreams/2000"
2256
- # Corresponds to the JSON property `name`
2257
- # @return [String]
2258
- attr_accessor :name
2259
-
2260
- # Output only. Time when stream payload fields were last updated.
2261
- # Corresponds to the JSON property `updateTime`
2262
- # @return [String]
2263
- attr_accessor :update_time
2264
-
2265
- def initialize(**args)
2266
- update!(**args)
2267
- end
2268
-
2269
- # Update properties of this object
2270
- def update!(**args)
2271
- @create_time = args[:create_time] if args.key?(:create_time)
2272
- @default_uri = args[:default_uri] if args.key?(:default_uri)
2273
- @display_name = args[:display_name] if args.key?(:display_name)
2274
- @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
2275
- @measurement_id = args[:measurement_id] if args.key?(:measurement_id)
2276
- @name = args[:name] if args.key?(:name)
2277
- @update_time = args[:update_time] if args.key?(:update_time)
2278
- end
2279
- end
2280
-
2281
2147
  # A generic empty message that you can re-use to avoid defining duplicated empty
2282
2148
  # messages in your APIs. A typical example is to use it as the request or the
2283
2149
  # response type of an API method. For instance: service Foo ` rpc Bar(google.