google-analytics-admin 0.23.6__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. google/analytics/admin/__init__.py +615 -0
  2. google/analytics/admin/gapic_version.py +16 -0
  3. google/analytics/admin/py.typed +2 -0
  4. google/analytics/admin_v1alpha/__init__.py +613 -0
  5. google/analytics/admin_v1alpha/gapic_metadata.json +2278 -0
  6. google/analytics/admin_v1alpha/gapic_version.py +16 -0
  7. google/analytics/admin_v1alpha/py.typed +2 -0
  8. google/analytics/admin_v1alpha/services/__init__.py +15 -0
  9. google/analytics/admin_v1alpha/services/analytics_admin_service/__init__.py +22 -0
  10. google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py +14122 -0
  11. google/analytics/admin_v1alpha/services/analytics_admin_service/client.py +14680 -0
  12. google/analytics/admin_v1alpha/services/analytics_admin_service/pagers.py +4337 -0
  13. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/__init__.py +41 -0
  14. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py +2494 -0
  15. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py +4797 -0
  16. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py +5671 -0
  17. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py +31875 -0
  18. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest_base.py +7944 -0
  19. google/analytics/admin_v1alpha/types/__init__.py +602 -0
  20. google/analytics/admin_v1alpha/types/access_report.py +705 -0
  21. google/analytics/admin_v1alpha/types/analytics_admin.py +4997 -0
  22. google/analytics/admin_v1alpha/types/audience.py +781 -0
  23. google/analytics/admin_v1alpha/types/channel_group.py +309 -0
  24. google/analytics/admin_v1alpha/types/event_create_and_edit.py +298 -0
  25. google/analytics/admin_v1alpha/types/expanded_data_set.py +282 -0
  26. google/analytics/admin_v1alpha/types/resources.py +3289 -0
  27. google/analytics/admin_v1alpha/types/subproperty_event_filter.py +292 -0
  28. google/analytics/admin_v1beta/__init__.py +255 -0
  29. google/analytics/admin_v1beta/gapic_metadata.json +838 -0
  30. google/analytics/admin_v1beta/gapic_version.py +16 -0
  31. google/analytics/admin_v1beta/py.typed +2 -0
  32. google/analytics/admin_v1beta/services/__init__.py +15 -0
  33. google/analytics/admin_v1beta/services/analytics_admin_service/__init__.py +22 -0
  34. google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py +6707 -0
  35. google/analytics/admin_v1beta/services/analytics_admin_service/client.py +7164 -0
  36. google/analytics/admin_v1beta/services/analytics_admin_service/pagers.py +1927 -0
  37. google/analytics/admin_v1beta/services/analytics_admin_service/transports/__init__.py +41 -0
  38. google/analytics/admin_v1beta/services/analytics_admin_service/transports/base.py +965 -0
  39. google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py +1917 -0
  40. google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py +2251 -0
  41. google/analytics/admin_v1beta/services/analytics_admin_service/transports/rest.py +11423 -0
  42. google/analytics/admin_v1beta/services/analytics_admin_service/transports/rest_base.py +2857 -0
  43. google/analytics/admin_v1beta/types/__init__.py +244 -0
  44. google/analytics/admin_v1beta/types/access_report.py +705 -0
  45. google/analytics/admin_v1beta/types/analytics_admin.py +2006 -0
  46. google/analytics/admin_v1beta/types/resources.py +1677 -0
  47. google_analytics_admin-0.23.6.dist-info/LICENSE +202 -0
  48. google_analytics_admin-0.23.6.dist-info/METADATA +228 -0
  49. google_analytics_admin-0.23.6.dist-info/RECORD +51 -0
  50. google_analytics_admin-0.23.6.dist-info/WHEEL +5 -0
  51. google_analytics_admin-0.23.6.dist-info/top_level.txt +1 -0
