google-apis-analyticsadmin_v1beta 0.1.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.
@@ -0,0 +1,1459 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AnalyticsadminV1beta
24
+
25
+ # A resource message representing a Google Analytics account.
26
+ class GoogleAnalyticsAdminV1betaAccount
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Output only. Time when this account was originally created.
30
+ # Corresponds to the JSON property `createTime`
31
+ # @return [String]
32
+ attr_accessor :create_time
33
+
34
+ # Output only. Indicates whether this Account is soft-deleted or not. Deleted
35
+ # accounts are excluded from List results unless specifically requested.
36
+ # Corresponds to the JSON property `deleted`
37
+ # @return [Boolean]
38
+ attr_accessor :deleted
39
+ alias_method :deleted?, :deleted
40
+
41
+ # Required. Human-readable display name for this account.
42
+ # Corresponds to the JSON property `displayName`
43
+ # @return [String]
44
+ attr_accessor :display_name
45
+
46
+ # Output only. Resource name of this account. Format: accounts/`account` Example:
47
+ # "accounts/100"
48
+ # Corresponds to the JSON property `name`
49
+ # @return [String]
50
+ attr_accessor :name
51
+
52
+ # Country of business. Must be a Unicode CLDR region code.
53
+ # Corresponds to the JSON property `regionCode`
54
+ # @return [String]
55
+ attr_accessor :region_code
56
+
57
+ # Output only. Time when account payload fields were last updated.
58
+ # Corresponds to the JSON property `updateTime`
59
+ # @return [String]
60
+ attr_accessor :update_time
61
+
62
+ def initialize(**args)
63
+ update!(**args)
64
+ end
65
+
66
+ # Update properties of this object
67
+ def update!(**args)
68
+ @create_time = args[:create_time] if args.key?(:create_time)
69
+ @deleted = args[:deleted] if args.key?(:deleted)
70
+ @display_name = args[:display_name] if args.key?(:display_name)
71
+ @name = args[:name] if args.key?(:name)
72
+ @region_code = args[:region_code] if args.key?(:region_code)
73
+ @update_time = args[:update_time] if args.key?(:update_time)
74
+ end
75
+ end
76
+
77
+ # A virtual resource representing an overview of an account and all its child
78
+ # GA4 properties.
79
+ class GoogleAnalyticsAdminV1betaAccountSummary
80
+ include Google::Apis::Core::Hashable
81
+
82
+ # Resource name of account referred to by this account summary Format: accounts/`
83
+ # account_id` Example: "accounts/1000"
84
+ # Corresponds to the JSON property `account`
85
+ # @return [String]
86
+ attr_accessor :account
87
+
88
+ # Display name for the account referred to in this account summary.
89
+ # Corresponds to the JSON property `displayName`
90
+ # @return [String]
91
+ attr_accessor :display_name
92
+
93
+ # Resource name for this account summary. Format: accountSummaries/`account_id`
94
+ # Example: "accountSummaries/1000"
95
+ # Corresponds to the JSON property `name`
96
+ # @return [String]
97
+ attr_accessor :name
98
+
99
+ # List of summaries for child accounts of this account.
100
+ # Corresponds to the JSON property `propertySummaries`
101
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaPropertySummary>]
102
+ attr_accessor :property_summaries
103
+
104
+ def initialize(**args)
105
+ update!(**args)
106
+ end
107
+
108
+ # Update properties of this object
109
+ def update!(**args)
110
+ @account = args[:account] if args.key?(:account)
111
+ @display_name = args[:display_name] if args.key?(:display_name)
112
+ @name = args[:name] if args.key?(:name)
113
+ @property_summaries = args[:property_summaries] if args.key?(:property_summaries)
114
+ end
115
+ end
116
+
117
+ # Request message for AcknowledgeUserDataCollection RPC.
118
+ class GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest
119
+ include Google::Apis::Core::Hashable
120
+
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`
128
+ # @return [String]
129
+ attr_accessor :acknowledgement
130
+
131
+ def initialize(**args)
132
+ update!(**args)
133
+ end
134
+
135
+ # Update properties of this object
136
+ def update!(**args)
137
+ @acknowledgement = args[:acknowledgement] if args.key?(:acknowledgement)
138
+ end
139
+ end
140
+
141
+ # Response message for AcknowledgeUserDataCollection RPC.
142
+ class GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse
143
+ include Google::Apis::Core::Hashable
144
+
145
+ def initialize(**args)
146
+ update!(**args)
147
+ end
148
+
149
+ # Update properties of this object
150
+ def update!(**args)
151
+ end
152
+ end
153
+
154
+ # Request message for ArchiveCustomDimension RPC.
155
+ class GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest
156
+ include Google::Apis::Core::Hashable
157
+
158
+ def initialize(**args)
159
+ update!(**args)
160
+ end
161
+
162
+ # Update properties of this object
163
+ def update!(**args)
164
+ end
165
+ end
166
+
167
+ # Request message for ArchiveCustomMetric RPC.
168
+ class GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest
169
+ include Google::Apis::Core::Hashable
170
+
171
+ def initialize(**args)
172
+ update!(**args)
173
+ end
174
+
175
+ # Update properties of this object
176
+ def update!(**args)
177
+ end
178
+ end
179
+
180
+ # A description of a change to a single Google Analytics resource.
181
+ class GoogleAnalyticsAdminV1betaChangeHistoryChange
182
+ include Google::Apis::Core::Hashable
183
+
184
+ # The type of action that changed this resource.
185
+ # Corresponds to the JSON property `action`
186
+ # @return [String]
187
+ attr_accessor :action
188
+
189
+ # Resource name of the resource whose changes are described by this entry.
190
+ # Corresponds to the JSON property `resource`
191
+ # @return [String]
192
+ attr_accessor :resource
193
+
194
+ # A snapshot of a resource as before or after the result of a change in change
195
+ # history.
196
+ # Corresponds to the JSON property `resourceAfterChange`
197
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource]
198
+ attr_accessor :resource_after_change
199
+
200
+ # A snapshot of a resource as before or after the result of a change in change
201
+ # history.
202
+ # Corresponds to the JSON property `resourceBeforeChange`
203
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource]
204
+ attr_accessor :resource_before_change
205
+
206
+ def initialize(**args)
207
+ update!(**args)
208
+ end
209
+
210
+ # Update properties of this object
211
+ def update!(**args)
212
+ @action = args[:action] if args.key?(:action)
213
+ @resource = args[:resource] if args.key?(:resource)
214
+ @resource_after_change = args[:resource_after_change] if args.key?(:resource_after_change)
215
+ @resource_before_change = args[:resource_before_change] if args.key?(:resource_before_change)
216
+ end
217
+ end
218
+
219
+ # A snapshot of a resource as before or after the result of a change in change
220
+ # history.
221
+ class GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource
222
+ include Google::Apis::Core::Hashable
223
+
224
+ # A resource message representing a Google Analytics account.
225
+ # Corresponds to the JSON property `account`
226
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount]
227
+ attr_accessor :account
228
+
229
+ # A conversion event in a Google Analytics property.
230
+ # Corresponds to the JSON property `conversionEvent`
231
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent]
232
+ attr_accessor :conversion_event
233
+
234
+ # Settings values for data retention. This is a singleton resource.
235
+ # Corresponds to the JSON property `dataRetentionSettings`
236
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings]
237
+ attr_accessor :data_retention_settings
238
+
239
+ # A resource message representing a data stream.
240
+ # Corresponds to the JSON property `dataStream`
241
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream]
242
+ attr_accessor :data_stream
243
+
244
+ # A link between a GA4 property and a Firebase project.
245
+ # Corresponds to the JSON property `firebaseLink`
246
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink]
247
+ attr_accessor :firebase_link
248
+
249
+ # A link between a GA4 property and a Google Ads account.
250
+ # Corresponds to the JSON property `googleAdsLink`
251
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink]
252
+ attr_accessor :google_ads_link
253
+
254
+ # A secret value used for sending hits to Measurement Protocol.
255
+ # Corresponds to the JSON property `measurementProtocolSecret`
256
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]
257
+ attr_accessor :measurement_protocol_secret
258
+
259
+ # A resource message representing a Google Analytics GA4 property.
260
+ # Corresponds to the JSON property `property`
261
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty]
262
+ attr_accessor :property
263
+
264
+ def initialize(**args)
265
+ update!(**args)
266
+ end
267
+
268
+ # Update properties of this object
269
+ def update!(**args)
270
+ @account = args[:account] if args.key?(:account)
271
+ @conversion_event = args[:conversion_event] if args.key?(:conversion_event)
272
+ @data_retention_settings = args[:data_retention_settings] if args.key?(:data_retention_settings)
273
+ @data_stream = args[:data_stream] if args.key?(:data_stream)
274
+ @firebase_link = args[:firebase_link] if args.key?(:firebase_link)
275
+ @google_ads_link = args[:google_ads_link] if args.key?(:google_ads_link)
276
+ @measurement_protocol_secret = args[:measurement_protocol_secret] if args.key?(:measurement_protocol_secret)
277
+ @property = args[:property] if args.key?(:property)
278
+ end
279
+ end
280
+
281
+ # A set of changes within a Google Analytics account or its child properties
282
+ # that resulted from the same cause. Common causes would be updates made in the
283
+ # Google Analytics UI, changes from customer support, or automatic Google
284
+ # Analytics system changes.
285
+ class GoogleAnalyticsAdminV1betaChangeHistoryEvent
286
+ include Google::Apis::Core::Hashable
287
+
288
+ # The type of actor that made this change.
289
+ # Corresponds to the JSON property `actorType`
290
+ # @return [String]
291
+ attr_accessor :actor_type
292
+
293
+ # Time when change was made.
294
+ # Corresponds to the JSON property `changeTime`
295
+ # @return [String]
296
+ attr_accessor :change_time
297
+
298
+ # A list of changes made in this change history event that fit the filters
299
+ # specified in SearchChangeHistoryEventsRequest.
300
+ # Corresponds to the JSON property `changes`
301
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaChangeHistoryChange>]
302
+ attr_accessor :changes
303
+
304
+ # If true, then the list of changes returned was filtered, and does not
305
+ # represent all changes that occurred in this event.
306
+ # Corresponds to the JSON property `changesFiltered`
307
+ # @return [Boolean]
308
+ attr_accessor :changes_filtered
309
+ alias_method :changes_filtered?, :changes_filtered
310
+
311
+ # ID of this change history event. This ID is unique across Google Analytics.
312
+ # Corresponds to the JSON property `id`
313
+ # @return [String]
314
+ attr_accessor :id
315
+
316
+ # Email address of the Google account that made the change. This will be a valid
317
+ # email address if the actor field is set to USER, and empty otherwise. Google
318
+ # accounts that have been deleted will cause an error.
319
+ # Corresponds to the JSON property `userActorEmail`
320
+ # @return [String]
321
+ attr_accessor :user_actor_email
322
+
323
+ def initialize(**args)
324
+ update!(**args)
325
+ end
326
+
327
+ # Update properties of this object
328
+ def update!(**args)
329
+ @actor_type = args[:actor_type] if args.key?(:actor_type)
330
+ @change_time = args[:change_time] if args.key?(:change_time)
331
+ @changes = args[:changes] if args.key?(:changes)
332
+ @changes_filtered = args[:changes_filtered] if args.key?(:changes_filtered)
333
+ @id = args[:id] if args.key?(:id)
334
+ @user_actor_email = args[:user_actor_email] if args.key?(:user_actor_email)
335
+ end
336
+ end
337
+
338
+ # A conversion event in a Google Analytics property.
339
+ class GoogleAnalyticsAdminV1betaConversionEvent
340
+ include Google::Apis::Core::Hashable
341
+
342
+ # Output only. Time when this conversion event was created in the property.
343
+ # Corresponds to the JSON property `createTime`
344
+ # @return [String]
345
+ attr_accessor :create_time
346
+
347
+ # Output only. If set to true, this conversion event refers to a custom event.
348
+ # If set to false, this conversion event refers to a default event in GA.
349
+ # Default events typically have special meaning in GA. Default events are
350
+ # usually created for you by the GA system, but in some cases can be created by
351
+ # property admins. Custom events count towards the maximum number of custom
352
+ # conversion events that may be created per property.
353
+ # Corresponds to the JSON property `custom`
354
+ # @return [Boolean]
355
+ attr_accessor :custom
356
+ alias_method :custom?, :custom
357
+
358
+ # Output only. If set, this event can currently be deleted via
359
+ # DeleteConversionEvent.
360
+ # Corresponds to the JSON property `deletable`
361
+ # @return [Boolean]
362
+ attr_accessor :deletable
363
+ alias_method :deletable?, :deletable
364
+
365
+ # Immutable. The event name for this conversion event. Examples: 'click', '
366
+ # purchase'
367
+ # Corresponds to the JSON property `eventName`
368
+ # @return [String]
369
+ attr_accessor :event_name
370
+
371
+ # Output only. Resource name of this conversion event. Format: properties/`
372
+ # property`/conversionEvents/`conversion_event`
373
+ # Corresponds to the JSON property `name`
374
+ # @return [String]
375
+ attr_accessor :name
376
+
377
+ def initialize(**args)
378
+ update!(**args)
379
+ end
380
+
381
+ # Update properties of this object
382
+ def update!(**args)
383
+ @create_time = args[:create_time] if args.key?(:create_time)
384
+ @custom = args[:custom] if args.key?(:custom)
385
+ @deletable = args[:deletable] if args.key?(:deletable)
386
+ @event_name = args[:event_name] if args.key?(:event_name)
387
+ @name = args[:name] if args.key?(:name)
388
+ end
389
+ end
390
+
391
+ # A definition for a CustomDimension.
392
+ class GoogleAnalyticsAdminV1betaCustomDimension
393
+ include Google::Apis::Core::Hashable
394
+
395
+ # Optional. Description for this custom dimension. Max length of 150 characters.
396
+ # Corresponds to the JSON property `description`
397
+ # @return [String]
398
+ attr_accessor :description
399
+
400
+ # Optional. If set to true, sets this dimension as NPA and excludes it from ads
401
+ # personalization. This is currently only supported by user-scoped custom
402
+ # dimensions.
403
+ # Corresponds to the JSON property `disallowAdsPersonalization`
404
+ # @return [Boolean]
405
+ attr_accessor :disallow_ads_personalization
406
+ alias_method :disallow_ads_personalization?, :disallow_ads_personalization
407
+
408
+ # Required. Display name for this custom dimension as shown in the Analytics UI.
409
+ # Max length of 82 characters, alphanumeric plus space and underscore starting
410
+ # with a letter. Legacy system-generated display names may contain square
411
+ # brackets, but updates to this field will never permit square brackets.
412
+ # Corresponds to the JSON property `displayName`
413
+ # @return [String]
414
+ attr_accessor :display_name
415
+
416
+ # Output only. Resource name for this CustomDimension resource. Format:
417
+ # properties/`property`/customDimensions/`customDimension`
418
+ # Corresponds to the JSON property `name`
419
+ # @return [String]
420
+ attr_accessor :name
421
+
422
+ # Required. Immutable. Tagging parameter name for this custom dimension. If this
423
+ # is a user-scoped dimension, then this is the user property name. If this is an
424
+ # event-scoped dimension, then this is the event parameter name. May only
425
+ # contain alphanumeric and underscore characters, starting with a letter. Max
426
+ # length of 24 characters for user-scoped dimensions, 40 characters for event-
427
+ # scoped dimensions.
428
+ # Corresponds to the JSON property `parameterName`
429
+ # @return [String]
430
+ attr_accessor :parameter_name
431
+
432
+ # Required. Immutable. The scope of this dimension.
433
+ # Corresponds to the JSON property `scope`
434
+ # @return [String]
435
+ attr_accessor :scope
436
+
437
+ def initialize(**args)
438
+ update!(**args)
439
+ end
440
+
441
+ # Update properties of this object
442
+ def update!(**args)
443
+ @description = args[:description] if args.key?(:description)
444
+ @disallow_ads_personalization = args[:disallow_ads_personalization] if args.key?(:disallow_ads_personalization)
445
+ @display_name = args[:display_name] if args.key?(:display_name)
446
+ @name = args[:name] if args.key?(:name)
447
+ @parameter_name = args[:parameter_name] if args.key?(:parameter_name)
448
+ @scope = args[:scope] if args.key?(:scope)
449
+ end
450
+ end
451
+
452
+ # A definition for a custom metric.
453
+ class GoogleAnalyticsAdminV1betaCustomMetric
454
+ include Google::Apis::Core::Hashable
455
+
456
+ # Optional. Description for this custom dimension. Max length of 150 characters.
457
+ # Corresponds to the JSON property `description`
458
+ # @return [String]
459
+ attr_accessor :description
460
+
461
+ # Required. Display name for this custom metric as shown in the Analytics UI.
462
+ # Max length of 82 characters, alphanumeric plus space and underscore starting
463
+ # with a letter. Legacy system-generated display names may contain square
464
+ # brackets, but updates to this field will never permit square brackets.
465
+ # Corresponds to the JSON property `displayName`
466
+ # @return [String]
467
+ attr_accessor :display_name
468
+
469
+ # Required. The type for the custom metric's value.
470
+ # Corresponds to the JSON property `measurementUnit`
471
+ # @return [String]
472
+ attr_accessor :measurement_unit
473
+
474
+ # Output only. Resource name for this CustomMetric resource. Format: properties/`
475
+ # property`/customMetrics/`customMetric`
476
+ # Corresponds to the JSON property `name`
477
+ # @return [String]
478
+ attr_accessor :name
479
+
480
+ # Required. Immutable. Tagging name for this custom metric. If this is an event-
481
+ # scoped metric, then this is the event parameter name. May only contain
482
+ # alphanumeric and underscore charactes, starting with a letter. Max length of
483
+ # 40 characters for event-scoped metrics.
484
+ # Corresponds to the JSON property `parameterName`
485
+ # @return [String]
486
+ attr_accessor :parameter_name
487
+
488
+ # Optional. Types of restricted data that this metric may contain. Required for
489
+ # metrics with CURRENCY measurement unit. Must be empty for metrics with a non-
490
+ # CURRENCY measurement unit.
491
+ # Corresponds to the JSON property `restrictedMetricType`
492
+ # @return [Array<String>]
493
+ attr_accessor :restricted_metric_type
494
+
495
+ # Required. Immutable. The scope of this custom metric.
496
+ # Corresponds to the JSON property `scope`
497
+ # @return [String]
498
+ attr_accessor :scope
499
+
500
+ def initialize(**args)
501
+ update!(**args)
502
+ end
503
+
504
+ # Update properties of this object
505
+ def update!(**args)
506
+ @description = args[:description] if args.key?(:description)
507
+ @display_name = args[:display_name] if args.key?(:display_name)
508
+ @measurement_unit = args[:measurement_unit] if args.key?(:measurement_unit)
509
+ @name = args[:name] if args.key?(:name)
510
+ @parameter_name = args[:parameter_name] if args.key?(:parameter_name)
511
+ @restricted_metric_type = args[:restricted_metric_type] if args.key?(:restricted_metric_type)
512
+ @scope = args[:scope] if args.key?(:scope)
513
+ end
514
+ end
515
+
516
+ # Settings values for data retention. This is a singleton resource.
517
+ class GoogleAnalyticsAdminV1betaDataRetentionSettings
518
+ include Google::Apis::Core::Hashable
519
+
520
+ # The length of time that event-level data is retained.
521
+ # Corresponds to the JSON property `eventDataRetention`
522
+ # @return [String]
523
+ attr_accessor :event_data_retention
524
+
525
+ # Output only. Resource name for this DataRetentionSetting resource. Format:
526
+ # properties/`property`/dataRetentionSettings
527
+ # Corresponds to the JSON property `name`
528
+ # @return [String]
529
+ attr_accessor :name
530
+
531
+ # If true, reset the retention period for the user identifier with every event
532
+ # from that user.
533
+ # Corresponds to the JSON property `resetUserDataOnNewActivity`
534
+ # @return [Boolean]
535
+ attr_accessor :reset_user_data_on_new_activity
536
+ alias_method :reset_user_data_on_new_activity?, :reset_user_data_on_new_activity
537
+
538
+ def initialize(**args)
539
+ update!(**args)
540
+ end
541
+
542
+ # Update properties of this object
543
+ def update!(**args)
544
+ @event_data_retention = args[:event_data_retention] if args.key?(:event_data_retention)
545
+ @name = args[:name] if args.key?(:name)
546
+ @reset_user_data_on_new_activity = args[:reset_user_data_on_new_activity] if args.key?(:reset_user_data_on_new_activity)
547
+ end
548
+ end
549
+
550
+ # A resource message representing data sharing settings of a Google Analytics
551
+ # account.
552
+ class GoogleAnalyticsAdminV1betaDataSharingSettings
553
+ include Google::Apis::Core::Hashable
554
+
555
+ # Output only. Resource name. Format: accounts/`account`/dataSharingSettings
556
+ # Example: "accounts/1000/dataSharingSettings"
557
+ # Corresponds to the JSON property `name`
558
+ # @return [String]
559
+ attr_accessor :name
560
+
561
+ # Allows any of Google sales to access the data in order to suggest
562
+ # configuration changes to improve results.
563
+ # Corresponds to the JSON property `sharingWithGoogleAnySalesEnabled`
564
+ # @return [Boolean]
565
+ attr_accessor :sharing_with_google_any_sales_enabled
566
+ alias_method :sharing_with_google_any_sales_enabled?, :sharing_with_google_any_sales_enabled
567
+
568
+ # Allows Google sales teams that are assigned to the customer to access the data
569
+ # in order to suggest configuration changes to improve results. Sales team
570
+ # restrictions still apply when enabled.
571
+ # Corresponds to the JSON property `sharingWithGoogleAssignedSalesEnabled`
572
+ # @return [Boolean]
573
+ attr_accessor :sharing_with_google_assigned_sales_enabled
574
+ alias_method :sharing_with_google_assigned_sales_enabled?, :sharing_with_google_assigned_sales_enabled
575
+
576
+ # Allows Google to use the data to improve other Google products or services.
577
+ # Corresponds to the JSON property `sharingWithGoogleProductsEnabled`
578
+ # @return [Boolean]
579
+ attr_accessor :sharing_with_google_products_enabled
580
+ alias_method :sharing_with_google_products_enabled?, :sharing_with_google_products_enabled
581
+
582
+ # Allows Google support to access the data in order to help troubleshoot issues.
583
+ # Corresponds to the JSON property `sharingWithGoogleSupportEnabled`
584
+ # @return [Boolean]
585
+ attr_accessor :sharing_with_google_support_enabled
586
+ alias_method :sharing_with_google_support_enabled?, :sharing_with_google_support_enabled
587
+
588
+ # Allows Google to share the data anonymously in aggregate form with others.
589
+ # Corresponds to the JSON property `sharingWithOthersEnabled`
590
+ # @return [Boolean]
591
+ attr_accessor :sharing_with_others_enabled
592
+ alias_method :sharing_with_others_enabled?, :sharing_with_others_enabled
593
+
594
+ def initialize(**args)
595
+ update!(**args)
596
+ end
597
+
598
+ # Update properties of this object
599
+ def update!(**args)
600
+ @name = args[:name] if args.key?(:name)
601
+ @sharing_with_google_any_sales_enabled = args[:sharing_with_google_any_sales_enabled] if args.key?(:sharing_with_google_any_sales_enabled)
602
+ @sharing_with_google_assigned_sales_enabled = args[:sharing_with_google_assigned_sales_enabled] if args.key?(:sharing_with_google_assigned_sales_enabled)
603
+ @sharing_with_google_products_enabled = args[:sharing_with_google_products_enabled] if args.key?(:sharing_with_google_products_enabled)
604
+ @sharing_with_google_support_enabled = args[:sharing_with_google_support_enabled] if args.key?(:sharing_with_google_support_enabled)
605
+ @sharing_with_others_enabled = args[:sharing_with_others_enabled] if args.key?(:sharing_with_others_enabled)
606
+ end
607
+ end
608
+
609
+ # A resource message representing a data stream.
610
+ class GoogleAnalyticsAdminV1betaDataStream
611
+ include Google::Apis::Core::Hashable
612
+
613
+ # Data specific to Android app streams.
614
+ # Corresponds to the JSON property `androidAppStreamData`
615
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData]
616
+ attr_accessor :android_app_stream_data
617
+
618
+ # Output only. Time when this stream was originally created.
619
+ # Corresponds to the JSON property `createTime`
620
+ # @return [String]
621
+ attr_accessor :create_time
622
+
623
+ # Human-readable display name for the Data Stream. Required for web data streams.
624
+ # The max allowed display name length is 255 UTF-16 code units.
625
+ # Corresponds to the JSON property `displayName`
626
+ # @return [String]
627
+ attr_accessor :display_name
628
+
629
+ # Data specific to iOS app streams.
630
+ # Corresponds to the JSON property `iosAppStreamData`
631
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData]
632
+ attr_accessor :ios_app_stream_data
633
+
634
+ # Output only. Resource name of this Data Stream. Format: properties/`
635
+ # property_id`/dataStreams/`stream_id` Example: "properties/1000/dataStreams/
636
+ # 2000"
637
+ # Corresponds to the JSON property `name`
638
+ # @return [String]
639
+ attr_accessor :name
640
+
641
+ # Required. Immutable. The type of this DataStream resource.
642
+ # Corresponds to the JSON property `type`
643
+ # @return [String]
644
+ attr_accessor :type
645
+
646
+ # Output only. Time when stream payload fields were last updated.
647
+ # Corresponds to the JSON property `updateTime`
648
+ # @return [String]
649
+ attr_accessor :update_time
650
+
651
+ # Data specific to web streams.
652
+ # Corresponds to the JSON property `webStreamData`
653
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStreamWebStreamData]
654
+ attr_accessor :web_stream_data
655
+
656
+ def initialize(**args)
657
+ update!(**args)
658
+ end
659
+
660
+ # Update properties of this object
661
+ def update!(**args)
662
+ @android_app_stream_data = args[:android_app_stream_data] if args.key?(:android_app_stream_data)
663
+ @create_time = args[:create_time] if args.key?(:create_time)
664
+ @display_name = args[:display_name] if args.key?(:display_name)
665
+ @ios_app_stream_data = args[:ios_app_stream_data] if args.key?(:ios_app_stream_data)
666
+ @name = args[:name] if args.key?(:name)
667
+ @type = args[:type] if args.key?(:type)
668
+ @update_time = args[:update_time] if args.key?(:update_time)
669
+ @web_stream_data = args[:web_stream_data] if args.key?(:web_stream_data)
670
+ end
671
+ end
672
+
673
+ # Data specific to Android app streams.
674
+ class GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData
675
+ include Google::Apis::Core::Hashable
676
+
677
+ # Output only. ID of the corresponding Android app in Firebase, if any. This ID
678
+ # can change if the Android app is deleted and recreated.
679
+ # Corresponds to the JSON property `firebaseAppId`
680
+ # @return [String]
681
+ attr_accessor :firebase_app_id
682
+
683
+ # Immutable. The package name for the app being measured. Example: "com.example.
684
+ # myandroidapp"
685
+ # Corresponds to the JSON property `packageName`
686
+ # @return [String]
687
+ attr_accessor :package_name
688
+
689
+ def initialize(**args)
690
+ update!(**args)
691
+ end
692
+
693
+ # Update properties of this object
694
+ def update!(**args)
695
+ @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
696
+ @package_name = args[:package_name] if args.key?(:package_name)
697
+ end
698
+ end
699
+
700
+ # Data specific to iOS app streams.
701
+ class GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData
702
+ include Google::Apis::Core::Hashable
703
+
704
+ # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.
705
+ # example.myiosapp"
706
+ # Corresponds to the JSON property `bundleId`
707
+ # @return [String]
708
+ attr_accessor :bundle_id
709
+
710
+ # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can
711
+ # change if the iOS app is deleted and recreated.
712
+ # Corresponds to the JSON property `firebaseAppId`
713
+ # @return [String]
714
+ attr_accessor :firebase_app_id
715
+
716
+ def initialize(**args)
717
+ update!(**args)
718
+ end
719
+
720
+ # Update properties of this object
721
+ def update!(**args)
722
+ @bundle_id = args[:bundle_id] if args.key?(:bundle_id)
723
+ @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
724
+ end
725
+ end
726
+
727
+ # Data specific to web streams.
728
+ class GoogleAnalyticsAdminV1betaDataStreamWebStreamData
729
+ include Google::Apis::Core::Hashable
730
+
731
+ # Immutable. Domain name of the web app being measured, or empty. Example: "http:
732
+ # //www.google.com", "https://www.google.com"
733
+ # Corresponds to the JSON property `defaultUri`
734
+ # @return [String]
735
+ attr_accessor :default_uri
736
+
737
+ # Output only. ID of the corresponding web app in Firebase, if any. This ID can
738
+ # change if the web app is deleted and recreated.
739
+ # Corresponds to the JSON property `firebaseAppId`
740
+ # @return [String]
741
+ attr_accessor :firebase_app_id
742
+
743
+ # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-
744
+ # 1A2BCD345E" would just be "1A2BCD345E"
745
+ # Corresponds to the JSON property `measurementId`
746
+ # @return [String]
747
+ attr_accessor :measurement_id
748
+
749
+ def initialize(**args)
750
+ update!(**args)
751
+ end
752
+
753
+ # Update properties of this object
754
+ def update!(**args)
755
+ @default_uri = args[:default_uri] if args.key?(:default_uri)
756
+ @firebase_app_id = args[:firebase_app_id] if args.key?(:firebase_app_id)
757
+ @measurement_id = args[:measurement_id] if args.key?(:measurement_id)
758
+ end
759
+ end
760
+
761
+ # A link between a GA4 property and a Firebase project.
762
+ class GoogleAnalyticsAdminV1betaFirebaseLink
763
+ include Google::Apis::Core::Hashable
764
+
765
+ # Output only. Time when this FirebaseLink was originally created.
766
+ # Corresponds to the JSON property `createTime`
767
+ # @return [String]
768
+ attr_accessor :create_time
769
+
770
+ # Output only. Example format: properties/1234/firebaseLinks/5678
771
+ # Corresponds to the JSON property `name`
772
+ # @return [String]
773
+ attr_accessor :name
774
+
775
+ # Immutable. Firebase project resource name. When creating a FirebaseLink, you
776
+ # may provide this resource name using either a project number or project ID.
777
+ # Once this resource has been created, returned FirebaseLinks will always have a
778
+ # project_name that contains a project number. Format: 'projects/`project number`
779
+ # ' Example: 'projects/1234'
780
+ # Corresponds to the JSON property `project`
781
+ # @return [String]
782
+ attr_accessor :project
783
+
784
+ def initialize(**args)
785
+ update!(**args)
786
+ end
787
+
788
+ # Update properties of this object
789
+ def update!(**args)
790
+ @create_time = args[:create_time] if args.key?(:create_time)
791
+ @name = args[:name] if args.key?(:name)
792
+ @project = args[:project] if args.key?(:project)
793
+ end
794
+ end
795
+
796
+ # A link between a GA4 property and a Google Ads account.
797
+ class GoogleAnalyticsAdminV1betaGoogleAdsLink
798
+ include Google::Apis::Core::Hashable
799
+
800
+ # Enable personalized advertising features with this integration. Automatically
801
+ # publish my Google Analytics audience lists and Google Analytics remarketing
802
+ # events/parameters to the linked Google Ads account. If this field is not set
803
+ # on create/update, it will be defaulted to true.
804
+ # Corresponds to the JSON property `adsPersonalizationEnabled`
805
+ # @return [Boolean]
806
+ attr_accessor :ads_personalization_enabled
807
+ alias_method :ads_personalization_enabled?, :ads_personalization_enabled
808
+
809
+ # Output only. If true, this link is for a Google Ads manager account.
810
+ # Corresponds to the JSON property `canManageClients`
811
+ # @return [Boolean]
812
+ attr_accessor :can_manage_clients
813
+ alias_method :can_manage_clients?, :can_manage_clients
814
+
815
+ # Output only. Time when this link was originally created.
816
+ # Corresponds to the JSON property `createTime`
817
+ # @return [String]
818
+ attr_accessor :create_time
819
+
820
+ # Output only. Email address of the user that created the link. An empty string
821
+ # will be returned if the email address can't be retrieved.
822
+ # Corresponds to the JSON property `creatorEmailAddress`
823
+ # @return [String]
824
+ attr_accessor :creator_email_address
825
+
826
+ # Immutable. Google Ads customer ID.
827
+ # Corresponds to the JSON property `customerId`
828
+ # @return [String]
829
+ attr_accessor :customer_id
830
+
831
+ # Output only. Format: properties/`propertyId`/googleAdsLinks/`googleAdsLinkId`
832
+ # Note: googleAdsLinkId is not the Google Ads customer ID.
833
+ # Corresponds to the JSON property `name`
834
+ # @return [String]
835
+ attr_accessor :name
836
+
837
+ # Output only. Time when this link was last updated.
838
+ # Corresponds to the JSON property `updateTime`
839
+ # @return [String]
840
+ attr_accessor :update_time
841
+
842
+ def initialize(**args)
843
+ update!(**args)
844
+ end
845
+
846
+ # Update properties of this object
847
+ def update!(**args)
848
+ @ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
849
+ @can_manage_clients = args[:can_manage_clients] if args.key?(:can_manage_clients)
850
+ @create_time = args[:create_time] if args.key?(:create_time)
851
+ @creator_email_address = args[:creator_email_address] if args.key?(:creator_email_address)
852
+ @customer_id = args[:customer_id] if args.key?(:customer_id)
853
+ @name = args[:name] if args.key?(:name)
854
+ @update_time = args[:update_time] if args.key?(:update_time)
855
+ end
856
+ end
857
+
858
+ # Response message for ListAccountSummaries RPC.
859
+ class GoogleAnalyticsAdminV1betaListAccountSummariesResponse
860
+ include Google::Apis::Core::Hashable
861
+
862
+ # Account summaries of all accounts the caller has access to.
863
+ # Corresponds to the JSON property `accountSummaries`
864
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccountSummary>]
865
+ attr_accessor :account_summaries
866
+
867
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
868
+ # field is omitted, there are no subsequent pages.
869
+ # Corresponds to the JSON property `nextPageToken`
870
+ # @return [String]
871
+ attr_accessor :next_page_token
872
+
873
+ def initialize(**args)
874
+ update!(**args)
875
+ end
876
+
877
+ # Update properties of this object
878
+ def update!(**args)
879
+ @account_summaries = args[:account_summaries] if args.key?(:account_summaries)
880
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
881
+ end
882
+ end
883
+
884
+ # Request message for ListAccounts RPC.
885
+ class GoogleAnalyticsAdminV1betaListAccountsResponse
886
+ include Google::Apis::Core::Hashable
887
+
888
+ # Results that were accessible to the caller.
889
+ # Corresponds to the JSON property `accounts`
890
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount>]
891
+ attr_accessor :accounts
892
+
893
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
894
+ # field is omitted, there are no subsequent pages.
895
+ # Corresponds to the JSON property `nextPageToken`
896
+ # @return [String]
897
+ attr_accessor :next_page_token
898
+
899
+ def initialize(**args)
900
+ update!(**args)
901
+ end
902
+
903
+ # Update properties of this object
904
+ def update!(**args)
905
+ @accounts = args[:accounts] if args.key?(:accounts)
906
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
907
+ end
908
+ end
909
+
910
+ # Response message for ListConversionEvents RPC.
911
+ class GoogleAnalyticsAdminV1betaListConversionEventsResponse
912
+ include Google::Apis::Core::Hashable
913
+
914
+ # The requested conversion events
915
+ # Corresponds to the JSON property `conversionEvents`
916
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent>]
917
+ attr_accessor :conversion_events
918
+
919
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
920
+ # field is omitted, there are no subsequent pages.
921
+ # Corresponds to the JSON property `nextPageToken`
922
+ # @return [String]
923
+ attr_accessor :next_page_token
924
+
925
+ def initialize(**args)
926
+ update!(**args)
927
+ end
928
+
929
+ # Update properties of this object
930
+ def update!(**args)
931
+ @conversion_events = args[:conversion_events] if args.key?(:conversion_events)
932
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
933
+ end
934
+ end
935
+
936
+ # Response message for ListCustomDimensions RPC.
937
+ class GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
938
+ include Google::Apis::Core::Hashable
939
+
940
+ # List of CustomDimensions.
941
+ # Corresponds to the JSON property `customDimensions`
942
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension>]
943
+ attr_accessor :custom_dimensions
944
+
945
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
946
+ # field is omitted, there are no subsequent pages.
947
+ # Corresponds to the JSON property `nextPageToken`
948
+ # @return [String]
949
+ attr_accessor :next_page_token
950
+
951
+ def initialize(**args)
952
+ update!(**args)
953
+ end
954
+
955
+ # Update properties of this object
956
+ def update!(**args)
957
+ @custom_dimensions = args[:custom_dimensions] if args.key?(:custom_dimensions)
958
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
959
+ end
960
+ end
961
+
962
+ # Response message for ListCustomMetrics RPC.
963
+ class GoogleAnalyticsAdminV1betaListCustomMetricsResponse
964
+ include Google::Apis::Core::Hashable
965
+
966
+ # List of CustomMetrics.
967
+ # Corresponds to the JSON property `customMetrics`
968
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric>]
969
+ attr_accessor :custom_metrics
970
+
971
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
972
+ # field is omitted, there are no subsequent pages.
973
+ # Corresponds to the JSON property `nextPageToken`
974
+ # @return [String]
975
+ attr_accessor :next_page_token
976
+
977
+ def initialize(**args)
978
+ update!(**args)
979
+ end
980
+
981
+ # Update properties of this object
982
+ def update!(**args)
983
+ @custom_metrics = args[:custom_metrics] if args.key?(:custom_metrics)
984
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
985
+ end
986
+ end
987
+
988
+ # Response message for ListDataStreams RPC.
989
+ class GoogleAnalyticsAdminV1betaListDataStreamsResponse
990
+ include Google::Apis::Core::Hashable
991
+
992
+ # List of DataStreams.
993
+ # Corresponds to the JSON property `dataStreams`
994
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream>]
995
+ attr_accessor :data_streams
996
+
997
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
998
+ # field is omitted, there are no subsequent pages.
999
+ # Corresponds to the JSON property `nextPageToken`
1000
+ # @return [String]
1001
+ attr_accessor :next_page_token
1002
+
1003
+ def initialize(**args)
1004
+ update!(**args)
1005
+ end
1006
+
1007
+ # Update properties of this object
1008
+ def update!(**args)
1009
+ @data_streams = args[:data_streams] if args.key?(:data_streams)
1010
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1011
+ end
1012
+ end
1013
+
1014
+ # Response message for ListFirebaseLinks RPC
1015
+ class GoogleAnalyticsAdminV1betaListFirebaseLinksResponse
1016
+ include Google::Apis::Core::Hashable
1017
+
1018
+ # List of FirebaseLinks. This will have at most one value.
1019
+ # Corresponds to the JSON property `firebaseLinks`
1020
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink>]
1021
+ attr_accessor :firebase_links
1022
+
1023
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1024
+ # field is omitted, there are no subsequent pages. Currently, Google Analytics
1025
+ # supports only one FirebaseLink per property, so this will never be populated.
1026
+ # Corresponds to the JSON property `nextPageToken`
1027
+ # @return [String]
1028
+ attr_accessor :next_page_token
1029
+
1030
+ def initialize(**args)
1031
+ update!(**args)
1032
+ end
1033
+
1034
+ # Update properties of this object
1035
+ def update!(**args)
1036
+ @firebase_links = args[:firebase_links] if args.key?(:firebase_links)
1037
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1038
+ end
1039
+ end
1040
+
1041
+ # Response message for ListGoogleAdsLinks RPC.
1042
+ class GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse
1043
+ include Google::Apis::Core::Hashable
1044
+
1045
+ # List of GoogleAdsLinks.
1046
+ # Corresponds to the JSON property `googleAdsLinks`
1047
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink>]
1048
+ attr_accessor :google_ads_links
1049
+
1050
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1051
+ # field is omitted, there are no subsequent pages.
1052
+ # Corresponds to the JSON property `nextPageToken`
1053
+ # @return [String]
1054
+ attr_accessor :next_page_token
1055
+
1056
+ def initialize(**args)
1057
+ update!(**args)
1058
+ end
1059
+
1060
+ # Update properties of this object
1061
+ def update!(**args)
1062
+ @google_ads_links = args[:google_ads_links] if args.key?(:google_ads_links)
1063
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1064
+ end
1065
+ end
1066
+
1067
+ # Response message for ListMeasurementProtocolSecret RPC
1068
+ class GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse
1069
+ include Google::Apis::Core::Hashable
1070
+
1071
+ # A list of secrets for the parent stream specified in the request.
1072
+ # Corresponds to the JSON property `measurementProtocolSecrets`
1073
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret>]
1074
+ attr_accessor :measurement_protocol_secrets
1075
+
1076
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1077
+ # field is omitted, there are no subsequent pages.
1078
+ # Corresponds to the JSON property `nextPageToken`
1079
+ # @return [String]
1080
+ attr_accessor :next_page_token
1081
+
1082
+ def initialize(**args)
1083
+ update!(**args)
1084
+ end
1085
+
1086
+ # Update properties of this object
1087
+ def update!(**args)
1088
+ @measurement_protocol_secrets = args[:measurement_protocol_secrets] if args.key?(:measurement_protocol_secrets)
1089
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1090
+ end
1091
+ end
1092
+
1093
+ # Response message for ListProperties RPC.
1094
+ class GoogleAnalyticsAdminV1betaListPropertiesResponse
1095
+ include Google::Apis::Core::Hashable
1096
+
1097
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1098
+ # field is omitted, there are no subsequent pages.
1099
+ # Corresponds to the JSON property `nextPageToken`
1100
+ # @return [String]
1101
+ attr_accessor :next_page_token
1102
+
1103
+ # Results that matched the filter criteria and were accessible to the caller.
1104
+ # Corresponds to the JSON property `properties`
1105
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty>]
1106
+ attr_accessor :properties
1107
+
1108
+ def initialize(**args)
1109
+ update!(**args)
1110
+ end
1111
+
1112
+ # Update properties of this object
1113
+ def update!(**args)
1114
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1115
+ @properties = args[:properties] if args.key?(:properties)
1116
+ end
1117
+ end
1118
+
1119
+ # A secret value used for sending hits to Measurement Protocol.
1120
+ class GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
1121
+ include Google::Apis::Core::Hashable
1122
+
1123
+ # Required. Human-readable display name for this secret.
1124
+ # Corresponds to the JSON property `displayName`
1125
+ # @return [String]
1126
+ attr_accessor :display_name
1127
+
1128
+ # Output only. Resource name of this secret. This secret may be a child of any
1129
+ # type of stream. Format: properties/`property`/dataStreams/`dataStream`/
1130
+ # measurementProtocolSecrets/`measurementProtocolSecret`
1131
+ # Corresponds to the JSON property `name`
1132
+ # @return [String]
1133
+ attr_accessor :name
1134
+
1135
+ # Output only. The measurement protocol secret value. Pass this value to the
1136
+ # api_secret field of the Measurement Protocol API when sending hits to this
1137
+ # secret's parent property.
1138
+ # Corresponds to the JSON property `secretValue`
1139
+ # @return [String]
1140
+ attr_accessor :secret_value
1141
+
1142
+ def initialize(**args)
1143
+ update!(**args)
1144
+ end
1145
+
1146
+ # Update properties of this object
1147
+ def update!(**args)
1148
+ @display_name = args[:display_name] if args.key?(:display_name)
1149
+ @name = args[:name] if args.key?(:name)
1150
+ @secret_value = args[:secret_value] if args.key?(:secret_value)
1151
+ end
1152
+ end
1153
+
1154
+ # A resource message representing a Google Analytics GA4 property.
1155
+ class GoogleAnalyticsAdminV1betaProperty
1156
+ include Google::Apis::Core::Hashable
1157
+
1158
+ # Immutable. The resource name of the parent account Format: accounts/`
1159
+ # account_id` Example: "accounts/123"
1160
+ # Corresponds to the JSON property `account`
1161
+ # @return [String]
1162
+ attr_accessor :account
1163
+
1164
+ # Output only. Time when the entity was originally created.
1165
+ # Corresponds to the JSON property `createTime`
1166
+ # @return [String]
1167
+ attr_accessor :create_time
1168
+
1169
+ # The currency type used in reports involving monetary values. Format: https://
1170
+ # en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
1171
+ # Corresponds to the JSON property `currencyCode`
1172
+ # @return [String]
1173
+ attr_accessor :currency_code
1174
+
1175
+ # Output only. If set, the time at which this property was trashed. If not set,
1176
+ # then this property is not currently in the trash can.
1177
+ # Corresponds to the JSON property `deleteTime`
1178
+ # @return [String]
1179
+ attr_accessor :delete_time
1180
+
1181
+ # Required. Human-readable display name for this property. The max allowed
1182
+ # display name length is 100 UTF-16 code units.
1183
+ # Corresponds to the JSON property `displayName`
1184
+ # @return [String]
1185
+ attr_accessor :display_name
1186
+
1187
+ # Output only. If set, the time at which this trashed property will be
1188
+ # permanently deleted. If not set, then this property is not currently in the
1189
+ # trash can and is not slated to be deleted.
1190
+ # Corresponds to the JSON property `expireTime`
1191
+ # @return [String]
1192
+ attr_accessor :expire_time
1193
+
1194
+ # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
1195
+ # Corresponds to the JSON property `industryCategory`
1196
+ # @return [String]
1197
+ attr_accessor :industry_category
1198
+
1199
+ # Output only. Resource name of this property. Format: properties/`property_id`
1200
+ # Example: "properties/1000"
1201
+ # Corresponds to the JSON property `name`
1202
+ # @return [String]
1203
+ attr_accessor :name
1204
+
1205
+ # Immutable. Resource name of this property's logical parent. Note: The Property-
1206
+ # Moving UI can be used to change the parent. Format: accounts/`account`,
1207
+ # properties/`property` Example: "accounts/100", "properties/101"
1208
+ # Corresponds to the JSON property `parent`
1209
+ # @return [String]
1210
+ attr_accessor :parent
1211
+
1212
+ # Immutable. The property type for this Property resource. When creating a
1213
+ # property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY"
1214
+ # will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be
1215
+ # created via Google Analytics Admin API.
1216
+ # Corresponds to the JSON property `propertyType`
1217
+ # @return [String]
1218
+ attr_accessor :property_type
1219
+
1220
+ # Output only. The Google Analytics service level that applies to this property.
1221
+ # Corresponds to the JSON property `serviceLevel`
1222
+ # @return [String]
1223
+ attr_accessor :service_level
1224
+
1225
+ # Required. Reporting Time Zone, used as the day boundary for reports,
1226
+ # regardless of where the data originates. If the time zone honors DST,
1227
+ # Analytics will automatically adjust for the changes. NOTE: Changing the time
1228
+ # zone only affects data going forward, and is not applied retroactively. Format:
1229
+ # https://www.iana.org/time-zones Example: "America/Los_Angeles"
1230
+ # Corresponds to the JSON property `timeZone`
1231
+ # @return [String]
1232
+ attr_accessor :time_zone
1233
+
1234
+ # Output only. Time when entity payload fields were last updated.
1235
+ # Corresponds to the JSON property `updateTime`
1236
+ # @return [String]
1237
+ attr_accessor :update_time
1238
+
1239
+ def initialize(**args)
1240
+ update!(**args)
1241
+ end
1242
+
1243
+ # Update properties of this object
1244
+ def update!(**args)
1245
+ @account = args[:account] if args.key?(:account)
1246
+ @create_time = args[:create_time] if args.key?(:create_time)
1247
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
1248
+ @delete_time = args[:delete_time] if args.key?(:delete_time)
1249
+ @display_name = args[:display_name] if args.key?(:display_name)
1250
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
1251
+ @industry_category = args[:industry_category] if args.key?(:industry_category)
1252
+ @name = args[:name] if args.key?(:name)
1253
+ @parent = args[:parent] if args.key?(:parent)
1254
+ @property_type = args[:property_type] if args.key?(:property_type)
1255
+ @service_level = args[:service_level] if args.key?(:service_level)
1256
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
1257
+ @update_time = args[:update_time] if args.key?(:update_time)
1258
+ end
1259
+ end
1260
+
1261
+ # A virtual resource representing metadata for a GA4 property.
1262
+ class GoogleAnalyticsAdminV1betaPropertySummary
1263
+ include Google::Apis::Core::Hashable
1264
+
1265
+ # Display name for the property referred to in this property summary.
1266
+ # Corresponds to the JSON property `displayName`
1267
+ # @return [String]
1268
+ attr_accessor :display_name
1269
+
1270
+ # Resource name of this property's logical parent. Note: The Property-Moving UI
1271
+ # can be used to change the parent. Format: accounts/`account`, properties/`
1272
+ # property` Example: "accounts/100", "properties/200"
1273
+ # Corresponds to the JSON property `parent`
1274
+ # @return [String]
1275
+ attr_accessor :parent
1276
+
1277
+ # Resource name of property referred to by this property summary Format:
1278
+ # properties/`property_id` Example: "properties/1000"
1279
+ # Corresponds to the JSON property `property`
1280
+ # @return [String]
1281
+ attr_accessor :property
1282
+
1283
+ # The property's property type.
1284
+ # Corresponds to the JSON property `propertyType`
1285
+ # @return [String]
1286
+ attr_accessor :property_type
1287
+
1288
+ def initialize(**args)
1289
+ update!(**args)
1290
+ end
1291
+
1292
+ # Update properties of this object
1293
+ def update!(**args)
1294
+ @display_name = args[:display_name] if args.key?(:display_name)
1295
+ @parent = args[:parent] if args.key?(:parent)
1296
+ @property = args[:property] if args.key?(:property)
1297
+ @property_type = args[:property_type] if args.key?(:property_type)
1298
+ end
1299
+ end
1300
+
1301
+ # Request message for ProvisionAccountTicket RPC.
1302
+ class GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest
1303
+ include Google::Apis::Core::Hashable
1304
+
1305
+ # A resource message representing a Google Analytics account.
1306
+ # Corresponds to the JSON property `account`
1307
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount]
1308
+ attr_accessor :account
1309
+
1310
+ # Redirect URI where the user will be sent after accepting Terms of Service.
1311
+ # Must be configured in Developers Console as a Redirect URI
1312
+ # Corresponds to the JSON property `redirectUri`
1313
+ # @return [String]
1314
+ attr_accessor :redirect_uri
1315
+
1316
+ def initialize(**args)
1317
+ update!(**args)
1318
+ end
1319
+
1320
+ # Update properties of this object
1321
+ def update!(**args)
1322
+ @account = args[:account] if args.key?(:account)
1323
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
1324
+ end
1325
+ end
1326
+
1327
+ # Response message for ProvisionAccountTicket RPC.
1328
+ class GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse
1329
+ include Google::Apis::Core::Hashable
1330
+
1331
+ # The param to be passed in the ToS link.
1332
+ # Corresponds to the JSON property `accountTicketId`
1333
+ # @return [String]
1334
+ attr_accessor :account_ticket_id
1335
+
1336
+ def initialize(**args)
1337
+ update!(**args)
1338
+ end
1339
+
1340
+ # Update properties of this object
1341
+ def update!(**args)
1342
+ @account_ticket_id = args[:account_ticket_id] if args.key?(:account_ticket_id)
1343
+ end
1344
+ end
1345
+
1346
+ # Request message for SearchChangeHistoryEvents RPC.
1347
+ class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest
1348
+ include Google::Apis::Core::Hashable
1349
+
1350
+ # Optional. If set, only return changes that match one or more of these types of
1351
+ # actions.
1352
+ # Corresponds to the JSON property `action`
1353
+ # @return [Array<String>]
1354
+ attr_accessor :action
1355
+
1356
+ # Optional. If set, only return changes if they are made by a user in this list.
1357
+ # Corresponds to the JSON property `actorEmail`
1358
+ # @return [Array<String>]
1359
+ attr_accessor :actor_email
1360
+
1361
+ # Optional. If set, only return changes made after this time (inclusive).
1362
+ # Corresponds to the JSON property `earliestChangeTime`
1363
+ # @return [String]
1364
+ attr_accessor :earliest_change_time
1365
+
1366
+ # Optional. If set, only return changes made before this time (inclusive).
1367
+ # Corresponds to the JSON property `latestChangeTime`
1368
+ # @return [String]
1369
+ attr_accessor :latest_change_time
1370
+
1371
+ # Optional. The maximum number of ChangeHistoryEvent items to return. The
1372
+ # service may return fewer than this value, even if there are additional pages.
1373
+ # If unspecified, at most 50 items will be returned. The maximum value is 200 (
1374
+ # higher values will be coerced to the maximum).
1375
+ # Corresponds to the JSON property `pageSize`
1376
+ # @return [Fixnum]
1377
+ attr_accessor :page_size
1378
+
1379
+ # Optional. A page token, received from a previous `SearchChangeHistoryEvents`
1380
+ # call. Provide this to retrieve the subsequent page. When paginating, all other
1381
+ # parameters provided to `SearchChangeHistoryEvents` must match the call that
1382
+ # provided the page token.
1383
+ # Corresponds to the JSON property `pageToken`
1384
+ # @return [String]
1385
+ attr_accessor :page_token
1386
+
1387
+ # Optional. Resource name for a child property. If set, only return changes made
1388
+ # to this property or its child resources.
1389
+ # Corresponds to the JSON property `property`
1390
+ # @return [String]
1391
+ attr_accessor :property
1392
+
1393
+ # Optional. If set, only return changes if they are for a resource that matches
1394
+ # at least one of these types.
1395
+ # Corresponds to the JSON property `resourceType`
1396
+ # @return [Array<String>]
1397
+ attr_accessor :resource_type
1398
+
1399
+ def initialize(**args)
1400
+ update!(**args)
1401
+ end
1402
+
1403
+ # Update properties of this object
1404
+ def update!(**args)
1405
+ @action = args[:action] if args.key?(:action)
1406
+ @actor_email = args[:actor_email] if args.key?(:actor_email)
1407
+ @earliest_change_time = args[:earliest_change_time] if args.key?(:earliest_change_time)
1408
+ @latest_change_time = args[:latest_change_time] if args.key?(:latest_change_time)
1409
+ @page_size = args[:page_size] if args.key?(:page_size)
1410
+ @page_token = args[:page_token] if args.key?(:page_token)
1411
+ @property = args[:property] if args.key?(:property)
1412
+ @resource_type = args[:resource_type] if args.key?(:resource_type)
1413
+ end
1414
+ end
1415
+
1416
+ # Response message for SearchAccounts RPC.
1417
+ class GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse
1418
+ include Google::Apis::Core::Hashable
1419
+
1420
+ # Results that were accessible to the caller.
1421
+ # Corresponds to the JSON property `changeHistoryEvents`
1422
+ # @return [Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaChangeHistoryEvent>]
1423
+ attr_accessor :change_history_events
1424
+
1425
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1426
+ # field is omitted, there are no subsequent pages.
1427
+ # Corresponds to the JSON property `nextPageToken`
1428
+ # @return [String]
1429
+ attr_accessor :next_page_token
1430
+
1431
+ def initialize(**args)
1432
+ update!(**args)
1433
+ end
1434
+
1435
+ # Update properties of this object
1436
+ def update!(**args)
1437
+ @change_history_events = args[:change_history_events] if args.key?(:change_history_events)
1438
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1439
+ end
1440
+ end
1441
+
1442
+ # A generic empty message that you can re-use to avoid defining duplicated empty
1443
+ # messages in your APIs. A typical example is to use it as the request or the
1444
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
1445
+ # protobuf.Empty) returns (google.protobuf.Empty); `
1446
+ class GoogleProtobufEmpty
1447
+ include Google::Apis::Core::Hashable
1448
+
1449
+ def initialize(**args)
1450
+ update!(**args)
1451
+ end
1452
+
1453
+ # Update properties of this object
1454
+ def update!(**args)
1455
+ end
1456
+ end
1457
+ end
1458
+ end
1459
+ end