@@ -0,0 +1,1677 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2024 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ from __future__ import annotations
17
+
18
+ from typing import MutableMapping, MutableSequence
19
+
20
+ from google.protobuf import timestamp_pb2 # type: ignore
21
+ from google.protobuf import wrappers_pb2 # type: ignore
22
+ import proto # type: ignore
23
+
24
+ __protobuf__ = proto.module(
25
+ package="google.analytics.admin.v1beta",
26
+ manifest={
27
+ "IndustryCategory",
28
+ "ServiceLevel",
29
+ "ActorType",
30
+ "ActionType",
31
+ "ChangeHistoryResourceType",
32
+ "PropertyType",
33
+ "Account",
34
+ "Property",
35
+ "DataStream",
36
+ "FirebaseLink",
37
+ "GoogleAdsLink",
38
+ "DataSharingSettings",
39
+ "AccountSummary",
40
+ "PropertySummary",
41
+ "MeasurementProtocolSecret",
42
+ "ChangeHistoryEvent",
43
+ "ChangeHistoryChange",
44
+ "ConversionEvent",
45
+ "KeyEvent",
46
+ "CustomDimension",
47
+ "CustomMetric",
48
+ "DataRetentionSettings",
49
+ },
50
+ )
51
+
52
+
53
+ class IndustryCategory(proto.Enum):
54
+ r"""The category selected for this property, used for industry
55
+ benchmarking.
56
+
57
+ Values:
58
+ INDUSTRY_CATEGORY_UNSPECIFIED (0):
59
+ Industry category unspecified
60
+ AUTOMOTIVE (1):
61
+ Automotive
62
+ BUSINESS_AND_INDUSTRIAL_MARKETS (2):
63
+ Business and industrial markets
64
+ FINANCE (3):
65
+ Finance
66
+ HEALTHCARE (4):
67
+ Healthcare
68
+ TECHNOLOGY (5):
69
+ Technology
70
+ TRAVEL (6):
71
+ Travel
72
+ OTHER (7):
73
+ Other
74
+ ARTS_AND_ENTERTAINMENT (8):
75
+ Arts and entertainment
76
+ BEAUTY_AND_FITNESS (9):
77
+ Beauty and fitness
78
+ BOOKS_AND_LITERATURE (10):
79
+ Books and literature
80
+ FOOD_AND_DRINK (11):
81
+ Food and drink
82
+ GAMES (12):
83
+ Games
84
+ HOBBIES_AND_LEISURE (13):
85
+ Hobbies and leisure
86
+ HOME_AND_GARDEN (14):
87
+ Home and garden
88
+ INTERNET_AND_TELECOM (15):
89
+ Internet and telecom
90
+ LAW_AND_GOVERNMENT (16):
91
+ Law and government
92
+ NEWS (17):
93
+ News
94
+ ONLINE_COMMUNITIES (18):
95
+ Online communities
96
+ PEOPLE_AND_SOCIETY (19):
97
+ People and society
98
+ PETS_AND_ANIMALS (20):
99
+ Pets and animals
100
+ REAL_ESTATE (21):
101
+ Real estate
102
+ REFERENCE (22):
103
+ Reference
104
+ SCIENCE (23):
105
+ Science
106
+ SPORTS (24):
107
+ Sports
108
+ JOBS_AND_EDUCATION (25):
109
+ Jobs and education
110
+ SHOPPING (26):
111
+ Shopping
112
+ """
113
+ INDUSTRY_CATEGORY_UNSPECIFIED = 0
114
+ AUTOMOTIVE = 1
115
+ BUSINESS_AND_INDUSTRIAL_MARKETS = 2
116
+ FINANCE = 3
117
+ HEALTHCARE = 4
118
+ TECHNOLOGY = 5
119
+ TRAVEL = 6
120
+ OTHER = 7
121
+ ARTS_AND_ENTERTAINMENT = 8
122
+ BEAUTY_AND_FITNESS = 9
123
+ BOOKS_AND_LITERATURE = 10
124
+ FOOD_AND_DRINK = 11
125
+ GAMES = 12
126
+ HOBBIES_AND_LEISURE = 13
127
+ HOME_AND_GARDEN = 14
128
+ INTERNET_AND_TELECOM = 15
129
+ LAW_AND_GOVERNMENT = 16
130
+ NEWS = 17
131
+ ONLINE_COMMUNITIES = 18
132
+ PEOPLE_AND_SOCIETY = 19
133
+ PETS_AND_ANIMALS = 20
134
+ REAL_ESTATE = 21
135
+ REFERENCE = 22
136
+ SCIENCE = 23
137
+ SPORTS = 24
138
+ JOBS_AND_EDUCATION = 25
139
+ SHOPPING = 26
140
+
141
+
142
+ class ServiceLevel(proto.Enum):
143
+ r"""Various levels of service for Google Analytics.
144
+
145
+ Values:
146
+ SERVICE_LEVEL_UNSPECIFIED (0):
147
+ Service level not specified or invalid.
148
+ GOOGLE_ANALYTICS_STANDARD (1):
149
+ The standard version of Google Analytics.
150
+ GOOGLE_ANALYTICS_360 (2):
151
+ The paid, premium version of Google
152
+ Analytics.
153
+ """
154
+ SERVICE_LEVEL_UNSPECIFIED = 0
155
+ GOOGLE_ANALYTICS_STANDARD = 1
156
+ GOOGLE_ANALYTICS_360 = 2
157
+
158
+
159
+ class ActorType(proto.Enum):
160
+ r"""Different kinds of actors that can make changes to Google
161
+ Analytics resources.
162
+
163
+ Values:
164
+ ACTOR_TYPE_UNSPECIFIED (0):
165
+ Unknown or unspecified actor type.
166
+ USER (1):
167
+ Changes made by the user specified in actor_email.
168
+ SYSTEM (2):
169
+ Changes made by the Google Analytics system.
170
+ SUPPORT (3):
171
+ Changes made by Google Analytics support team
172
+ staff.
173
+ """
174
+ ACTOR_TYPE_UNSPECIFIED = 0
175
+ USER = 1
176
+ SYSTEM = 2
177
+ SUPPORT = 3
178
+
179
+
180
+ class ActionType(proto.Enum):
181
+ r"""Types of actions that may change a resource.
182
+
183
+ Values:
184
+ ACTION_TYPE_UNSPECIFIED (0):
185
+ Action type unknown or not specified.
186
+ CREATED (1):
187
+ Resource was created in this change.
188
+ UPDATED (2):
189
+ Resource was updated in this change.
190
+ DELETED (3):
191
+ Resource was deleted in this change.
192
+ """
193
+ ACTION_TYPE_UNSPECIFIED = 0
194
+ CREATED = 1
195
+ UPDATED = 2
196
+ DELETED = 3
197
+
198
+
199
+ class ChangeHistoryResourceType(proto.Enum):
200
+ r"""Types of resources whose changes may be returned from change
201
+ history.
202
+
203
+ Values:
204
+ CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED (0):
205
+ Resource type unknown or not specified.
206
+ ACCOUNT (1):
207
+ Account resource
208
+ PROPERTY (2):
209
+ Property resource
210
+ FIREBASE_LINK (6):
211
+ FirebaseLink resource
212
+ GOOGLE_ADS_LINK (7):
213
+ GoogleAdsLink resource
214
+ GOOGLE_SIGNALS_SETTINGS (8):
215
+ GoogleSignalsSettings resource
216
+ CONVERSION_EVENT (9):
217
+ ConversionEvent resource
218
+ MEASUREMENT_PROTOCOL_SECRET (10):
219
+ MeasurementProtocolSecret resource
220
+ CUSTOM_DIMENSION (11):
221
+ CustomDimension resource
222
+ CUSTOM_METRIC (12):
223
+ CustomMetric resource
224
+ DATA_RETENTION_SETTINGS (13):
225
+ DataRetentionSettings resource
226
+ DISPLAY_VIDEO_360_ADVERTISER_LINK (14):
227
+ DisplayVideo360AdvertiserLink resource
228
+ DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL (15):
229
+ DisplayVideo360AdvertiserLinkProposal
230
+ resource
231
+ DATA_STREAM (18):
232
+ DataStream resource
233
+ ATTRIBUTION_SETTINGS (20):
234
+ AttributionSettings resource
235
+ """
236
+ CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0
237
+ ACCOUNT = 1
238
+ PROPERTY = 2
239
+ FIREBASE_LINK = 6
240
+ GOOGLE_ADS_LINK = 7
241
+ GOOGLE_SIGNALS_SETTINGS = 8
242
+ CONVERSION_EVENT = 9
243
+ MEASUREMENT_PROTOCOL_SECRET = 10
244
+ CUSTOM_DIMENSION = 11
245
+ CUSTOM_METRIC = 12
246
+ DATA_RETENTION_SETTINGS = 13
247
+ DISPLAY_VIDEO_360_ADVERTISER_LINK = 14
248
+ DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15
249
+ DATA_STREAM = 18
250
+ ATTRIBUTION_SETTINGS = 20
251
+
252
+
253
+ class PropertyType(proto.Enum):
254
+ r"""Types of ``Property`` resources.
255
+
256
+ Values:
257
+ PROPERTY_TYPE_UNSPECIFIED (0):
258
+ Unknown or unspecified property type
259
+ PROPERTY_TYPE_ORDINARY (1):
260
+ Ordinary Google Analytics property
261
+ PROPERTY_TYPE_SUBPROPERTY (2):
262
+ Google Analytics subproperty
263
+ PROPERTY_TYPE_ROLLUP (3):
264
+ Google Analytics rollup property
265
+ """
266
+ PROPERTY_TYPE_UNSPECIFIED = 0
267
+ PROPERTY_TYPE_ORDINARY = 1
268
+ PROPERTY_TYPE_SUBPROPERTY = 2
269
+ PROPERTY_TYPE_ROLLUP = 3
270
+
271
+
272
+ class Account(proto.Message):
273
+ r"""A resource message representing a Google Analytics account.
274
+
275
+ Attributes:
276
+ name (str):
277
+ Output only. Resource name of this account.
278
+ Format: accounts/{account}
279
+ Example: "accounts/100".
280
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
281
+ Output only. Time when this account was
282
+ originally created.
283
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
284
+ Output only. Time when account payload fields
285
+ were last updated.
286
+ display_name (str):
287
+ Required. Human-readable display name for
288
+ this account.
289
+ region_code (str):
290
+ Country of business. Must be a Unicode CLDR
291
+ region code.
292
+ deleted (bool):
293
+ Output only. Indicates whether this Account
294
+ is soft-deleted or not. Deleted accounts are
295
+ excluded from List results unless specifically
296
+ requested.
297
+ gmp_organization (str):
298
+ Output only. The URI for a Google Marketing Platform
299
+ organization resource. Only set when this account is
300
+ connected to a GMP organization. Format:
301
+ marketingplatformadmin.googleapis.com/organizations/{org_id}
302
+ """
303
+
304
+ name: str = proto.Field(
305
+ proto.STRING,
306
+ number=1,
307
+ )
308
+ create_time: timestamp_pb2.Timestamp = proto.Field(
309
+ proto.MESSAGE,
310
+ number=2,
311
+ message=timestamp_pb2.Timestamp,
312
+ )
313
+ update_time: timestamp_pb2.Timestamp = proto.Field(
314
+ proto.MESSAGE,
315
+ number=3,
316
+ message=timestamp_pb2.Timestamp,
317
+ )
318
+ display_name: str = proto.Field(
319
+ proto.STRING,
320
+ number=4,
321
+ )
322
+ region_code: str = proto.Field(
323
+ proto.STRING,
324
+ number=5,
325
+ )
326
+ deleted: bool = proto.Field(
327
+ proto.BOOL,
328
+ number=6,
329
+ )
330
+ gmp_organization: str = proto.Field(
331
+ proto.STRING,
332
+ number=7,
333
+ )
334
+
335
+
336
+ class Property(proto.Message):
337
+ r"""A resource message representing a Google Analytics property.
338
+
339
+ Attributes:
340
+ name (str):
341
+ Output only. Resource name of this property. Format:
342
+ properties/{property_id} Example: "properties/1000".
343
+ property_type (google.analytics.admin_v1beta.types.PropertyType):
344
+ Immutable. The property type for this Property resource.
345
+ When creating a property, if the type is
346
+ "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will
347
+ be implied.
348
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
349
+ Output only. Time when the entity was
350
+ originally created.
351
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
352
+ Output only. Time when entity payload fields
353
+ were last updated.
354
+ parent (str):
355
+ Immutable. Resource name of this property's
356
+ logical parent.
357
+ Note: The Property-Moving UI can be used to
358
+ change the parent. Format: accounts/{account},
359
+ properties/{property} Example: "accounts/100",
360
+ "properties/101".
361
+ display_name (str):
362
+ Required. Human-readable display name for
363
+ this property.
364
+ The max allowed display name length is 100
365
+ UTF-16 code units.
366
+ industry_category (google.analytics.admin_v1beta.types.IndustryCategory):
367
+ Industry associated with this property Example: AUTOMOTIVE,
368
+ FOOD_AND_DRINK
369
+ time_zone (str):
370
+ Required. Reporting Time Zone, used as the day boundary for
371
+ reports, regardless of where the data originates. If the
372
+ time zone honors DST, Analytics will automatically adjust
373
+ for the changes.
374
+
375
+ NOTE: Changing the time zone only affects data going
376
+ forward, and is not applied retroactively.
377
+
378
+ Format: https://www.iana.org/time-zones Example:
379
+ "America/Los_Angeles".
380
+ currency_code (str):
381
+ The currency type used in reports involving monetary values.
382
+
383
+ Format: https://en.wikipedia.org/wiki/ISO_4217 Examples:
384
+ "USD", "EUR", "JPY".
385
+ service_level (google.analytics.admin_v1beta.types.ServiceLevel):
386
+ Output only. The Google Analytics service
387
+ level that applies to this property.
388
+ delete_time (google.protobuf.timestamp_pb2.Timestamp):
389
+ Output only. If set, the time at which this
390
+ property was trashed. If not set, then this
391
+ property is not currently in the trash can.
392
+ expire_time (google.protobuf.timestamp_pb2.Timestamp):
393
+ Output only. If set, the time at which this
394
+ trashed property will be permanently deleted. If
395
+ not set, then this property is not currently in
396
+ the trash can and is not slated to be deleted.
397
+ account (str):
398
+ Immutable. The resource name of the parent account Format:
399
+ accounts/{account_id} Example: "accounts/123".
400
+ """
401
+
402
+ name: str = proto.Field(
403
+ proto.STRING,
404
+ number=1,
405
+ )
406
+ property_type: "PropertyType" = proto.Field(
407
+ proto.ENUM,
408
+ number=14,
409
+ enum="PropertyType",
410
+ )
411
+ create_time: timestamp_pb2.Timestamp = proto.Field(
412
+ proto.MESSAGE,
413
+ number=3,
414
+ message=timestamp_pb2.Timestamp,
415
+ )
416
+ update_time: timestamp_pb2.Timestamp = proto.Field(
417
+ proto.MESSAGE,
418
+ number=4,
419
+ message=timestamp_pb2.Timestamp,
420
+ )
421
+ parent: str = proto.Field(
422
+ proto.STRING,
423
+ number=2,
424
+ )
425
+ display_name: str = proto.Field(
426
+ proto.STRING,
427
+ number=5,
428
+ )
429
+ industry_category: "IndustryCategory" = proto.Field(
430
+ proto.ENUM,
431
+ number=6,
432
+ enum="IndustryCategory",
433
+ )
434
+ time_zone: str = proto.Field(
435
+ proto.STRING,
436
+ number=7,
437
+ )
438
+ currency_code: str = proto.Field(
439
+ proto.STRING,
440
+ number=8,
441
+ )
442
+ service_level: "ServiceLevel" = proto.Field(
443
+ proto.ENUM,
444
+ number=10,
445
+ enum="ServiceLevel",
446
+ )
447
+ delete_time: timestamp_pb2.Timestamp = proto.Field(
448
+ proto.MESSAGE,
449
+ number=11,
450
+ message=timestamp_pb2.Timestamp,
451
+ )
452
+ expire_time: timestamp_pb2.Timestamp = proto.Field(
453
+ proto.MESSAGE,
454
+ number=12,
455
+ message=timestamp_pb2.Timestamp,
456
+ )
457
+ account: str = proto.Field(
458
+ proto.STRING,
459
+ number=13,
460
+ )
461
+
462
+
463
+ class DataStream(proto.Message):
464
+ r"""A resource message representing a data stream.
465
+
466
+ This message has `oneof`_ fields (mutually exclusive fields).
467
+ For each oneof, at most one member field can be set at the same time.
468
+ Setting any member of the oneof automatically clears all other
469
+ members.
470
+
471
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
472
+
473
+ Attributes:
474
+ web_stream_data (google.analytics.admin_v1beta.types.DataStream.WebStreamData):
475
+ Data specific to web streams. Must be populated if type is
476
+ WEB_DATA_STREAM.
477
+
478
+ This field is a member of `oneof`_ ``stream_data``.
479
+ android_app_stream_data (google.analytics.admin_v1beta.types.DataStream.AndroidAppStreamData):
480
+ Data specific to Android app streams. Must be populated if
481
+ type is ANDROID_APP_DATA_STREAM.
482
+
483
+ This field is a member of `oneof`_ ``stream_data``.
484
+ ios_app_stream_data (google.analytics.admin_v1beta.types.DataStream.IosAppStreamData):
485
+ Data specific to iOS app streams. Must be populated if type
486
+ is IOS_APP_DATA_STREAM.
487
+
488
+ This field is a member of `oneof`_ ``stream_data``.
489
+ name (str):
490
+ Output only. Resource name of this Data Stream. Format:
491
+ properties/{property_id}/dataStreams/{stream_id} Example:
492
+ "properties/1000/dataStreams/2000".
493
+ type_ (google.analytics.admin_v1beta.types.DataStream.DataStreamType):
494
+ Required. Immutable. The type of this
495
+ DataStream resource.
496
+ display_name (str):
497
+ Human-readable display name for the Data
498
+ Stream.
499
+ Required for web data streams.
500
+
501
+ The max allowed display name length is 255
502
+ UTF-16 code units.
503
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
504
+ Output only. Time when this stream was
505
+ originally created.
506
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
507
+ Output only. Time when stream payload fields
508
+ were last updated.
509
+ """
510
+
511
+ class DataStreamType(proto.Enum):
512
+ r"""The type of the data stream.
513
+
514
+ Values:
515
+ DATA_STREAM_TYPE_UNSPECIFIED (0):
516
+ Type unknown or not specified.
517
+ WEB_DATA_STREAM (1):
518
+ Web data stream.
519
+ ANDROID_APP_DATA_STREAM (2):
520
+ Android app data stream.
521
+ IOS_APP_DATA_STREAM (3):
522
+ iOS app data stream.
523
+ """
524
+ DATA_STREAM_TYPE_UNSPECIFIED = 0
525
+ WEB_DATA_STREAM = 1
526
+ ANDROID_APP_DATA_STREAM = 2
527
+ IOS_APP_DATA_STREAM = 3
528
+
529
+ class WebStreamData(proto.Message):
530
+ r"""Data specific to web streams.
531
+
532
+ Attributes:
533
+ measurement_id (str):
534
+ Output only. Analytics Measurement ID.
535
+
536
+ Example: "G-1A2BCD345E".
537
+ firebase_app_id (str):
538
+ Output only. ID of the corresponding web app
539
+ in Firebase, if any. This ID can change if the
540
+ web app is deleted and recreated.
541
+ default_uri (str):
542
+ Domain name of the web app being measured, or
543
+ empty. Example: "http://www.google.com",
544
+ "https://www.google.com".
545
+ """
546
+
547
+ measurement_id: str = proto.Field(
548
+ proto.STRING,
549
+ number=1,
550
+ )
551
+ firebase_app_id: str = proto.Field(
552
+ proto.STRING,
553
+ number=2,
554
+ )
555
+ default_uri: str = proto.Field(
556
+ proto.STRING,
557
+ number=3,
558
+ )
559
+
560
+ class AndroidAppStreamData(proto.Message):
561
+ r"""Data specific to Android app streams.
562
+
563
+ Attributes:
564
+ firebase_app_id (str):
565
+ Output only. ID of the corresponding Android
566
+ app in Firebase, if any. This ID can change if
567
+ the Android app is deleted and recreated.
568
+ package_name (str):
569
+ Immutable. The package name for the app being
570
+ measured. Example: "com.example.myandroidapp".
571
+ """
572
+
573
+ firebase_app_id: str = proto.Field(
574
+ proto.STRING,
575
+ number=1,
576
+ )
577
+ package_name: str = proto.Field(
578
+ proto.STRING,
579
+ number=2,
580
+ )
581
+
582
+ class IosAppStreamData(proto.Message):
583
+ r"""Data specific to iOS app streams.
584
+
585
+ Attributes:
586
+ firebase_app_id (str):
587
+ Output only. ID of the corresponding iOS app
588
+ in Firebase, if any. This ID can change if the
589
+ iOS app is deleted and recreated.
590
+ bundle_id (str):
591
+ Required. Immutable. The Apple App Store
592
+ Bundle ID for the app Example:
593
+ "com.example.myiosapp".
594
+ """
595
+
596
+ firebase_app_id: str = proto.Field(
597
+ proto.STRING,
598
+ number=1,
599
+ )
600
+ bundle_id: str = proto.Field(
601
+ proto.STRING,
602
+ number=2,
603
+ )
604
+
605
+ web_stream_data: WebStreamData = proto.Field(
606
+ proto.MESSAGE,
607
+ number=6,
608
+ oneof="stream_data",
609
+ message=WebStreamData,
610
+ )
611
+ android_app_stream_data: AndroidAppStreamData = proto.Field(
612
+ proto.MESSAGE,
613
+ number=7,
614
+ oneof="stream_data",
615
+ message=AndroidAppStreamData,
616
+ )
617
+ ios_app_stream_data: IosAppStreamData = proto.Field(
618
+ proto.MESSAGE,
619
+ number=8,
620
+ oneof="stream_data",
621
+ message=IosAppStreamData,
622
+ )
623
+ name: str = proto.Field(
624
+ proto.STRING,
625
+ number=1,
626
+ )
627
+ type_: DataStreamType = proto.Field(
628
+ proto.ENUM,
629
+ number=2,
630
+ enum=DataStreamType,
631
+ )
632
+ display_name: str = proto.Field(
633
+ proto.STRING,
634
+ number=3,
635
+ )
636
+ create_time: timestamp_pb2.Timestamp = proto.Field(
637
+ proto.MESSAGE,
638
+ number=4,
639
+ message=timestamp_pb2.Timestamp,
640
+ )
641
+ update_time: timestamp_pb2.Timestamp = proto.Field(
642
+ proto.MESSAGE,
643
+ number=5,
644
+ message=timestamp_pb2.Timestamp,
645
+ )
646
+
647
+
648
+ class FirebaseLink(proto.Message):
649
+ r"""A link between a Google Analytics property and a Firebase
650
+ project.
651
+
652
+ Attributes:
653
+ name (str):
654
+ Output only. Example format:
655
+ properties/1234/firebaseLinks/5678
656
+ project (str):
657
+ Immutable. Firebase project resource name. When creating a
658
+ FirebaseLink, you may provide this resource name using
659
+ either a project number or project ID. Once this resource
660
+ has been created, returned FirebaseLinks will always have a
661
+ project_name that contains a project number.
662
+
663
+ Format: 'projects/{project number}' Example: 'projects/1234'
664
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
665
+ Output only. Time when this FirebaseLink was
666
+ originally created.
667
+ """
668
+
669
+ name: str = proto.Field(
670
+ proto.STRING,
671
+ number=1,
672
+ )
673
+ project: str = proto.Field(
674
+ proto.STRING,
675
+ number=2,
676
+ )
677
+ create_time: timestamp_pb2.Timestamp = proto.Field(
678
+ proto.MESSAGE,
679
+ number=3,
680
+ message=timestamp_pb2.Timestamp,
681
+ )
682
+
683
+
684
+ class GoogleAdsLink(proto.Message):
685
+ r"""A link between a Google Analytics property and a Google Ads
686
+ account.
687
+
688
+ Attributes:
689
+ name (str):
690
+ Output only. Format:
691
+
692
+ properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
693
+
694
+ Note: googleAdsLinkId is not the Google Ads
695
+ customer ID.
696
+ customer_id (str):
697
+ Immutable. Google Ads customer ID.
698
+ can_manage_clients (bool):
699
+ Output only. If true, this link is for a
700
+ Google Ads manager account.
701
+ ads_personalization_enabled (google.protobuf.wrappers_pb2.BoolValue):
702
+ Enable personalized advertising features with
703
+ this integration. Automatically publish my
704
+ Google Analytics audience lists and Google
705
+ Analytics remarketing events/parameters to the
706
+ linked Google Ads account. If this field is not
707
+ set on create/update, it will be defaulted to
708
+ true.
709
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
710
+ Output only. Time when this link was
711
+ originally created.
712
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
713
+ Output only. Time when this link was last
714
+ updated.
715
+ creator_email_address (str):
716
+ Output only. Email address of the user that
717
+ created the link. An empty string will be
718
+ returned if the email address can't be
719
+ retrieved.
720
+ """
721
+
722
+ name: str = proto.Field(
723
+ proto.STRING,
724
+ number=1,
725
+ )
726
+ customer_id: str = proto.Field(
727
+ proto.STRING,
728
+ number=3,
729
+ )
730
+ can_manage_clients: bool = proto.Field(
731
+ proto.BOOL,
732
+ number=4,
733
+ )
734
+ ads_personalization_enabled: wrappers_pb2.BoolValue = proto.Field(
735
+ proto.MESSAGE,
736
+ number=5,
737
+ message=wrappers_pb2.BoolValue,
738
+ )
739
+ create_time: timestamp_pb2.Timestamp = proto.Field(
740
+ proto.MESSAGE,
741
+ number=7,
742
+ message=timestamp_pb2.Timestamp,
743
+ )
744
+ update_time: timestamp_pb2.Timestamp = proto.Field(
745
+ proto.MESSAGE,
746
+ number=8,
747
+ message=timestamp_pb2.Timestamp,
748
+ )
749
+ creator_email_address: str = proto.Field(
750
+ proto.STRING,
751
+ number=9,
752
+ )
753
+
754
+
755
+ class DataSharingSettings(proto.Message):
756
+ r"""A resource message representing data sharing settings of a
757
+ Google Analytics account.
758
+
759
+ Attributes:
760
+ name (str):
761
+ Output only. Resource name.
762
+ Format: accounts/{account}/dataSharingSettings
763
+ Example: "accounts/1000/dataSharingSettings".
764
+ sharing_with_google_support_enabled (bool):
765
+ Allows Google support to access the data in
766
+ order to help troubleshoot issues.
767
+ sharing_with_google_assigned_sales_enabled (bool):
768
+ Allows Google sales teams that are assigned
769
+ to the customer to access the data in order to
770
+ suggest configuration changes to improve
771
+ results. Sales team restrictions still apply
772
+ when enabled.
773
+ sharing_with_google_any_sales_enabled (bool):
774
+ Allows any of Google sales to access the data
775
+ in order to suggest configuration changes to
776
+ improve results.
777
+ sharing_with_google_products_enabled (bool):
778
+ Allows Google to use the data to improve
779
+ other Google products or services.
780
+ sharing_with_others_enabled (bool):
781
+ Allows Google to share the data anonymously
782
+ in aggregate form with others.
783
+ """
784
+
785
+ name: str = proto.Field(
786
+ proto.STRING,
787
+ number=1,
788
+ )
789
+ sharing_with_google_support_enabled: bool = proto.Field(
790
+ proto.BOOL,
791
+ number=2,
792
+ )
793
+ sharing_with_google_assigned_sales_enabled: bool = proto.Field(
794
+ proto.BOOL,
795
+ number=3,
796
+ )
797
+ sharing_with_google_any_sales_enabled: bool = proto.Field(
798
+ proto.BOOL,
799
+ number=4,
800
+ )
801
+ sharing_with_google_products_enabled: bool = proto.Field(
802
+ proto.BOOL,
803
+ number=5,
804
+ )
805
+ sharing_with_others_enabled: bool = proto.Field(
806
+ proto.BOOL,
807
+ number=6,
808
+ )
809
+
810
+
811
+ class AccountSummary(proto.Message):
812
+ r"""A virtual resource representing an overview of an account and
813
+ all its child Google Analytics properties.
814
+
815
+ Attributes:
816
+ name (str):
817
+ Resource name for this account summary. Format:
818
+ accountSummaries/{account_id} Example:
819
+ "accountSummaries/1000".
820
+ account (str):
821
+ Resource name of account referred to by this account summary
822
+ Format: accounts/{account_id} Example: "accounts/1000".
823
+ display_name (str):
824
+ Display name for the account referred to in
825
+ this account summary.
826
+ property_summaries (MutableSequence[google.analytics.admin_v1beta.types.PropertySummary]):
827
+ List of summaries for child accounts of this
828
+ account.
829
+ """
830
+
831
+ name: str = proto.Field(
832
+ proto.STRING,
833
+ number=1,
834
+ )
835
+ account: str = proto.Field(
836
+ proto.STRING,
837
+ number=2,
838
+ )
839
+ display_name: str = proto.Field(
840
+ proto.STRING,
841
+ number=3,
842
+ )
843
+ property_summaries: MutableSequence["PropertySummary"] = proto.RepeatedField(
844
+ proto.MESSAGE,
845
+ number=4,
846
+ message="PropertySummary",
847
+ )
848
+
849
+
850
+ class PropertySummary(proto.Message):
851
+ r"""A virtual resource representing metadata for a Google
852
+ Analytics property.
853
+
854
+ Attributes:
855
+ property (str):
856
+ Resource name of property referred to by this property
857
+ summary Format: properties/{property_id} Example:
858
+ "properties/1000".
859
+ display_name (str):
860
+ Display name for the property referred to in
861
+ this property summary.
862
+ property_type (google.analytics.admin_v1beta.types.PropertyType):
863
+ The property's property type.
864
+ parent (str):
865
+ Resource name of this property's logical
866
+ parent.
867
+ Note: The Property-Moving UI can be used to
868
+ change the parent. Format: accounts/{account},
869
+ properties/{property} Example: "accounts/100",
870
+ "properties/200".
871
+ """
872
+
873
+ property: str = proto.Field(
874
+ proto.STRING,
875
+ number=1,
876
+ )
877
+ display_name: str = proto.Field(
878
+ proto.STRING,
879
+ number=2,
880
+ )
881
+ property_type: "PropertyType" = proto.Field(
882
+ proto.ENUM,
883
+ number=3,
884
+ enum="PropertyType",
885
+ )
886
+ parent: str = proto.Field(
887
+ proto.STRING,
888
+ number=4,
889
+ )
890
+
891
+
892
+ class MeasurementProtocolSecret(proto.Message):
893
+ r"""A secret value used for sending hits to Measurement Protocol.
894
+
895
+ Attributes:
896
+ name (str):
897
+ Output only. Resource name of this secret.
898
+ This secret may be a child of any type of
899
+ stream. Format:
900
+
901
+ properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
902
+ display_name (str):
903
+ Required. Human-readable display name for
904
+ this secret.
905
+ secret_value (str):
906
+ Output only. The measurement protocol secret value. Pass
907
+ this value to the api_secret field of the Measurement
908
+ Protocol API when sending hits to this secret's parent
909
+ property.
910
+ """
911
+
912
+ name: str = proto.Field(
913
+ proto.STRING,
914
+ number=1,
915
+ )
916
+ display_name: str = proto.Field(
917
+ proto.STRING,
918
+ number=2,
919
+ )
920
+ secret_value: str = proto.Field(
921
+ proto.STRING,
922
+ number=3,
923
+ )
924
+
925
+
926
+ class ChangeHistoryEvent(proto.Message):
927
+ r"""A set of changes within a Google Analytics account or its
928
+ child properties that resulted from the same cause. Common
929
+ causes would be updates made in the Google Analytics UI, changes
930
+ from customer support, or automatic Google Analytics system
931
+ changes.
932
+
933
+ Attributes:
934
+ id (str):
935
+ ID of this change history event. This ID is
936
+ unique across Google Analytics.
937
+ change_time (google.protobuf.timestamp_pb2.Timestamp):
938
+ Time when change was made.
939
+ actor_type (google.analytics.admin_v1beta.types.ActorType):
940
+ The type of actor that made this change.
941
+ user_actor_email (str):
942
+ Email address of the Google account that made
943
+ the change. This will be a valid email address
944
+ if the actor field is set to USER, and empty
945
+ otherwise. Google accounts that have been
946
+ deleted will cause an error.
947
+ changes_filtered (bool):
948
+ If true, then the list of changes returned
949
+ was filtered, and does not represent all changes
950
+ that occurred in this event.
951
+ changes (MutableSequence[google.analytics.admin_v1beta.types.ChangeHistoryChange]):
952
+ A list of changes made in this change history
953
+ event that fit the filters specified in
954
+ SearchChangeHistoryEventsRequest.
955
+ """
956
+
957
+ id: str = proto.Field(
958
+ proto.STRING,
959
+ number=1,
960
+ )
961
+ change_time: timestamp_pb2.Timestamp = proto.Field(
962
+ proto.MESSAGE,
963
+ number=2,
964
+ message=timestamp_pb2.Timestamp,
965
+ )
966
+ actor_type: "ActorType" = proto.Field(
967
+ proto.ENUM,
968
+ number=3,
969
+ enum="ActorType",
970
+ )
971
+ user_actor_email: str = proto.Field(
972
+ proto.STRING,
973
+ number=4,
974
+ )
975
+ changes_filtered: bool = proto.Field(
976
+ proto.BOOL,
977
+ number=5,
978
+ )
979
+ changes: MutableSequence["ChangeHistoryChange"] = proto.RepeatedField(
980
+ proto.MESSAGE,
981
+ number=6,
982
+ message="ChangeHistoryChange",
983
+ )
984
+
985
+
986
+ class ChangeHistoryChange(proto.Message):
987
+ r"""A description of a change to a single Google Analytics
988
+ resource.
989
+
990
+ Attributes:
991
+ resource (str):
992
+ Resource name of the resource whose changes
993
+ are described by this entry.
994
+ action (google.analytics.admin_v1beta.types.ActionType):
995
+ The type of action that changed this
996
+ resource.
997
+ resource_before_change (google.analytics.admin_v1beta.types.ChangeHistoryChange.ChangeHistoryResource):
998
+ Resource contents from before the change was
999
+ made. If this resource was created in this
1000
+ change, this field will be missing.
1001
+ resource_after_change (google.analytics.admin_v1beta.types.ChangeHistoryChange.ChangeHistoryResource):
1002
+ Resource contents from after the change was
1003
+ made. If this resource was deleted in this
1004
+ change, this field will be missing.
1005
+ """
1006
+
1007
+ class ChangeHistoryResource(proto.Message):
1008
+ r"""A snapshot of a resource as before or after the result of a
1009
+ change in change history.
1010
+
1011
+ This message has `oneof`_ fields (mutually exclusive fields).
1012
+ For each oneof, at most one member field can be set at the same time.
1013
+ Setting any member of the oneof automatically clears all other
1014
+ members.
1015
+
1016
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1017
+
1018
+ Attributes:
1019
+ account (google.analytics.admin_v1beta.types.Account):
1020
+ A snapshot of an Account resource in change
1021
+ history.
1022
+
1023
+ This field is a member of `oneof`_ ``resource``.
1024
+ property (google.analytics.admin_v1beta.types.Property):
1025
+ A snapshot of a Property resource in change
1026
+ history.
1027
+
1028
+ This field is a member of `oneof`_ ``resource``.
1029
+ firebase_link (google.analytics.admin_v1beta.types.FirebaseLink):
1030
+ A snapshot of a FirebaseLink resource in
1031
+ change history.
1032
+
1033
+ This field is a member of `oneof`_ ``resource``.
1034
+ google_ads_link (google.analytics.admin_v1beta.types.GoogleAdsLink):
1035
+ A snapshot of a GoogleAdsLink resource in
1036
+ change history.
1037
+
1038
+ This field is a member of `oneof`_ ``resource``.
1039
+ conversion_event (google.analytics.admin_v1beta.types.ConversionEvent):
1040
+ A snapshot of a ConversionEvent resource in
1041
+ change history.
1042
+
1043
+ This field is a member of `oneof`_ ``resource``.
1044
+ measurement_protocol_secret (google.analytics.admin_v1beta.types.MeasurementProtocolSecret):
1045
+ A snapshot of a MeasurementProtocolSecret
1046
+ resource in change history.
1047
+
1048
+ This field is a member of `oneof`_ ``resource``.
1049
+ data_retention_settings (google.analytics.admin_v1beta.types.DataRetentionSettings):
1050
+ A snapshot of a data retention settings
1051
+ resource in change history.
1052
+
1053
+ This field is a member of `oneof`_ ``resource``.
1054
+ data_stream (google.analytics.admin_v1beta.types.DataStream):
1055
+ A snapshot of a DataStream resource in change
1056
+ history.
1057
+
1058
+ This field is a member of `oneof`_ ``resource``.
1059
+ """
1060
+
1061
+ account: "Account" = proto.Field(
1062
+ proto.MESSAGE,
1063
+ number=1,
1064
+ oneof="resource",
1065
+ message="Account",
1066
+ )
1067
+ property: "Property" = proto.Field(
1068
+ proto.MESSAGE,
1069
+ number=2,
1070
+ oneof="resource",
1071
+ message="Property",
1072
+ )
1073
+ firebase_link: "FirebaseLink" = proto.Field(
1074
+ proto.MESSAGE,
1075
+ number=6,
1076
+ oneof="resource",
1077
+ message="FirebaseLink",
1078
+ )
1079
+ google_ads_link: "GoogleAdsLink" = proto.Field(
1080
+ proto.MESSAGE,
1081
+ number=7,
1082
+ oneof="resource",
1083
+ message="GoogleAdsLink",
1084
+ )
1085
+ conversion_event: "ConversionEvent" = proto.Field(
1086
+ proto.MESSAGE,
1087
+ number=11,
1088
+ oneof="resource",
1089
+ message="ConversionEvent",
1090
+ )
1091
+ measurement_protocol_secret: "MeasurementProtocolSecret" = proto.Field(
1092
+ proto.MESSAGE,
1093
+ number=12,
1094
+ oneof="resource",
1095
+ message="MeasurementProtocolSecret",
1096
+ )
1097
+ data_retention_settings: "DataRetentionSettings" = proto.Field(
1098
+ proto.MESSAGE,
1099
+ number=15,
1100
+ oneof="resource",
1101
+ message="DataRetentionSettings",
1102
+ )
1103
+ data_stream: "DataStream" = proto.Field(
1104
+ proto.MESSAGE,
1105
+ number=18,
1106
+ oneof="resource",
1107
+ message="DataStream",
1108
+ )
1109
+
1110
+ resource: str = proto.Field(
1111
+ proto.STRING,
1112
+ number=1,
1113
+ )
1114
+ action: "ActionType" = proto.Field(
1115
+ proto.ENUM,
1116
+ number=2,
1117
+ enum="ActionType",
1118
+ )
1119
+ resource_before_change: ChangeHistoryResource = proto.Field(
1120
+ proto.MESSAGE,
1121
+ number=3,
1122
+ message=ChangeHistoryResource,
1123
+ )
1124
+ resource_after_change: ChangeHistoryResource = proto.Field(
1125
+ proto.MESSAGE,
1126
+ number=4,
1127
+ message=ChangeHistoryResource,
1128
+ )
1129
+
1130
+
1131
+ class ConversionEvent(proto.Message):
1132
+ r"""A conversion event in a Google Analytics property.
1133
+
1134
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1135
+
1136
+ Attributes:
1137
+ name (str):
1138
+ Output only. Resource name of this conversion event. Format:
1139
+ properties/{property}/conversionEvents/{conversion_event}
1140
+ event_name (str):
1141
+ Immutable. The event name for this conversion
1142
+ event. Examples: 'click', 'purchase'
1143
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
1144
+ Output only. Time when this conversion event
1145
+ was created in the property.
1146
+ deletable (bool):
1147
+ Output only. If set, this event can currently
1148
+ be deleted with DeleteConversionEvent.
1149
+ custom (bool):
1150
+ Output only. If set to true, this conversion
1151
+ event refers to a custom event. If set to
1152
+ false, this conversion event refers to a default
1153
+ event in GA. Default events typically have
1154
+ special meaning in GA. Default events are
1155
+ usually created for you by the GA system, but in
1156
+ some cases can be created by property admins.
1157
+ Custom events count towards the maximum number
1158
+ of custom conversion events that may be created
1159
+ per property.
1160
+ counting_method (google.analytics.admin_v1beta.types.ConversionEvent.ConversionCountingMethod):
1161
+ Optional. The method by which conversions will be counted
1162
+ across multiple events within a session. If this value is
1163
+ not provided, it will be set to ``ONCE_PER_EVENT``.
1164
+ default_conversion_value (google.analytics.admin_v1beta.types.ConversionEvent.DefaultConversionValue):
1165
+ Optional. Defines a default value/currency
1166
+ for a conversion event.
1167
+
1168
+ This field is a member of `oneof`_ ``_default_conversion_value``.
1169
+ """
1170
+
1171
+ class ConversionCountingMethod(proto.Enum):
1172
+ r"""The method by which conversions will be counted across
1173
+ multiple events within a session.
1174
+
1175
+ Values:
1176
+ CONVERSION_COUNTING_METHOD_UNSPECIFIED (0):
1177
+ Counting method not specified.
1178
+ ONCE_PER_EVENT (1):
1179
+ Each Event instance is considered a
1180
+ Conversion.
1181
+ ONCE_PER_SESSION (2):
1182
+ An Event instance is considered a Conversion
1183
+ at most once per session per user.
1184
+ """
1185
+ CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0
1186
+ ONCE_PER_EVENT = 1
1187
+ ONCE_PER_SESSION = 2
1188
+
1189
+ class DefaultConversionValue(proto.Message):
1190
+ r"""Defines a default value/currency for a conversion event. Both
1191
+ value and currency must be provided.
1192
+
1193
+
1194
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1195
+
1196
+ Attributes:
1197
+ value (float):
1198
+ This value will be used to populate the value for all
1199
+ conversions of the specified event_name where the event
1200
+ "value" parameter is unset.
1201
+
1202
+ This field is a member of `oneof`_ ``_value``.
1203
+ currency_code (str):
1204
+ When a conversion event for this event_name has no set
1205
+ currency, this currency will be applied as the default. Must
1206
+ be in ISO 4217 currency code format. See
1207
+ https://en.wikipedia.org/wiki/ISO_4217 for more information.
1208
+
1209
+ This field is a member of `oneof`_ ``_currency_code``.
1210
+ """
1211
+
1212
+ value: float = proto.Field(
1213
+ proto.DOUBLE,
1214
+ number=1,
1215
+ optional=True,
1216
+ )
1217
+ currency_code: str = proto.Field(
1218
+ proto.STRING,
1219
+ number=2,
1220
+ optional=True,
1221
+ )
1222
+
1223
+ name: str = proto.Field(
1224
+ proto.STRING,
1225
+ number=1,
1226
+ )
1227
+ event_name: str = proto.Field(
1228
+ proto.STRING,
1229
+ number=2,
1230
+ )
1231
+ create_time: timestamp_pb2.Timestamp = proto.Field(
1232
+ proto.MESSAGE,
1233
+ number=3,
1234
+ message=timestamp_pb2.Timestamp,
1235
+ )
1236
+ deletable: bool = proto.Field(
1237
+ proto.BOOL,
1238
+ number=4,
1239
+ )
1240
+ custom: bool = proto.Field(
1241
+ proto.BOOL,
1242
+ number=5,
1243
+ )
1244
+ counting_method: ConversionCountingMethod = proto.Field(
1245
+ proto.ENUM,
1246
+ number=6,
1247
+ enum=ConversionCountingMethod,
1248
+ )
1249
+ default_conversion_value: DefaultConversionValue = proto.Field(
1250
+ proto.MESSAGE,
1251
+ number=7,
1252
+ optional=True,
1253
+ message=DefaultConversionValue,
1254
+ )
1255
+
1256
+
1257
+ class KeyEvent(proto.Message):
1258
+ r"""A key event in a Google Analytics property.
1259
+
1260
+ Attributes:
1261
+ name (str):
1262
+ Output only. Resource name of this key event. Format:
1263
+ properties/{property}/keyEvents/{key_event}
1264
+ event_name (str):
1265
+ Immutable. The event name for this key event.
1266
+ Examples: 'click', 'purchase'
1267
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
1268
+ Output only. Time when this key event was
1269
+ created in the property.
1270
+ deletable (bool):
1271
+ Output only. If set to true, this event can
1272
+ be deleted.
1273
+ custom (bool):
1274
+ Output only. If set to true, this key event
1275
+ refers to a custom event. If set to false, this
1276
+ key event refers to a default event in GA.
1277
+ Default events typically have special meaning in
1278
+ GA. Default events are usually created for you
1279
+ by the GA system, but in some cases can be
1280
+ created by property admins. Custom events count
1281
+ towards the maximum number of custom key events
1282
+ that may be created per property.
1283
+ counting_method (google.analytics.admin_v1beta.types.KeyEvent.CountingMethod):
1284
+ Required. The method by which Key Events will
1285
+ be counted across multiple events within a
1286
+ session.
1287
+ default_value (google.analytics.admin_v1beta.types.KeyEvent.DefaultValue):
1288
+ Optional. Defines a default value/currency
1289
+ for a key event.
1290
+ """
1291
+
1292
+ class CountingMethod(proto.Enum):
1293
+ r"""The method by which Key Events will be counted across
1294
+ multiple events within a session.
1295
+
1296
+ Values:
1297
+ COUNTING_METHOD_UNSPECIFIED (0):
1298
+ Counting method not specified.
1299
+ ONCE_PER_EVENT (1):
1300
+ Each Event instance is considered a Key
1301
+ Event.
1302
+ ONCE_PER_SESSION (2):
1303
+ An Event instance is considered a Key Event
1304
+ at most once per session per user.
1305
+ """
1306
+ COUNTING_METHOD_UNSPECIFIED = 0
1307
+ ONCE_PER_EVENT = 1
1308
+ ONCE_PER_SESSION = 2
1309
+
1310
+ class DefaultValue(proto.Message):
1311
+ r"""Defines a default value/currency for a key event.
1312
+
1313
+ Attributes:
1314
+ numeric_value (float):
1315
+ Required. This will be used to populate the "value"
1316
+ parameter for all occurrences of this Key Event (specified
1317
+ by event_name) where that parameter is unset.
1318
+ currency_code (str):
1319
+ Required. When an occurrence of this Key Event (specified by
1320
+ event_name) has no set currency this currency will be
1321
+ applied as the default. Must be in ISO 4217 currency code
1322
+ format.
1323
+
1324
+ See https://en.wikipedia.org/wiki/ISO_4217 for more
1325
+ information.
1326
+ """
1327
+
1328
+ numeric_value: float = proto.Field(
1329
+ proto.DOUBLE,
1330
+ number=1,
1331
+ )
1332
+ currency_code: str = proto.Field(
1333
+ proto.STRING,
1334
+ number=2,
1335
+ )
1336
+
1337
+ name: str = proto.Field(
1338
+ proto.STRING,
1339
+ number=1,
1340
+ )
1341
+ event_name: str = proto.Field(
1342
+ proto.STRING,
1343
+ number=2,
1344
+ )
1345
+ create_time: timestamp_pb2.Timestamp = proto.Field(
1346
+ proto.MESSAGE,
1347
+ number=3,
1348
+ message=timestamp_pb2.Timestamp,
1349
+ )
1350
+ deletable: bool = proto.Field(
1351
+ proto.BOOL,
1352
+ number=4,
1353
+ )
1354
+ custom: bool = proto.Field(
1355
+ proto.BOOL,
1356
+ number=5,
1357
+ )
1358
+ counting_method: CountingMethod = proto.Field(
1359
+ proto.ENUM,
1360
+ number=6,
1361
+ enum=CountingMethod,
1362
+ )
1363
+ default_value: DefaultValue = proto.Field(
1364
+ proto.MESSAGE,
1365
+ number=7,
1366
+ message=DefaultValue,
1367
+ )
1368
+
1369
+
1370
+ class CustomDimension(proto.Message):
1371
+ r"""A definition for a CustomDimension.
1372
+
1373
+ Attributes:
1374
+ name (str):
1375
+ Output only. Resource name for this
1376
+ CustomDimension resource. Format:
1377
+ properties/{property}/customDimensions/{customDimension}
1378
+ parameter_name (str):
1379
+ Required. Immutable. Tagging parameter name
1380
+ for this custom dimension.
1381
+ If this is a user-scoped dimension, then this is
1382
+ the user property name. If this is an
1383
+ event-scoped dimension, then this is the event
1384
+ parameter name.
1385
+
1386
+ If this is an item-scoped dimension, then this
1387
+ is the parameter name found in the eCommerce
1388
+ items array.
1389
+
1390
+ May only contain alphanumeric and underscore
1391
+ characters, starting with a letter. Max length
1392
+ of 24 characters for user-scoped dimensions, 40
1393
+ characters for event-scoped dimensions.
1394
+ display_name (str):
1395
+ Required. Display name for this custom
1396
+ dimension as shown in the Analytics UI. Max
1397
+ length of 82 characters, alphanumeric plus space
1398
+ and underscore starting with a letter. Legacy
1399
+ system-generated display names may contain
1400
+ square brackets, but updates to this field will
1401
+ never permit square brackets.
1402
+ description (str):
1403
+ Optional. Description for this custom
1404
+ dimension. Max length of 150 characters.
1405
+ scope (google.analytics.admin_v1beta.types.CustomDimension.DimensionScope):
1406
+ Required. Immutable. The scope of this
1407
+ dimension.
1408
+ disallow_ads_personalization (bool):
1409
+ Optional. If set to true, sets this dimension
1410
+ as NPA and excludes it from ads personalization.
1411
+
1412
+ This is currently only supported by user-scoped
1413
+ custom dimensions.
1414
+ """
1415
+
1416
+ class DimensionScope(proto.Enum):
1417
+ r"""Valid values for the scope of this dimension.
1418
+
1419
+ Values:
1420
+ DIMENSION_SCOPE_UNSPECIFIED (0):
1421
+ Scope unknown or not specified.
1422
+ EVENT (1):
1423
+ Dimension scoped to an event.
1424
+ USER (2):
1425
+ Dimension scoped to a user.
1426
+ ITEM (3):
1427
+ Dimension scoped to eCommerce items
1428
+ """
1429
+ DIMENSION_SCOPE_UNSPECIFIED = 0
1430
+ EVENT = 1
1431
+ USER = 2
1432
+ ITEM = 3
1433
+
1434
+ name: str = proto.Field(
1435
+ proto.STRING,
1436
+ number=1,
1437
+ )
1438
+ parameter_name: str = proto.Field(
1439
+ proto.STRING,
1440
+ number=2,
1441
+ )
1442
+ display_name: str = proto.Field(
1443
+ proto.STRING,
1444
+ number=3,
1445
+ )
1446
+ description: str = proto.Field(
1447
+ proto.STRING,
1448
+ number=4,
1449
+ )
1450
+ scope: DimensionScope = proto.Field(
1451
+ proto.ENUM,
1452
+ number=5,
1453
+ enum=DimensionScope,
1454
+ )
1455
+ disallow_ads_personalization: bool = proto.Field(
1456
+ proto.BOOL,
1457
+ number=6,
1458
+ )
1459
+
1460
+
1461
+ class CustomMetric(proto.Message):
1462
+ r"""A definition for a custom metric.
1463
+
1464
+ Attributes:
1465
+ name (str):
1466
+ Output only. Resource name for this
1467
+ CustomMetric resource. Format:
1468
+ properties/{property}/customMetrics/{customMetric}
1469
+ parameter_name (str):
1470
+ Required. Immutable. Tagging name for this
1471
+ custom metric.
1472
+ If this is an event-scoped metric, then this is
1473
+ the event parameter name.
1474
+
1475
+ May only contain alphanumeric and underscore
1476
+ charactes, starting with a letter. Max length of
1477
+ 40 characters for event-scoped metrics.
1478
+ display_name (str):
1479
+ Required. Display name for this custom metric
1480
+ as shown in the Analytics UI. Max length of 82
1481
+ characters, alphanumeric plus space and
1482
+ underscore starting with a letter. Legacy
1483
+ system-generated display names may contain
1484
+ square brackets, but updates to this field will
1485
+ never permit square brackets.
1486
+ description (str):
1487
+ Optional. Description for this custom
1488
+ dimension. Max length of 150 characters.
1489
+ measurement_unit (google.analytics.admin_v1beta.types.CustomMetric.MeasurementUnit):
1490
+ Required. The type for the custom metric's
1491
+ value.
1492
+ scope (google.analytics.admin_v1beta.types.CustomMetric.MetricScope):
1493
+ Required. Immutable. The scope of this custom
1494
+ metric.
1495
+ restricted_metric_type (MutableSequence[google.analytics.admin_v1beta.types.CustomMetric.RestrictedMetricType]):
1496
+ Optional. Types of restricted data that this
1497
+ metric may contain. Required for metrics with
1498
+ CURRENCY measurement unit. Must be empty for
1499
+ metrics with a non-CURRENCY measurement unit.
1500
+ """
1501
+
1502
+ class MeasurementUnit(proto.Enum):
1503
+ r"""Possible types of representing the custom metric's value.
1504
+
1505
+ Currency representation may change in the future, requiring a
1506
+ breaking API change.
1507
+
1508
+ Values:
1509
+ MEASUREMENT_UNIT_UNSPECIFIED (0):
1510
+ MeasurementUnit unspecified or missing.
1511
+ STANDARD (1):
1512
+ This metric uses default units.
1513
+ CURRENCY (2):
1514
+ This metric measures a currency.
1515
+ FEET (3):
1516
+ This metric measures feet.
1517
+ METERS (4):
1518
+ This metric measures meters.
1519
+ KILOMETERS (5):
1520
+ This metric measures kilometers.
1521
+ MILES (6):
1522
+ This metric measures miles.
1523
+ MILLISECONDS (7):
1524
+ This metric measures milliseconds.
1525
+ SECONDS (8):
1526
+ This metric measures seconds.
1527
+ MINUTES (9):
1528
+ This metric measures minutes.
1529
+ HOURS (10):
1530
+ This metric measures hours.
1531
+ """
1532
+ MEASUREMENT_UNIT_UNSPECIFIED = 0
1533
+ STANDARD = 1
1534
+ CURRENCY = 2
1535
+ FEET = 3
1536
+ METERS = 4
1537
+ KILOMETERS = 5
1538
+ MILES = 6
1539
+ MILLISECONDS = 7
1540
+ SECONDS = 8
1541
+ MINUTES = 9
1542
+ HOURS = 10
1543
+
1544
+ class MetricScope(proto.Enum):
1545
+ r"""The scope of this metric.
1546
+
1547
+ Values:
1548
+ METRIC_SCOPE_UNSPECIFIED (0):
1549
+ Scope unknown or not specified.
1550
+ EVENT (1):
1551
+ Metric scoped to an event.
1552
+ """
1553
+ METRIC_SCOPE_UNSPECIFIED = 0
1554
+ EVENT = 1
1555
+
1556
+ class RestrictedMetricType(proto.Enum):
1557
+ r"""Labels that mark the data in this custom metric as data that
1558
+ should be restricted to specific users.
1559
+
1560
+ Values:
1561
+ RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):
1562
+ Type unknown or unspecified.
1563
+ COST_DATA (1):
1564
+ Metric reports cost data.
1565
+ REVENUE_DATA (2):
1566
+ Metric reports revenue data.
1567
+ """
1568
+ RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0
1569
+ COST_DATA = 1
1570
+ REVENUE_DATA = 2
1571
+
1572
+ name: str = proto.Field(
1573
+ proto.STRING,
1574
+ number=1,
1575
+ )
1576
+ parameter_name: str = proto.Field(
1577
+ proto.STRING,
1578
+ number=2,
1579
+ )
1580
+ display_name: str = proto.Field(
1581
+ proto.STRING,
1582
+ number=3,
1583
+ )
1584
+ description: str = proto.Field(
1585
+ proto.STRING,
1586
+ number=4,
1587
+ )
1588
+ measurement_unit: MeasurementUnit = proto.Field(
1589
+ proto.ENUM,
1590
+ number=5,
1591
+ enum=MeasurementUnit,
1592
+ )
1593
+ scope: MetricScope = proto.Field(
1594
+ proto.ENUM,
1595
+ number=6,
1596
+ enum=MetricScope,
1597
+ )
1598
+ restricted_metric_type: MutableSequence[RestrictedMetricType] = proto.RepeatedField(
1599
+ proto.ENUM,
1600
+ number=8,
1601
+ enum=RestrictedMetricType,
1602
+ )
1603
+
1604
+
1605
+ class DataRetentionSettings(proto.Message):
1606
+ r"""Settings values for data retention. This is a singleton
1607
+ resource.
1608
+
1609
+ Attributes:
1610
+ name (str):
1611
+ Output only. Resource name for this
1612
+ DataRetentionSetting resource. Format:
1613
+ properties/{property}/dataRetentionSettings
1614
+ event_data_retention (google.analytics.admin_v1beta.types.DataRetentionSettings.RetentionDuration):
1615
+ Required. The length of time that event-level
1616
+ data is retained.
1617
+ user_data_retention (google.analytics.admin_v1beta.types.DataRetentionSettings.RetentionDuration):
1618
+ Required. The length of time that user-level
1619
+ data is retained.
1620
+ reset_user_data_on_new_activity (bool):
1621
+ If true, reset the retention period for the
1622
+ user identifier with every event from that user.
1623
+ """
1624
+
1625
+ class RetentionDuration(proto.Enum):
1626
+ r"""Valid values for the data retention duration.
1627
+
1628
+ Values:
1629
+ RETENTION_DURATION_UNSPECIFIED (0):
1630
+ Data retention time duration is not
1631
+ specified.
1632
+ TWO_MONTHS (1):
1633
+ The data retention time duration is 2 months.
1634
+ FOURTEEN_MONTHS (3):
1635
+ The data retention time duration is 14
1636
+ months.
1637
+ TWENTY_SIX_MONTHS (4):
1638
+ The data retention time duration is 26
1639
+ months. Available to 360 properties only.
1640
+ Available for event data only.
1641
+ THIRTY_EIGHT_MONTHS (5):
1642
+ The data retention time duration is 38
1643
+ months. Available to 360 properties only.
1644
+ Available for event data only.
1645
+ FIFTY_MONTHS (6):
1646
+ The data retention time duration is 50
1647
+ months. Available to 360 properties only.
1648
+ Available for event data only.
1649
+ """
1650
+ RETENTION_DURATION_UNSPECIFIED = 0
1651
+ TWO_MONTHS = 1
1652
+ FOURTEEN_MONTHS = 3
1653
+ TWENTY_SIX_MONTHS = 4
1654
+ THIRTY_EIGHT_MONTHS = 5
1655
+ FIFTY_MONTHS = 6
1656
+
1657
+ name: str = proto.Field(
1658
+ proto.STRING,
1659
+ number=1,
1660
+ )
1661
+ event_data_retention: RetentionDuration = proto.Field(
1662
+ proto.ENUM,
1663
+ number=2,
1664
+ enum=RetentionDuration,
1665
+ )
1666
+ user_data_retention: RetentionDuration = proto.Field(
1667
+ proto.ENUM,
1668
+ number=4,
1669
+ enum=RetentionDuration,
1670
+ )
1671
+ reset_user_data_on_new_activity: bool = proto.Field(
1672
+ proto.BOOL,
1673
+ number=3,
1674
+ )
1675
+
1676
+
1677
+ __all__ = tuple(sorted(__protobuf__.manifest))