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,3289 @@
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
+ from google.analytics.admin_v1alpha.types import channel_group as gaa_channel_group
25
+ from google.analytics.admin_v1alpha.types import (
26
+ expanded_data_set as gaa_expanded_data_set,
27
+ )
28
+ from google.analytics.admin_v1alpha.types import audience as gaa_audience
29
+ from google.analytics.admin_v1alpha.types import event_create_and_edit
30
+
31
+ __protobuf__ = proto.module(
32
+ package="google.analytics.admin.v1alpha",
33
+ manifest={
34
+ "IndustryCategory",
35
+ "ServiceLevel",
36
+ "ActorType",
37
+ "ActionType",
38
+ "ChangeHistoryResourceType",
39
+ "GoogleSignalsState",
40
+ "GoogleSignalsConsent",
41
+ "LinkProposalInitiatingProduct",
42
+ "LinkProposalState",
43
+ "PropertyType",
44
+ "CoarseValue",
45
+ "Account",
46
+ "Property",
47
+ "DataStream",
48
+ "FirebaseLink",
49
+ "GlobalSiteTag",
50
+ "GoogleAdsLink",
51
+ "DataSharingSettings",
52
+ "AccountSummary",
53
+ "PropertySummary",
54
+ "MeasurementProtocolSecret",
55
+ "SKAdNetworkConversionValueSchema",
56
+ "PostbackWindow",
57
+ "ConversionValues",
58
+ "EventMapping",
59
+ "ChangeHistoryEvent",
60
+ "ChangeHistoryChange",
61
+ "DisplayVideo360AdvertiserLink",
62
+ "DisplayVideo360AdvertiserLinkProposal",
63
+ "SearchAds360Link",
64
+ "LinkProposalStatusDetails",
65
+ "ConversionEvent",
66
+ "KeyEvent",
67
+ "GoogleSignalsSettings",
68
+ "CustomDimension",
69
+ "CustomMetric",
70
+ "CalculatedMetric",
71
+ "DataRetentionSettings",
72
+ "AttributionSettings",
73
+ "AccessBinding",
74
+ "BigQueryLink",
75
+ "EnhancedMeasurementSettings",
76
+ "ConnectedSiteTag",
77
+ "DataRedactionSettings",
78
+ "AdSenseLink",
79
+ "RollupPropertySourceLink",
80
+ },
81
+ )
82
+
83
+
84
+ class IndustryCategory(proto.Enum):
85
+ r"""The category selected for this property, used for industry
86
+ benchmarking.
87
+
88
+ Values:
89
+ INDUSTRY_CATEGORY_UNSPECIFIED (0):
90
+ Industry category unspecified
91
+ AUTOMOTIVE (1):
92
+ Automotive
93
+ BUSINESS_AND_INDUSTRIAL_MARKETS (2):
94
+ Business and industrial markets
95
+ FINANCE (3):
96
+ Finance
97
+ HEALTHCARE (4):
98
+ Healthcare
99
+ TECHNOLOGY (5):
100
+ Technology
101
+ TRAVEL (6):
102
+ Travel
103
+ OTHER (7):
104
+ Other
105
+ ARTS_AND_ENTERTAINMENT (8):
106
+ Arts and entertainment
107
+ BEAUTY_AND_FITNESS (9):
108
+ Beauty and fitness
109
+ BOOKS_AND_LITERATURE (10):
110
+ Books and literature
111
+ FOOD_AND_DRINK (11):
112
+ Food and drink
113
+ GAMES (12):
114
+ Games
115
+ HOBBIES_AND_LEISURE (13):
116
+ Hobbies and leisure
117
+ HOME_AND_GARDEN (14):
118
+ Home and garden
119
+ INTERNET_AND_TELECOM (15):
120
+ Internet and telecom
121
+ LAW_AND_GOVERNMENT (16):
122
+ Law and government
123
+ NEWS (17):
124
+ News
125
+ ONLINE_COMMUNITIES (18):
126
+ Online communities
127
+ PEOPLE_AND_SOCIETY (19):
128
+ People and society
129
+ PETS_AND_ANIMALS (20):
130
+ Pets and animals
131
+ REAL_ESTATE (21):
132
+ Real estate
133
+ REFERENCE (22):
134
+ Reference
135
+ SCIENCE (23):
136
+ Science
137
+ SPORTS (24):
138
+ Sports
139
+ JOBS_AND_EDUCATION (25):
140
+ Jobs and education
141
+ SHOPPING (26):
142
+ Shopping
143
+ """
144
+ INDUSTRY_CATEGORY_UNSPECIFIED = 0
145
+ AUTOMOTIVE = 1
146
+ BUSINESS_AND_INDUSTRIAL_MARKETS = 2
147
+ FINANCE = 3
148
+ HEALTHCARE = 4
149
+ TECHNOLOGY = 5
150
+ TRAVEL = 6
151
+ OTHER = 7
152
+ ARTS_AND_ENTERTAINMENT = 8
153
+ BEAUTY_AND_FITNESS = 9
154
+ BOOKS_AND_LITERATURE = 10
155
+ FOOD_AND_DRINK = 11
156
+ GAMES = 12
157
+ HOBBIES_AND_LEISURE = 13
158
+ HOME_AND_GARDEN = 14
159
+ INTERNET_AND_TELECOM = 15
160
+ LAW_AND_GOVERNMENT = 16
161
+ NEWS = 17
162
+ ONLINE_COMMUNITIES = 18
163
+ PEOPLE_AND_SOCIETY = 19
164
+ PETS_AND_ANIMALS = 20
165
+ REAL_ESTATE = 21
166
+ REFERENCE = 22
167
+ SCIENCE = 23
168
+ SPORTS = 24
169
+ JOBS_AND_EDUCATION = 25
170
+ SHOPPING = 26
171
+
172
+
173
+ class ServiceLevel(proto.Enum):
174
+ r"""Various levels of service for Google Analytics.
175
+
176
+ Values:
177
+ SERVICE_LEVEL_UNSPECIFIED (0):
178
+ Service level not specified or invalid.
179
+ GOOGLE_ANALYTICS_STANDARD (1):
180
+ The standard version of Google Analytics.
181
+ GOOGLE_ANALYTICS_360 (2):
182
+ The paid, premium version of Google
183
+ Analytics.
184
+ """
185
+ SERVICE_LEVEL_UNSPECIFIED = 0
186
+ GOOGLE_ANALYTICS_STANDARD = 1
187
+ GOOGLE_ANALYTICS_360 = 2
188
+
189
+
190
+ class ActorType(proto.Enum):
191
+ r"""Different kinds of actors that can make changes to Google
192
+ Analytics resources.
193
+
194
+ Values:
195
+ ACTOR_TYPE_UNSPECIFIED (0):
196
+ Unknown or unspecified actor type.
197
+ USER (1):
198
+ Changes made by the user specified in actor_email.
199
+ SYSTEM (2):
200
+ Changes made by the Google Analytics system.
201
+ SUPPORT (3):
202
+ Changes made by Google Analytics support team
203
+ staff.
204
+ """
205
+ ACTOR_TYPE_UNSPECIFIED = 0
206
+ USER = 1
207
+ SYSTEM = 2
208
+ SUPPORT = 3
209
+
210
+
211
+ class ActionType(proto.Enum):
212
+ r"""Types of actions that may change a resource.
213
+
214
+ Values:
215
+ ACTION_TYPE_UNSPECIFIED (0):
216
+ Action type unknown or not specified.
217
+ CREATED (1):
218
+ Resource was created in this change.
219
+ UPDATED (2):
220
+ Resource was updated in this change.
221
+ DELETED (3):
222
+ Resource was deleted in this change.
223
+ """
224
+ ACTION_TYPE_UNSPECIFIED = 0
225
+ CREATED = 1
226
+ UPDATED = 2
227
+ DELETED = 3
228
+
229
+
230
+ class ChangeHistoryResourceType(proto.Enum):
231
+ r"""Types of resources whose changes may be returned from change
232
+ history.
233
+
234
+ Values:
235
+ CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED (0):
236
+ Resource type unknown or not specified.
237
+ ACCOUNT (1):
238
+ Account resource
239
+ PROPERTY (2):
240
+ Property resource
241
+ FIREBASE_LINK (6):
242
+ FirebaseLink resource
243
+ GOOGLE_ADS_LINK (7):
244
+ GoogleAdsLink resource
245
+ GOOGLE_SIGNALS_SETTINGS (8):
246
+ GoogleSignalsSettings resource
247
+ CONVERSION_EVENT (9):
248
+ ConversionEvent resource
249
+ MEASUREMENT_PROTOCOL_SECRET (10):
250
+ MeasurementProtocolSecret resource
251
+ CUSTOM_DIMENSION (11):
252
+ CustomDimension resource
253
+ CUSTOM_METRIC (12):
254
+ CustomMetric resource
255
+ DATA_RETENTION_SETTINGS (13):
256
+ DataRetentionSettings resource
257
+ DISPLAY_VIDEO_360_ADVERTISER_LINK (14):
258
+ DisplayVideo360AdvertiserLink resource
259
+ DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL (15):
260
+ DisplayVideo360AdvertiserLinkProposal
261
+ resource
262
+ SEARCH_ADS_360_LINK (16):
263
+ SearchAds360Link resource
264
+ DATA_STREAM (18):
265
+ DataStream resource
266
+ ATTRIBUTION_SETTINGS (20):
267
+ AttributionSettings resource
268
+ EXPANDED_DATA_SET (21):
269
+ ExpandedDataSet resource
270
+ CHANNEL_GROUP (22):
271
+ ChannelGroup resource
272
+ BIGQUERY_LINK (23):
273
+ BigQuery link resource
274
+ ENHANCED_MEASUREMENT_SETTINGS (24):
275
+ EnhancedMeasurementSettings resource
276
+ DATA_REDACTION_SETTINGS (25):
277
+ DataRedactionSettings resource
278
+ SKADNETWORK_CONVERSION_VALUE_SCHEMA (26):
279
+ SKAdNetworkConversionValueSchema resource
280
+ ADSENSE_LINK (27):
281
+ AdSenseLink resource
282
+ AUDIENCE (28):
283
+ Audience resource
284
+ EVENT_CREATE_RULE (29):
285
+ EventCreateRule resource
286
+ CALCULATED_METRIC (31):
287
+ CalculatedMetric resource
288
+ KEY_EVENT (32):
289
+ KeyEvent resource
290
+ """
291
+ CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0
292
+ ACCOUNT = 1
293
+ PROPERTY = 2
294
+ FIREBASE_LINK = 6
295
+ GOOGLE_ADS_LINK = 7
296
+ GOOGLE_SIGNALS_SETTINGS = 8
297
+ CONVERSION_EVENT = 9
298
+ MEASUREMENT_PROTOCOL_SECRET = 10
299
+ CUSTOM_DIMENSION = 11
300
+ CUSTOM_METRIC = 12
301
+ DATA_RETENTION_SETTINGS = 13
302
+ DISPLAY_VIDEO_360_ADVERTISER_LINK = 14
303
+ DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15
304
+ SEARCH_ADS_360_LINK = 16
305
+ DATA_STREAM = 18
306
+ ATTRIBUTION_SETTINGS = 20
307
+ EXPANDED_DATA_SET = 21
308
+ CHANNEL_GROUP = 22
309
+ BIGQUERY_LINK = 23
310
+ ENHANCED_MEASUREMENT_SETTINGS = 24
311
+ DATA_REDACTION_SETTINGS = 25
312
+ SKADNETWORK_CONVERSION_VALUE_SCHEMA = 26
313
+ ADSENSE_LINK = 27
314
+ AUDIENCE = 28
315
+ EVENT_CREATE_RULE = 29
316
+ CALCULATED_METRIC = 31
317
+ KEY_EVENT = 32
318
+
319
+
320
+ class GoogleSignalsState(proto.Enum):
321
+ r"""Status of the Google Signals settings.
322
+
323
+ Values:
324
+ GOOGLE_SIGNALS_STATE_UNSPECIFIED (0):
325
+ Google Signals status defaults to
326
+ GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user
327
+ has not made an explicit choice.
328
+ GOOGLE_SIGNALS_ENABLED (1):
329
+ Google Signals is enabled.
330
+ GOOGLE_SIGNALS_DISABLED (2):
331
+ Google Signals is disabled.
332
+ """
333
+ GOOGLE_SIGNALS_STATE_UNSPECIFIED = 0
334
+ GOOGLE_SIGNALS_ENABLED = 1
335
+ GOOGLE_SIGNALS_DISABLED = 2
336
+
337
+
338
+ class GoogleSignalsConsent(proto.Enum):
339
+ r"""Consent field of the Google Signals settings.
340
+
341
+ Values:
342
+ GOOGLE_SIGNALS_CONSENT_UNSPECIFIED (0):
343
+ Google Signals consent value defaults to
344
+ GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as
345
+ GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.
346
+ GOOGLE_SIGNALS_CONSENT_CONSENTED (2):
347
+ Terms of service have been accepted
348
+ GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED (1):
349
+ Terms of service have not been accepted
350
+ """
351
+ GOOGLE_SIGNALS_CONSENT_UNSPECIFIED = 0
352
+ GOOGLE_SIGNALS_CONSENT_CONSENTED = 2
353
+ GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1
354
+
355
+
356
+ class LinkProposalInitiatingProduct(proto.Enum):
357
+ r"""An indication of which product the user initiated a link
358
+ proposal from.
359
+
360
+ Values:
361
+ LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED (0):
362
+ Unspecified product.
363
+ GOOGLE_ANALYTICS (1):
364
+ This proposal was created by a user from
365
+ Google Analytics.
366
+ LINKED_PRODUCT (2):
367
+ This proposal was created by a user from a
368
+ linked product (not Google Analytics).
369
+ """
370
+ LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED = 0
371
+ GOOGLE_ANALYTICS = 1
372
+ LINKED_PRODUCT = 2
373
+
374
+
375
+ class LinkProposalState(proto.Enum):
376
+ r"""The state of a link proposal resource.
377
+
378
+ Values:
379
+ LINK_PROPOSAL_STATE_UNSPECIFIED (0):
380
+ Unspecified state
381
+ AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS (1):
382
+ This proposal is awaiting review from a
383
+ Google Analytics user. This proposal will
384
+ automatically expire after some time.
385
+ AWAITING_REVIEW_FROM_LINKED_PRODUCT (2):
386
+ This proposal is awaiting review from a user
387
+ of a linked product. This proposal will
388
+ automatically expire after some time.
389
+ WITHDRAWN (3):
390
+ This proposal has been withdrawn by an admin
391
+ on the initiating product. This proposal will be
392
+ automatically deleted after some time.
393
+ DECLINED (4):
394
+ This proposal has been declined by an admin
395
+ on the receiving product. This proposal will be
396
+ automatically deleted after some time.
397
+ EXPIRED (5):
398
+ This proposal expired due to lack of response
399
+ from an admin on the receiving product. This
400
+ proposal will be automatically deleted after
401
+ some time.
402
+ OBSOLETE (6):
403
+ This proposal has become obsolete because a
404
+ link was directly created to the same external
405
+ product resource that this proposal specifies.
406
+ This proposal will be automatically deleted
407
+ after some time.
408
+ """
409
+ LINK_PROPOSAL_STATE_UNSPECIFIED = 0
410
+ AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS = 1
411
+ AWAITING_REVIEW_FROM_LINKED_PRODUCT = 2
412
+ WITHDRAWN = 3
413
+ DECLINED = 4
414
+ EXPIRED = 5
415
+ OBSOLETE = 6
416
+
417
+
418
+ class PropertyType(proto.Enum):
419
+ r"""Types of ``Property`` resources.
420
+
421
+ Values:
422
+ PROPERTY_TYPE_UNSPECIFIED (0):
423
+ Unknown or unspecified property type
424
+ PROPERTY_TYPE_ORDINARY (1):
425
+ Ordinary Google Analytics property
426
+ PROPERTY_TYPE_SUBPROPERTY (2):
427
+ Google Analytics subproperty
428
+ PROPERTY_TYPE_ROLLUP (3):
429
+ Google Analytics rollup property
430
+ """
431
+ PROPERTY_TYPE_UNSPECIFIED = 0
432
+ PROPERTY_TYPE_ORDINARY = 1
433
+ PROPERTY_TYPE_SUBPROPERTY = 2
434
+ PROPERTY_TYPE_ROLLUP = 3
435
+
436
+
437
+ class CoarseValue(proto.Enum):
438
+ r"""The coarse conversion value set on the updatePostbackConversionValue
439
+ SDK call when a ConversionValues.event_mappings conditions are
440
+ satisfied. For more information, see
441
+ `SKAdNetwork.CoarseConversionValue <https://developer.apple.com/documentation/storekit/skadnetwork/coarseconversionvalue>`__.
442
+
443
+ Values:
444
+ COARSE_VALUE_UNSPECIFIED (0):
445
+ Coarse value not specified.
446
+ COARSE_VALUE_LOW (1):
447
+ Coarse value of low.
448
+ COARSE_VALUE_MEDIUM (2):
449
+ Coarse value of medium.
450
+ COARSE_VALUE_HIGH (3):
451
+ Coarse value of high.
452
+ """
453
+ COARSE_VALUE_UNSPECIFIED = 0
454
+ COARSE_VALUE_LOW = 1
455
+ COARSE_VALUE_MEDIUM = 2
456
+ COARSE_VALUE_HIGH = 3
457
+
458
+
459
+ class Account(proto.Message):
460
+ r"""A resource message representing a Google Analytics account.
461
+
462
+ Attributes:
463
+ name (str):
464
+ Output only. Resource name of this account.
465
+ Format: accounts/{account}
466
+ Example: "accounts/100".
467
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
468
+ Output only. Time when this account was
469
+ originally created.
470
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
471
+ Output only. Time when account payload fields
472
+ were last updated.
473
+ display_name (str):
474
+ Required. Human-readable display name for
475
+ this account.
476
+ region_code (str):
477
+ Country of business. Must be a Unicode CLDR
478
+ region code.
479
+ deleted (bool):
480
+ Output only. Indicates whether this Account
481
+ is soft-deleted or not. Deleted accounts are
482
+ excluded from List results unless specifically
483
+ requested.
484
+ gmp_organization (str):
485
+ Output only. The URI for a Google Marketing Platform
486
+ organization resource. Only set when this account is
487
+ connected to a GMP organization. Format:
488
+ marketingplatformadmin.googleapis.com/organizations/{org_id}
489
+ """
490
+
491
+ name: str = proto.Field(
492
+ proto.STRING,
493
+ number=1,
494
+ )
495
+ create_time: timestamp_pb2.Timestamp = proto.Field(
496
+ proto.MESSAGE,
497
+ number=2,
498
+ message=timestamp_pb2.Timestamp,
499
+ )
500
+ update_time: timestamp_pb2.Timestamp = proto.Field(
501
+ proto.MESSAGE,
502
+ number=3,
503
+ message=timestamp_pb2.Timestamp,
504
+ )
505
+ display_name: str = proto.Field(
506
+ proto.STRING,
507
+ number=4,
508
+ )
509
+ region_code: str = proto.Field(
510
+ proto.STRING,
511
+ number=5,
512
+ )
513
+ deleted: bool = proto.Field(
514
+ proto.BOOL,
515
+ number=6,
516
+ )
517
+ gmp_organization: str = proto.Field(
518
+ proto.STRING,
519
+ number=7,
520
+ )
521
+
522
+
523
+ class Property(proto.Message):
524
+ r"""A resource message representing a Google Analytics property.
525
+
526
+ Attributes:
527
+ name (str):
528
+ Output only. Resource name of this property. Format:
529
+ properties/{property_id} Example: "properties/1000".
530
+ property_type (google.analytics.admin_v1alpha.types.PropertyType):
531
+ Immutable. The property type for this Property resource.
532
+ When creating a property, if the type is
533
+ "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will
534
+ be implied.
535
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
536
+ Output only. Time when the entity was
537
+ originally created.
538
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
539
+ Output only. Time when entity payload fields
540
+ were last updated.
541
+ parent (str):
542
+ Immutable. Resource name of this property's
543
+ logical parent.
544
+ Note: The Property-Moving UI can be used to
545
+ change the parent. Format: accounts/{account},
546
+ properties/{property} Example: "accounts/100",
547
+ "properties/101".
548
+ display_name (str):
549
+ Required. Human-readable display name for
550
+ this property.
551
+ The max allowed display name length is 100
552
+ UTF-16 code units.
553
+ industry_category (google.analytics.admin_v1alpha.types.IndustryCategory):
554
+ Industry associated with this property Example: AUTOMOTIVE,
555
+ FOOD_AND_DRINK
556
+ time_zone (str):
557
+ Required. Reporting Time Zone, used as the day boundary for
558
+ reports, regardless of where the data originates. If the
559
+ time zone honors DST, Analytics will automatically adjust
560
+ for the changes.
561
+
562
+ NOTE: Changing the time zone only affects data going
563
+ forward, and is not applied retroactively.
564
+
565
+ Format: https://www.iana.org/time-zones Example:
566
+ "America/Los_Angeles".
567
+ currency_code (str):
568
+ The currency type used in reports involving monetary values.
569
+
570
+ Format: https://en.wikipedia.org/wiki/ISO_4217 Examples:
571
+ "USD", "EUR", "JPY".
572
+ service_level (google.analytics.admin_v1alpha.types.ServiceLevel):
573
+ Output only. The Google Analytics service
574
+ level that applies to this property.
575
+ delete_time (google.protobuf.timestamp_pb2.Timestamp):
576
+ Output only. If set, the time at which this
577
+ property was trashed. If not set, then this
578
+ property is not currently in the trash can.
579
+ expire_time (google.protobuf.timestamp_pb2.Timestamp):
580
+ Output only. If set, the time at which this
581
+ trashed property will be permanently deleted. If
582
+ not set, then this property is not currently in
583
+ the trash can and is not slated to be deleted.
584
+ account (str):
585
+ Immutable. The resource name of the parent account Format:
586
+ accounts/{account_id} Example: "accounts/123".
587
+ """
588
+
589
+ name: str = proto.Field(
590
+ proto.STRING,
591
+ number=1,
592
+ )
593
+ property_type: "PropertyType" = proto.Field(
594
+ proto.ENUM,
595
+ number=14,
596
+ enum="PropertyType",
597
+ )
598
+ create_time: timestamp_pb2.Timestamp = proto.Field(
599
+ proto.MESSAGE,
600
+ number=3,
601
+ message=timestamp_pb2.Timestamp,
602
+ )
603
+ update_time: timestamp_pb2.Timestamp = proto.Field(
604
+ proto.MESSAGE,
605
+ number=4,
606
+ message=timestamp_pb2.Timestamp,
607
+ )
608
+ parent: str = proto.Field(
609
+ proto.STRING,
610
+ number=2,
611
+ )
612
+ display_name: str = proto.Field(
613
+ proto.STRING,
614
+ number=5,
615
+ )
616
+ industry_category: "IndustryCategory" = proto.Field(
617
+ proto.ENUM,
618
+ number=6,
619
+ enum="IndustryCategory",
620
+ )
621
+ time_zone: str = proto.Field(
622
+ proto.STRING,
623
+ number=7,
624
+ )
625
+ currency_code: str = proto.Field(
626
+ proto.STRING,
627
+ number=8,
628
+ )
629
+ service_level: "ServiceLevel" = proto.Field(
630
+ proto.ENUM,
631
+ number=10,
632
+ enum="ServiceLevel",
633
+ )
634
+ delete_time: timestamp_pb2.Timestamp = proto.Field(
635
+ proto.MESSAGE,
636
+ number=11,
637
+ message=timestamp_pb2.Timestamp,
638
+ )
639
+ expire_time: timestamp_pb2.Timestamp = proto.Field(
640
+ proto.MESSAGE,
641
+ number=12,
642
+ message=timestamp_pb2.Timestamp,
643
+ )
644
+ account: str = proto.Field(
645
+ proto.STRING,
646
+ number=13,
647
+ )
648
+
649
+
650
+ class DataStream(proto.Message):
651
+ r"""A resource message representing a data stream.
652
+
653
+ This message has `oneof`_ fields (mutually exclusive fields).
654
+ For each oneof, at most one member field can be set at the same time.
655
+ Setting any member of the oneof automatically clears all other
656
+ members.
657
+
658
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
659
+
660
+ Attributes:
661
+ web_stream_data (google.analytics.admin_v1alpha.types.DataStream.WebStreamData):
662
+ Data specific to web streams. Must be populated if type is
663
+ WEB_DATA_STREAM.
664
+
665
+ This field is a member of `oneof`_ ``stream_data``.
666
+ android_app_stream_data (google.analytics.admin_v1alpha.types.DataStream.AndroidAppStreamData):
667
+ Data specific to Android app streams. Must be populated if
668
+ type is ANDROID_APP_DATA_STREAM.
669
+
670
+ This field is a member of `oneof`_ ``stream_data``.
671
+ ios_app_stream_data (google.analytics.admin_v1alpha.types.DataStream.IosAppStreamData):
672
+ Data specific to iOS app streams. Must be populated if type
673
+ is IOS_APP_DATA_STREAM.
674
+
675
+ This field is a member of `oneof`_ ``stream_data``.
676
+ name (str):
677
+ Output only. Resource name of this Data Stream. Format:
678
+ properties/{property_id}/dataStreams/{stream_id} Example:
679
+ "properties/1000/dataStreams/2000".
680
+ type_ (google.analytics.admin_v1alpha.types.DataStream.DataStreamType):
681
+ Required. Immutable. The type of this
682
+ DataStream resource.
683
+ display_name (str):
684
+ Human-readable display name for the Data
685
+ Stream.
686
+ Required for web data streams.
687
+
688
+ The max allowed display name length is 255
689
+ UTF-16 code units.
690
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
691
+ Output only. Time when this stream was
692
+ originally created.
693
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
694
+ Output only. Time when stream payload fields
695
+ were last updated.
696
+ """
697
+
698
+ class DataStreamType(proto.Enum):
699
+ r"""The type of the data stream.
700
+
701
+ Values:
702
+ DATA_STREAM_TYPE_UNSPECIFIED (0):
703
+ Type unknown or not specified.
704
+ WEB_DATA_STREAM (1):
705
+ Web data stream.
706
+ ANDROID_APP_DATA_STREAM (2):
707
+ Android app data stream.
708
+ IOS_APP_DATA_STREAM (3):
709
+ iOS app data stream.
710
+ """
711
+ DATA_STREAM_TYPE_UNSPECIFIED = 0
712
+ WEB_DATA_STREAM = 1
713
+ ANDROID_APP_DATA_STREAM = 2
714
+ IOS_APP_DATA_STREAM = 3
715
+
716
+ class WebStreamData(proto.Message):
717
+ r"""Data specific to web streams.
718
+
719
+ Attributes:
720
+ measurement_id (str):
721
+ Output only. Analytics Measurement ID.
722
+
723
+ Example: "G-1A2BCD345E".
724
+ firebase_app_id (str):
725
+ Output only. ID of the corresponding web app
726
+ in Firebase, if any. This ID can change if the
727
+ web app is deleted and recreated.
728
+ default_uri (str):
729
+ Domain name of the web app being measured, or
730
+ empty. Example: "http://www.google.com",
731
+ "https://www.google.com".
732
+ """
733
+
734
+ measurement_id: str = proto.Field(
735
+ proto.STRING,
736
+ number=1,
737
+ )
738
+ firebase_app_id: str = proto.Field(
739
+ proto.STRING,
740
+ number=2,
741
+ )
742
+ default_uri: str = proto.Field(
743
+ proto.STRING,
744
+ number=3,
745
+ )
746
+
747
+ class AndroidAppStreamData(proto.Message):
748
+ r"""Data specific to Android app streams.
749
+
750
+ Attributes:
751
+ firebase_app_id (str):
752
+ Output only. ID of the corresponding Android
753
+ app in Firebase, if any. This ID can change if
754
+ the Android app is deleted and recreated.
755
+ package_name (str):
756
+ Immutable. The package name for the app being
757
+ measured. Example: "com.example.myandroidapp".
758
+ """
759
+
760
+ firebase_app_id: str = proto.Field(
761
+ proto.STRING,
762
+ number=1,
763
+ )
764
+ package_name: str = proto.Field(
765
+ proto.STRING,
766
+ number=2,
767
+ )
768
+
769
+ class IosAppStreamData(proto.Message):
770
+ r"""Data specific to iOS app streams.
771
+
772
+ Attributes:
773
+ firebase_app_id (str):
774
+ Output only. ID of the corresponding iOS app
775
+ in Firebase, if any. This ID can change if the
776
+ iOS app is deleted and recreated.
777
+ bundle_id (str):
778
+ Required. Immutable. The Apple App Store
779
+ Bundle ID for the app Example:
780
+ "com.example.myiosapp".
781
+ """
782
+
783
+ firebase_app_id: str = proto.Field(
784
+ proto.STRING,
785
+ number=1,
786
+ )
787
+ bundle_id: str = proto.Field(
788
+ proto.STRING,
789
+ number=2,
790
+ )
791
+
792
+ web_stream_data: WebStreamData = proto.Field(
793
+ proto.MESSAGE,
794
+ number=6,
795
+ oneof="stream_data",
796
+ message=WebStreamData,
797
+ )
798
+ android_app_stream_data: AndroidAppStreamData = proto.Field(
799
+ proto.MESSAGE,
800
+ number=7,
801
+ oneof="stream_data",
802
+ message=AndroidAppStreamData,
803
+ )
804
+ ios_app_stream_data: IosAppStreamData = proto.Field(
805
+ proto.MESSAGE,
806
+ number=8,
807
+ oneof="stream_data",
808
+ message=IosAppStreamData,
809
+ )
810
+ name: str = proto.Field(
811
+ proto.STRING,
812
+ number=1,
813
+ )
814
+ type_: DataStreamType = proto.Field(
815
+ proto.ENUM,
816
+ number=2,
817
+ enum=DataStreamType,
818
+ )
819
+ display_name: str = proto.Field(
820
+ proto.STRING,
821
+ number=3,
822
+ )
823
+ create_time: timestamp_pb2.Timestamp = proto.Field(
824
+ proto.MESSAGE,
825
+ number=4,
826
+ message=timestamp_pb2.Timestamp,
827
+ )
828
+ update_time: timestamp_pb2.Timestamp = proto.Field(
829
+ proto.MESSAGE,
830
+ number=5,
831
+ message=timestamp_pb2.Timestamp,
832
+ )
833
+
834
+
835
+ class FirebaseLink(proto.Message):
836
+ r"""A link between a Google Analytics property and a Firebase
837
+ project.
838
+
839
+ Attributes:
840
+ name (str):
841
+ Output only. Example format:
842
+ properties/1234/firebaseLinks/5678
843
+ project (str):
844
+ Immutable. Firebase project resource name. When creating a
845
+ FirebaseLink, you may provide this resource name using
846
+ either a project number or project ID. Once this resource
847
+ has been created, returned FirebaseLinks will always have a
848
+ project_name that contains a project number.
849
+
850
+ Format: 'projects/{project number}' Example: 'projects/1234'
851
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
852
+ Output only. Time when this FirebaseLink was
853
+ originally created.
854
+ """
855
+
856
+ name: str = proto.Field(
857
+ proto.STRING,
858
+ number=1,
859
+ )
860
+ project: str = proto.Field(
861
+ proto.STRING,
862
+ number=2,
863
+ )
864
+ create_time: timestamp_pb2.Timestamp = proto.Field(
865
+ proto.MESSAGE,
866
+ number=3,
867
+ message=timestamp_pb2.Timestamp,
868
+ )
869
+
870
+
871
+ class GlobalSiteTag(proto.Message):
872
+ r"""Read-only resource with the tag for sending data from a
873
+ website to a DataStream. Only present for web DataStream
874
+ resources.
875
+
876
+ Attributes:
877
+ name (str):
878
+ Output only. Resource name for this GlobalSiteTag resource.
879
+ Format:
880
+ properties/{property_id}/dataStreams/{stream_id}/globalSiteTag
881
+ Example: "properties/123/dataStreams/456/globalSiteTag".
882
+ snippet (str):
883
+ Immutable. JavaScript code snippet to be
884
+ pasted as the first item into the head tag of
885
+ every webpage to measure.
886
+ """
887
+
888
+ name: str = proto.Field(
889
+ proto.STRING,
890
+ number=1,
891
+ )
892
+ snippet: str = proto.Field(
893
+ proto.STRING,
894
+ number=2,
895
+ )
896
+
897
+
898
+ class GoogleAdsLink(proto.Message):
899
+ r"""A link between a Google Analytics property and a Google Ads
900
+ account.
901
+
902
+ Attributes:
903
+ name (str):
904
+ Output only. Format:
905
+
906
+ properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
907
+
908
+ Note: googleAdsLinkId is not the Google Ads
909
+ customer ID.
910
+ customer_id (str):
911
+ Immutable. Google Ads customer ID.
912
+ can_manage_clients (bool):
913
+ Output only. If true, this link is for a
914
+ Google Ads manager account.
915
+ ads_personalization_enabled (google.protobuf.wrappers_pb2.BoolValue):
916
+ Enable personalized advertising features with
917
+ this integration. Automatically publish my
918
+ Google Analytics audience lists and Google
919
+ Analytics remarketing events/parameters to the
920
+ linked Google Ads account. If this field is not
921
+ set on create/update, it will be defaulted to
922
+ true.
923
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
924
+ Output only. Time when this link was
925
+ originally created.
926
+ update_time (google.protobuf.timestamp_pb2.Timestamp):
927
+ Output only. Time when this link was last
928
+ updated.
929
+ creator_email_address (str):
930
+ Output only. Email address of the user that
931
+ created the link. An empty string will be
932
+ returned if the email address can't be
933
+ retrieved.
934
+ """
935
+
936
+ name: str = proto.Field(
937
+ proto.STRING,
938
+ number=1,
939
+ )
940
+ customer_id: str = proto.Field(
941
+ proto.STRING,
942
+ number=3,
943
+ )
944
+ can_manage_clients: bool = proto.Field(
945
+ proto.BOOL,
946
+ number=4,
947
+ )
948
+ ads_personalization_enabled: wrappers_pb2.BoolValue = proto.Field(
949
+ proto.MESSAGE,
950
+ number=5,
951
+ message=wrappers_pb2.BoolValue,
952
+ )
953
+ create_time: timestamp_pb2.Timestamp = proto.Field(
954
+ proto.MESSAGE,
955
+ number=7,
956
+ message=timestamp_pb2.Timestamp,
957
+ )
958
+ update_time: timestamp_pb2.Timestamp = proto.Field(
959
+ proto.MESSAGE,
960
+ number=8,
961
+ message=timestamp_pb2.Timestamp,
962
+ )
963
+ creator_email_address: str = proto.Field(
964
+ proto.STRING,
965
+ number=9,
966
+ )
967
+
968
+
969
+ class DataSharingSettings(proto.Message):
970
+ r"""A resource message representing data sharing settings of a
971
+ Google Analytics account.
972
+
973
+ Attributes:
974
+ name (str):
975
+ Output only. Resource name.
976
+ Format: accounts/{account}/dataSharingSettings
977
+ Example: "accounts/1000/dataSharingSettings".
978
+ sharing_with_google_support_enabled (bool):
979
+ Allows Google support to access the data in
980
+ order to help troubleshoot issues.
981
+ sharing_with_google_assigned_sales_enabled (bool):
982
+ Allows Google sales teams that are assigned
983
+ to the customer to access the data in order to
984
+ suggest configuration changes to improve
985
+ results. Sales team restrictions still apply
986
+ when enabled.
987
+ sharing_with_google_any_sales_enabled (bool):
988
+ Allows any of Google sales to access the data
989
+ in order to suggest configuration changes to
990
+ improve results.
991
+ sharing_with_google_products_enabled (bool):
992
+ Allows Google to use the data to improve
993
+ other Google products or services.
994
+ sharing_with_others_enabled (bool):
995
+ Allows Google to share the data anonymously
996
+ in aggregate form with others.
997
+ """
998
+
999
+ name: str = proto.Field(
1000
+ proto.STRING,
1001
+ number=1,
1002
+ )
1003
+ sharing_with_google_support_enabled: bool = proto.Field(
1004
+ proto.BOOL,
1005
+ number=2,
1006
+ )
1007
+ sharing_with_google_assigned_sales_enabled: bool = proto.Field(
1008
+ proto.BOOL,
1009
+ number=3,
1010
+ )
1011
+ sharing_with_google_any_sales_enabled: bool = proto.Field(
1012
+ proto.BOOL,
1013
+ number=4,
1014
+ )
1015
+ sharing_with_google_products_enabled: bool = proto.Field(
1016
+ proto.BOOL,
1017
+ number=5,
1018
+ )
1019
+ sharing_with_others_enabled: bool = proto.Field(
1020
+ proto.BOOL,
1021
+ number=6,
1022
+ )
1023
+
1024
+
1025
+ class AccountSummary(proto.Message):
1026
+ r"""A virtual resource representing an overview of an account and
1027
+ all its child Google Analytics properties.
1028
+
1029
+ Attributes:
1030
+ name (str):
1031
+ Resource name for this account summary. Format:
1032
+ accountSummaries/{account_id} Example:
1033
+ "accountSummaries/1000".
1034
+ account (str):
1035
+ Resource name of account referred to by this account summary
1036
+ Format: accounts/{account_id} Example: "accounts/1000".
1037
+ display_name (str):
1038
+ Display name for the account referred to in
1039
+ this account summary.
1040
+ property_summaries (MutableSequence[google.analytics.admin_v1alpha.types.PropertySummary]):
1041
+ List of summaries for child accounts of this
1042
+ account.
1043
+ """
1044
+
1045
+ name: str = proto.Field(
1046
+ proto.STRING,
1047
+ number=1,
1048
+ )
1049
+ account: str = proto.Field(
1050
+ proto.STRING,
1051
+ number=2,
1052
+ )
1053
+ display_name: str = proto.Field(
1054
+ proto.STRING,
1055
+ number=3,
1056
+ )
1057
+ property_summaries: MutableSequence["PropertySummary"] = proto.RepeatedField(
1058
+ proto.MESSAGE,
1059
+ number=4,
1060
+ message="PropertySummary",
1061
+ )
1062
+
1063
+
1064
+ class PropertySummary(proto.Message):
1065
+ r"""A virtual resource representing metadata for a Google
1066
+ Analytics property.
1067
+
1068
+ Attributes:
1069
+ property (str):
1070
+ Resource name of property referred to by this property
1071
+ summary Format: properties/{property_id} Example:
1072
+ "properties/1000".
1073
+ display_name (str):
1074
+ Display name for the property referred to in
1075
+ this property summary.
1076
+ property_type (google.analytics.admin_v1alpha.types.PropertyType):
1077
+ The property's property type.
1078
+ parent (str):
1079
+ Resource name of this property's logical
1080
+ parent.
1081
+ Note: The Property-Moving UI can be used to
1082
+ change the parent. Format: accounts/{account},
1083
+ properties/{property} Example: "accounts/100",
1084
+ "properties/200".
1085
+ """
1086
+
1087
+ property: str = proto.Field(
1088
+ proto.STRING,
1089
+ number=1,
1090
+ )
1091
+ display_name: str = proto.Field(
1092
+ proto.STRING,
1093
+ number=2,
1094
+ )
1095
+ property_type: "PropertyType" = proto.Field(
1096
+ proto.ENUM,
1097
+ number=3,
1098
+ enum="PropertyType",
1099
+ )
1100
+ parent: str = proto.Field(
1101
+ proto.STRING,
1102
+ number=4,
1103
+ )
1104
+
1105
+
1106
+ class MeasurementProtocolSecret(proto.Message):
1107
+ r"""A secret value used for sending hits to Measurement Protocol.
1108
+
1109
+ Attributes:
1110
+ name (str):
1111
+ Output only. Resource name of this secret.
1112
+ This secret may be a child of any type of
1113
+ stream. Format:
1114
+
1115
+ properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
1116
+ display_name (str):
1117
+ Required. Human-readable display name for
1118
+ this secret.
1119
+ secret_value (str):
1120
+ Output only. The measurement protocol secret value. Pass
1121
+ this value to the api_secret field of the Measurement
1122
+ Protocol API when sending hits to this secret's parent
1123
+ property.
1124
+ """
1125
+
1126
+ name: str = proto.Field(
1127
+ proto.STRING,
1128
+ number=1,
1129
+ )
1130
+ display_name: str = proto.Field(
1131
+ proto.STRING,
1132
+ number=2,
1133
+ )
1134
+ secret_value: str = proto.Field(
1135
+ proto.STRING,
1136
+ number=3,
1137
+ )
1138
+
1139
+
1140
+ class SKAdNetworkConversionValueSchema(proto.Message):
1141
+ r"""SKAdNetwork conversion value schema of an iOS stream.
1142
+
1143
+ Attributes:
1144
+ name (str):
1145
+ Output only. Resource name of the schema.
1146
+ This will be child of ONLY an iOS stream, and
1147
+ there can be at most one such child under an iOS
1148
+ stream. Format:
1149
+
1150
+ properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
1151
+ postback_window_one (google.analytics.admin_v1alpha.types.PostbackWindow):
1152
+ Required. The conversion value settings for
1153
+ the first postback window. These differ from
1154
+ values for postback window two and three in that
1155
+ they contain a "Fine" grained conversion value
1156
+ (a numeric value).
1157
+
1158
+ Conversion values for this postback window must
1159
+ be set. The other windows are optional and may
1160
+ inherit this window's settings if unset or
1161
+ disabled.
1162
+ postback_window_two (google.analytics.admin_v1alpha.types.PostbackWindow):
1163
+ The conversion value settings for the second postback
1164
+ window.
1165
+
1166
+ This field should only be configured if there is a need to
1167
+ define different conversion values for this postback window.
1168
+
1169
+ If enable_postback_window_settings is set to false for this
1170
+ postback window, the values from postback_window_one will be
1171
+ used.
1172
+ postback_window_three (google.analytics.admin_v1alpha.types.PostbackWindow):
1173
+ The conversion value settings for the third postback window.
1174
+
1175
+ This field should only be set if the user chose to define
1176
+ different conversion values for this postback window. It is
1177
+ allowed to configure window 3 without setting window 2. In
1178
+ case window 1 & 2 settings are set and
1179
+ enable_postback_window_settings for this postback window is
1180
+ set to false, the schema will inherit settings from
1181
+ postback_window_two.
1182
+ apply_conversion_values (bool):
1183
+ If enabled, the GA SDK will set conversion
1184
+ values using this schema definition, and schema
1185
+ will be exported to any Google Ads accounts
1186
+ linked to this property. If disabled, the GA SDK
1187
+ will not automatically set conversion values,
1188
+ and also the schema will not be exported to Ads.
1189
+ """
1190
+
1191
+ name: str = proto.Field(
1192
+ proto.STRING,
1193
+ number=1,
1194
+ )
1195
+ postback_window_one: "PostbackWindow" = proto.Field(
1196
+ proto.MESSAGE,
1197
+ number=2,
1198
+ message="PostbackWindow",
1199
+ )
1200
+ postback_window_two: "PostbackWindow" = proto.Field(
1201
+ proto.MESSAGE,
1202
+ number=3,
1203
+ message="PostbackWindow",
1204
+ )
1205
+ postback_window_three: "PostbackWindow" = proto.Field(
1206
+ proto.MESSAGE,
1207
+ number=4,
1208
+ message="PostbackWindow",
1209
+ )
1210
+ apply_conversion_values: bool = proto.Field(
1211
+ proto.BOOL,
1212
+ number=5,
1213
+ )
1214
+
1215
+
1216
+ class PostbackWindow(proto.Message):
1217
+ r"""Settings for a SKAdNetwork conversion postback window.
1218
+
1219
+ Attributes:
1220
+ conversion_values (MutableSequence[google.analytics.admin_v1alpha.types.ConversionValues]):
1221
+ Ordering of the repeated field will be used to prioritize
1222
+ the conversion value settings. Lower indexed entries are
1223
+ prioritized higher. The first conversion value setting that
1224
+ evaluates to true will be selected. It must have at least
1225
+ one entry if enable_postback_window_settings is set to true.
1226
+ It can have maximum of 128 entries.
1227
+ postback_window_settings_enabled (bool):
1228
+ If enable_postback_window_settings is true,
1229
+ conversion_values must be populated and will be used for
1230
+ determining when and how to set the Conversion Value on a
1231
+ client device and exporting schema to linked Ads accounts.
1232
+ If false, the settings are not used, but are retained in
1233
+ case they may be used in the future. This must always be
1234
+ true for postback_window_one.
1235
+ """
1236
+
1237
+ conversion_values: MutableSequence["ConversionValues"] = proto.RepeatedField(
1238
+ proto.MESSAGE,
1239
+ number=1,
1240
+ message="ConversionValues",
1241
+ )
1242
+ postback_window_settings_enabled: bool = proto.Field(
1243
+ proto.BOOL,
1244
+ number=2,
1245
+ )
1246
+
1247
+
1248
+ class ConversionValues(proto.Message):
1249
+ r"""Conversion value settings for a postback window for
1250
+ SKAdNetwork conversion value schema.
1251
+
1252
+
1253
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1254
+
1255
+ Attributes:
1256
+ display_name (str):
1257
+ Display name of the SKAdNetwork conversion
1258
+ value. The max allowed display name length is 50
1259
+ UTF-16 code units.
1260
+ fine_value (int):
1261
+ The fine-grained conversion value. This is applicable only
1262
+ to the first postback window. Its valid values are [0,63],
1263
+ both inclusive. It must be set for postback window 1, and
1264
+ must not be set for postback window 2 & 3. This value is not
1265
+ guaranteed to be unique.
1266
+
1267
+ If the configuration for the first postback window is
1268
+ re-used for second or third postback windows this field has
1269
+ no effect.
1270
+
1271
+ This field is a member of `oneof`_ ``_fine_value``.
1272
+ coarse_value (google.analytics.admin_v1alpha.types.CoarseValue):
1273
+ Required. A coarse grained conversion value.
1274
+
1275
+ This value is not guaranteed to be unique.
1276
+ event_mappings (MutableSequence[google.analytics.admin_v1alpha.types.EventMapping]):
1277
+ Event conditions that must be met for this
1278
+ Conversion Value to be achieved. The conditions
1279
+ in this list are ANDed together. It must have
1280
+ minimum of 1 entry and maximum of 3 entries, if
1281
+ the postback window is enabled.
1282
+ lock_enabled (bool):
1283
+ If true, the SDK should lock to this
1284
+ conversion value for the current postback
1285
+ window.
1286
+ """
1287
+
1288
+ display_name: str = proto.Field(
1289
+ proto.STRING,
1290
+ number=1,
1291
+ )
1292
+ fine_value: int = proto.Field(
1293
+ proto.INT32,
1294
+ number=2,
1295
+ optional=True,
1296
+ )
1297
+ coarse_value: "CoarseValue" = proto.Field(
1298
+ proto.ENUM,
1299
+ number=3,
1300
+ enum="CoarseValue",
1301
+ )
1302
+ event_mappings: MutableSequence["EventMapping"] = proto.RepeatedField(
1303
+ proto.MESSAGE,
1304
+ number=4,
1305
+ message="EventMapping",
1306
+ )
1307
+ lock_enabled: bool = proto.Field(
1308
+ proto.BOOL,
1309
+ number=5,
1310
+ )
1311
+
1312
+
1313
+ class EventMapping(proto.Message):
1314
+ r"""Event setting conditions to match an event.
1315
+
1316
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1317
+
1318
+ Attributes:
1319
+ event_name (str):
1320
+ Required. Name of the Google Analytics event.
1321
+ It must always be set. The max allowed display
1322
+ name length is 40 UTF-16 code units.
1323
+ min_event_count (int):
1324
+ At least one of the following four min/max
1325
+ values must be set. The values set will be ANDed
1326
+ together to qualify an event. The minimum number
1327
+ of times the event occurred. If not set, minimum
1328
+ event count won't be checked.
1329
+
1330
+ This field is a member of `oneof`_ ``_min_event_count``.
1331
+ max_event_count (int):
1332
+ The maximum number of times the event
1333
+ occurred. If not set, maximum event count won't
1334
+ be checked.
1335
+
1336
+ This field is a member of `oneof`_ ``_max_event_count``.
1337
+ min_event_value (float):
1338
+ The minimum revenue generated due to the
1339
+ event. Revenue currency will be defined at the
1340
+ property level. If not set, minimum event value
1341
+ won't be checked.
1342
+
1343
+ This field is a member of `oneof`_ ``_min_event_value``.
1344
+ max_event_value (float):
1345
+ The maximum revenue generated due to the
1346
+ event. Revenue currency will be defined at the
1347
+ property level. If not set, maximum event value
1348
+ won't be checked.
1349
+
1350
+ This field is a member of `oneof`_ ``_max_event_value``.
1351
+ """
1352
+
1353
+ event_name: str = proto.Field(
1354
+ proto.STRING,
1355
+ number=1,
1356
+ )
1357
+ min_event_count: int = proto.Field(
1358
+ proto.INT64,
1359
+ number=2,
1360
+ optional=True,
1361
+ )
1362
+ max_event_count: int = proto.Field(
1363
+ proto.INT64,
1364
+ number=3,
1365
+ optional=True,
1366
+ )
1367
+ min_event_value: float = proto.Field(
1368
+ proto.DOUBLE,
1369
+ number=4,
1370
+ optional=True,
1371
+ )
1372
+ max_event_value: float = proto.Field(
1373
+ proto.DOUBLE,
1374
+ number=5,
1375
+ optional=True,
1376
+ )
1377
+
1378
+
1379
+ class ChangeHistoryEvent(proto.Message):
1380
+ r"""A set of changes within a Google Analytics account or its
1381
+ child properties that resulted from the same cause. Common
1382
+ causes would be updates made in the Google Analytics UI, changes
1383
+ from customer support, or automatic Google Analytics system
1384
+ changes.
1385
+
1386
+ Attributes:
1387
+ id (str):
1388
+ ID of this change history event. This ID is
1389
+ unique across Google Analytics.
1390
+ change_time (google.protobuf.timestamp_pb2.Timestamp):
1391
+ Time when change was made.
1392
+ actor_type (google.analytics.admin_v1alpha.types.ActorType):
1393
+ The type of actor that made this change.
1394
+ user_actor_email (str):
1395
+ Email address of the Google account that made
1396
+ the change. This will be a valid email address
1397
+ if the actor field is set to USER, and empty
1398
+ otherwise. Google accounts that have been
1399
+ deleted will cause an error.
1400
+ changes_filtered (bool):
1401
+ If true, then the list of changes returned
1402
+ was filtered, and does not represent all changes
1403
+ that occurred in this event.
1404
+ changes (MutableSequence[google.analytics.admin_v1alpha.types.ChangeHistoryChange]):
1405
+ A list of changes made in this change history
1406
+ event that fit the filters specified in
1407
+ SearchChangeHistoryEventsRequest.
1408
+ """
1409
+
1410
+ id: str = proto.Field(
1411
+ proto.STRING,
1412
+ number=1,
1413
+ )
1414
+ change_time: timestamp_pb2.Timestamp = proto.Field(
1415
+ proto.MESSAGE,
1416
+ number=2,
1417
+ message=timestamp_pb2.Timestamp,
1418
+ )
1419
+ actor_type: "ActorType" = proto.Field(
1420
+ proto.ENUM,
1421
+ number=3,
1422
+ enum="ActorType",
1423
+ )
1424
+ user_actor_email: str = proto.Field(
1425
+ proto.STRING,
1426
+ number=4,
1427
+ )
1428
+ changes_filtered: bool = proto.Field(
1429
+ proto.BOOL,
1430
+ number=5,
1431
+ )
1432
+ changes: MutableSequence["ChangeHistoryChange"] = proto.RepeatedField(
1433
+ proto.MESSAGE,
1434
+ number=6,
1435
+ message="ChangeHistoryChange",
1436
+ )
1437
+
1438
+
1439
+ class ChangeHistoryChange(proto.Message):
1440
+ r"""A description of a change to a single Google Analytics
1441
+ resource.
1442
+
1443
+ Attributes:
1444
+ resource (str):
1445
+ Resource name of the resource whose changes
1446
+ are described by this entry.
1447
+ action (google.analytics.admin_v1alpha.types.ActionType):
1448
+ The type of action that changed this
1449
+ resource.
1450
+ resource_before_change (google.analytics.admin_v1alpha.types.ChangeHistoryChange.ChangeHistoryResource):
1451
+ Resource contents from before the change was
1452
+ made. If this resource was created in this
1453
+ change, this field will be missing.
1454
+ resource_after_change (google.analytics.admin_v1alpha.types.ChangeHistoryChange.ChangeHistoryResource):
1455
+ Resource contents from after the change was
1456
+ made. If this resource was deleted in this
1457
+ change, this field will be missing.
1458
+ """
1459
+
1460
+ class ChangeHistoryResource(proto.Message):
1461
+ r"""A snapshot of a resource as before or after the result of a
1462
+ change in change history.
1463
+
1464
+ This message has `oneof`_ fields (mutually exclusive fields).
1465
+ For each oneof, at most one member field can be set at the same time.
1466
+ Setting any member of the oneof automatically clears all other
1467
+ members.
1468
+
1469
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
1470
+
1471
+ Attributes:
1472
+ account (google.analytics.admin_v1alpha.types.Account):
1473
+ A snapshot of an Account resource in change
1474
+ history.
1475
+
1476
+ This field is a member of `oneof`_ ``resource``.
1477
+ property (google.analytics.admin_v1alpha.types.Property):
1478
+ A snapshot of a Property resource in change
1479
+ history.
1480
+
1481
+ This field is a member of `oneof`_ ``resource``.
1482
+ firebase_link (google.analytics.admin_v1alpha.types.FirebaseLink):
1483
+ A snapshot of a FirebaseLink resource in
1484
+ change history.
1485
+
1486
+ This field is a member of `oneof`_ ``resource``.
1487
+ google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink):
1488
+ A snapshot of a GoogleAdsLink resource in
1489
+ change history.
1490
+
1491
+ This field is a member of `oneof`_ ``resource``.
1492
+ google_signals_settings (google.analytics.admin_v1alpha.types.GoogleSignalsSettings):
1493
+ A snapshot of a GoogleSignalsSettings
1494
+ resource in change history.
1495
+
1496
+ This field is a member of `oneof`_ ``resource``.
1497
+ display_video_360_advertiser_link (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink):
1498
+ A snapshot of a DisplayVideo360AdvertiserLink
1499
+ resource in change history.
1500
+
1501
+ This field is a member of `oneof`_ ``resource``.
1502
+ display_video_360_advertiser_link_proposal (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal):
1503
+ A snapshot of a
1504
+ DisplayVideo360AdvertiserLinkProposal resource
1505
+ in change history.
1506
+
1507
+ This field is a member of `oneof`_ ``resource``.
1508
+ conversion_event (google.analytics.admin_v1alpha.types.ConversionEvent):
1509
+ A snapshot of a ConversionEvent resource in
1510
+ change history.
1511
+
1512
+ This field is a member of `oneof`_ ``resource``.
1513
+ measurement_protocol_secret (google.analytics.admin_v1alpha.types.MeasurementProtocolSecret):
1514
+ A snapshot of a MeasurementProtocolSecret
1515
+ resource in change history.
1516
+
1517
+ This field is a member of `oneof`_ ``resource``.
1518
+ custom_dimension (google.analytics.admin_v1alpha.types.CustomDimension):
1519
+ A snapshot of a CustomDimension resource in
1520
+ change history.
1521
+
1522
+ This field is a member of `oneof`_ ``resource``.
1523
+ custom_metric (google.analytics.admin_v1alpha.types.CustomMetric):
1524
+ A snapshot of a CustomMetric resource in
1525
+ change history.
1526
+
1527
+ This field is a member of `oneof`_ ``resource``.
1528
+ data_retention_settings (google.analytics.admin_v1alpha.types.DataRetentionSettings):
1529
+ A snapshot of a data retention settings
1530
+ resource in change history.
1531
+
1532
+ This field is a member of `oneof`_ ``resource``.
1533
+ search_ads_360_link (google.analytics.admin_v1alpha.types.SearchAds360Link):
1534
+ A snapshot of a SearchAds360Link resource in
1535
+ change history.
1536
+
1537
+ This field is a member of `oneof`_ ``resource``.
1538
+ data_stream (google.analytics.admin_v1alpha.types.DataStream):
1539
+ A snapshot of a DataStream resource in change
1540
+ history.
1541
+
1542
+ This field is a member of `oneof`_ ``resource``.
1543
+ attribution_settings (google.analytics.admin_v1alpha.types.AttributionSettings):
1544
+ A snapshot of AttributionSettings resource in
1545
+ change history.
1546
+
1547
+ This field is a member of `oneof`_ ``resource``.
1548
+ expanded_data_set (google.analytics.admin_v1alpha.types.ExpandedDataSet):
1549
+ A snapshot of an ExpandedDataSet resource in
1550
+ change history.
1551
+
1552
+ This field is a member of `oneof`_ ``resource``.
1553
+ channel_group (google.analytics.admin_v1alpha.types.ChannelGroup):
1554
+ A snapshot of a ChannelGroup resource in
1555
+ change history.
1556
+
1557
+ This field is a member of `oneof`_ ``resource``.
1558
+ bigquery_link (google.analytics.admin_v1alpha.types.BigQueryLink):
1559
+ A snapshot of a BigQuery link resource in
1560
+ change history.
1561
+
1562
+ This field is a member of `oneof`_ ``resource``.
1563
+ enhanced_measurement_settings (google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings):
1564
+ A snapshot of EnhancedMeasurementSettings
1565
+ resource in change history.
1566
+
1567
+ This field is a member of `oneof`_ ``resource``.
1568
+ data_redaction_settings (google.analytics.admin_v1alpha.types.DataRedactionSettings):
1569
+ A snapshot of DataRedactionSettings resource
1570
+ in change history.
1571
+
1572
+ This field is a member of `oneof`_ ``resource``.
1573
+ skadnetwork_conversion_value_schema (google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema):
1574
+ A snapshot of
1575
+ SKAdNetworkConversionValueSchema resource in
1576
+ change history.
1577
+
1578
+ This field is a member of `oneof`_ ``resource``.
1579
+ adsense_link (google.analytics.admin_v1alpha.types.AdSenseLink):
1580
+ A snapshot of an AdSenseLink resource in
1581
+ change history.
1582
+
1583
+ This field is a member of `oneof`_ ``resource``.
1584
+ audience (google.analytics.admin_v1alpha.types.Audience):
1585
+ A snapshot of an Audience resource in change
1586
+ history.
1587
+
1588
+ This field is a member of `oneof`_ ``resource``.
1589
+ event_create_rule (google.analytics.admin_v1alpha.types.EventCreateRule):
1590
+ A snapshot of an EventCreateRule resource in
1591
+ change history.
1592
+
1593
+ This field is a member of `oneof`_ ``resource``.
1594
+ calculated_metric (google.analytics.admin_v1alpha.types.CalculatedMetric):
1595
+ A snapshot of a CalculatedMetric resource in
1596
+ change history.
1597
+
1598
+ This field is a member of `oneof`_ ``resource``.
1599
+ key_event (google.analytics.admin_v1alpha.types.KeyEvent):
1600
+ A snapshot of a KeyEvent resource in change
1601
+ history.
1602
+
1603
+ This field is a member of `oneof`_ ``resource``.
1604
+ """
1605
+
1606
+ account: "Account" = proto.Field(
1607
+ proto.MESSAGE,
1608
+ number=1,
1609
+ oneof="resource",
1610
+ message="Account",
1611
+ )
1612
+ property: "Property" = proto.Field(
1613
+ proto.MESSAGE,
1614
+ number=2,
1615
+ oneof="resource",
1616
+ message="Property",
1617
+ )
1618
+ firebase_link: "FirebaseLink" = proto.Field(
1619
+ proto.MESSAGE,
1620
+ number=6,
1621
+ oneof="resource",
1622
+ message="FirebaseLink",
1623
+ )
1624
+ google_ads_link: "GoogleAdsLink" = proto.Field(
1625
+ proto.MESSAGE,
1626
+ number=7,
1627
+ oneof="resource",
1628
+ message="GoogleAdsLink",
1629
+ )
1630
+ google_signals_settings: "GoogleSignalsSettings" = proto.Field(
1631
+ proto.MESSAGE,
1632
+ number=8,
1633
+ oneof="resource",
1634
+ message="GoogleSignalsSettings",
1635
+ )
1636
+ display_video_360_advertiser_link: "DisplayVideo360AdvertiserLink" = (
1637
+ proto.Field(
1638
+ proto.MESSAGE,
1639
+ number=9,
1640
+ oneof="resource",
1641
+ message="DisplayVideo360AdvertiserLink",
1642
+ )
1643
+ )
1644
+ display_video_360_advertiser_link_proposal: "DisplayVideo360AdvertiserLinkProposal" = proto.Field(
1645
+ proto.MESSAGE,
1646
+ number=10,
1647
+ oneof="resource",
1648
+ message="DisplayVideo360AdvertiserLinkProposal",
1649
+ )
1650
+ conversion_event: "ConversionEvent" = proto.Field(
1651
+ proto.MESSAGE,
1652
+ number=11,
1653
+ oneof="resource",
1654
+ message="ConversionEvent",
1655
+ )
1656
+ measurement_protocol_secret: "MeasurementProtocolSecret" = proto.Field(
1657
+ proto.MESSAGE,
1658
+ number=12,
1659
+ oneof="resource",
1660
+ message="MeasurementProtocolSecret",
1661
+ )
1662
+ custom_dimension: "CustomDimension" = proto.Field(
1663
+ proto.MESSAGE,
1664
+ number=13,
1665
+ oneof="resource",
1666
+ message="CustomDimension",
1667
+ )
1668
+ custom_metric: "CustomMetric" = proto.Field(
1669
+ proto.MESSAGE,
1670
+ number=14,
1671
+ oneof="resource",
1672
+ message="CustomMetric",
1673
+ )
1674
+ data_retention_settings: "DataRetentionSettings" = proto.Field(
1675
+ proto.MESSAGE,
1676
+ number=15,
1677
+ oneof="resource",
1678
+ message="DataRetentionSettings",
1679
+ )
1680
+ search_ads_360_link: "SearchAds360Link" = proto.Field(
1681
+ proto.MESSAGE,
1682
+ number=16,
1683
+ oneof="resource",
1684
+ message="SearchAds360Link",
1685
+ )
1686
+ data_stream: "DataStream" = proto.Field(
1687
+ proto.MESSAGE,
1688
+ number=18,
1689
+ oneof="resource",
1690
+ message="DataStream",
1691
+ )
1692
+ attribution_settings: "AttributionSettings" = proto.Field(
1693
+ proto.MESSAGE,
1694
+ number=20,
1695
+ oneof="resource",
1696
+ message="AttributionSettings",
1697
+ )
1698
+ expanded_data_set: gaa_expanded_data_set.ExpandedDataSet = proto.Field(
1699
+ proto.MESSAGE,
1700
+ number=21,
1701
+ oneof="resource",
1702
+ message=gaa_expanded_data_set.ExpandedDataSet,
1703
+ )
1704
+ channel_group: gaa_channel_group.ChannelGroup = proto.Field(
1705
+ proto.MESSAGE,
1706
+ number=22,
1707
+ oneof="resource",
1708
+ message=gaa_channel_group.ChannelGroup,
1709
+ )
1710
+ bigquery_link: "BigQueryLink" = proto.Field(
1711
+ proto.MESSAGE,
1712
+ number=23,
1713
+ oneof="resource",
1714
+ message="BigQueryLink",
1715
+ )
1716
+ enhanced_measurement_settings: "EnhancedMeasurementSettings" = proto.Field(
1717
+ proto.MESSAGE,
1718
+ number=24,
1719
+ oneof="resource",
1720
+ message="EnhancedMeasurementSettings",
1721
+ )
1722
+ data_redaction_settings: "DataRedactionSettings" = proto.Field(
1723
+ proto.MESSAGE,
1724
+ number=25,
1725
+ oneof="resource",
1726
+ message="DataRedactionSettings",
1727
+ )
1728
+ skadnetwork_conversion_value_schema: "SKAdNetworkConversionValueSchema" = (
1729
+ proto.Field(
1730
+ proto.MESSAGE,
1731
+ number=26,
1732
+ oneof="resource",
1733
+ message="SKAdNetworkConversionValueSchema",
1734
+ )
1735
+ )
1736
+ adsense_link: "AdSenseLink" = proto.Field(
1737
+ proto.MESSAGE,
1738
+ number=27,
1739
+ oneof="resource",
1740
+ message="AdSenseLink",
1741
+ )
1742
+ audience: gaa_audience.Audience = proto.Field(
1743
+ proto.MESSAGE,
1744
+ number=28,
1745
+ oneof="resource",
1746
+ message=gaa_audience.Audience,
1747
+ )
1748
+ event_create_rule: event_create_and_edit.EventCreateRule = proto.Field(
1749
+ proto.MESSAGE,
1750
+ number=29,
1751
+ oneof="resource",
1752
+ message=event_create_and_edit.EventCreateRule,
1753
+ )
1754
+ calculated_metric: "CalculatedMetric" = proto.Field(
1755
+ proto.MESSAGE,
1756
+ number=31,
1757
+ oneof="resource",
1758
+ message="CalculatedMetric",
1759
+ )
1760
+ key_event: "KeyEvent" = proto.Field(
1761
+ proto.MESSAGE,
1762
+ number=32,
1763
+ oneof="resource",
1764
+ message="KeyEvent",
1765
+ )
1766
+
1767
+ resource: str = proto.Field(
1768
+ proto.STRING,
1769
+ number=1,
1770
+ )
1771
+ action: "ActionType" = proto.Field(
1772
+ proto.ENUM,
1773
+ number=2,
1774
+ enum="ActionType",
1775
+ )
1776
+ resource_before_change: ChangeHistoryResource = proto.Field(
1777
+ proto.MESSAGE,
1778
+ number=3,
1779
+ message=ChangeHistoryResource,
1780
+ )
1781
+ resource_after_change: ChangeHistoryResource = proto.Field(
1782
+ proto.MESSAGE,
1783
+ number=4,
1784
+ message=ChangeHistoryResource,
1785
+ )
1786
+
1787
+
1788
+ class DisplayVideo360AdvertiserLink(proto.Message):
1789
+ r"""A link between a Google Analytics property and a Display &
1790
+ Video 360 advertiser.
1791
+
1792
+ Attributes:
1793
+ name (str):
1794
+ Output only. The resource name for this
1795
+ DisplayVideo360AdvertiserLink resource. Format:
1796
+
1797
+ properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId}
1798
+
1799
+ Note: linkId is not the Display & Video 360
1800
+ Advertiser ID
1801
+ advertiser_id (str):
1802
+ Immutable. The Display & Video 360
1803
+ Advertiser's advertiser ID.
1804
+ advertiser_display_name (str):
1805
+ Output only. The display name of the Display
1806
+ & Video 360 Advertiser.
1807
+ ads_personalization_enabled (google.protobuf.wrappers_pb2.BoolValue):
1808
+ Enables personalized advertising features
1809
+ with this integration. If this field is not set
1810
+ on create/update, it will be defaulted to true.
1811
+ campaign_data_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1812
+ Immutable. Enables the import of campaign
1813
+ data from Display & Video 360 into the Google
1814
+ Analytics property. After link creation, this
1815
+ can only be updated from the Display & Video 360
1816
+ product. If this field is not set on create, it
1817
+ will be defaulted to true.
1818
+ cost_data_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1819
+ Immutable. Enables the import of cost data from Display &
1820
+ Video 360 into the Google Analytics property. This can only
1821
+ be enabled if ``campaign_data_sharing_enabled`` is true.
1822
+ After link creation, this can only be updated from the
1823
+ Display & Video 360 product. If this field is not set on
1824
+ create, it will be defaulted to true.
1825
+ """
1826
+
1827
+ name: str = proto.Field(
1828
+ proto.STRING,
1829
+ number=1,
1830
+ )
1831
+ advertiser_id: str = proto.Field(
1832
+ proto.STRING,
1833
+ number=2,
1834
+ )
1835
+ advertiser_display_name: str = proto.Field(
1836
+ proto.STRING,
1837
+ number=3,
1838
+ )
1839
+ ads_personalization_enabled: wrappers_pb2.BoolValue = proto.Field(
1840
+ proto.MESSAGE,
1841
+ number=4,
1842
+ message=wrappers_pb2.BoolValue,
1843
+ )
1844
+ campaign_data_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
1845
+ proto.MESSAGE,
1846
+ number=5,
1847
+ message=wrappers_pb2.BoolValue,
1848
+ )
1849
+ cost_data_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
1850
+ proto.MESSAGE,
1851
+ number=6,
1852
+ message=wrappers_pb2.BoolValue,
1853
+ )
1854
+
1855
+
1856
+ class DisplayVideo360AdvertiserLinkProposal(proto.Message):
1857
+ r"""A proposal for a link between a Google Analytics property and
1858
+ a Display & Video 360 advertiser.
1859
+
1860
+ A proposal is converted to a DisplayVideo360AdvertiserLink once
1861
+ approved. Google Analytics admins approve inbound proposals
1862
+ while Display & Video 360 admins approve outbound proposals.
1863
+
1864
+ Attributes:
1865
+ name (str):
1866
+ Output only. The resource name for this
1867
+ DisplayVideo360AdvertiserLinkProposal resource.
1868
+ Format:
1869
+
1870
+ properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}
1871
+
1872
+ Note: proposalId is not the Display & Video 360
1873
+ Advertiser ID
1874
+ advertiser_id (str):
1875
+ Immutable. The Display & Video 360
1876
+ Advertiser's advertiser ID.
1877
+ link_proposal_status_details (google.analytics.admin_v1alpha.types.LinkProposalStatusDetails):
1878
+ Output only. The status information for this
1879
+ link proposal.
1880
+ advertiser_display_name (str):
1881
+ Output only. The display name of the Display
1882
+ & Video Advertiser. Only populated for proposals
1883
+ that originated from Display & Video 360.
1884
+ validation_email (str):
1885
+ Input only. On a proposal being sent to
1886
+ Display & Video 360, this field must be set to
1887
+ the email address of an admin on the target
1888
+ advertiser. This is used to verify that the
1889
+ Google Analytics admin is aware of at least one
1890
+ admin on the Display & Video 360 Advertiser.
1891
+ This does not restrict approval of the proposal
1892
+ to a single user. Any admin on the Display &
1893
+ Video 360 Advertiser may approve the proposal.
1894
+ ads_personalization_enabled (google.protobuf.wrappers_pb2.BoolValue):
1895
+ Immutable. Enables personalized advertising
1896
+ features with this integration. If this field is
1897
+ not set on create, it will be defaulted to true.
1898
+ campaign_data_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1899
+ Immutable. Enables the import of campaign
1900
+ data from Display & Video 360. If this field is
1901
+ not set on create, it will be defaulted to true.
1902
+ cost_data_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1903
+ Immutable. Enables the import of cost data from Display &
1904
+ Video 360. This can only be enabled if
1905
+ campaign_data_sharing_enabled is enabled. If this field is
1906
+ not set on create, it will be defaulted to true.
1907
+ """
1908
+
1909
+ name: str = proto.Field(
1910
+ proto.STRING,
1911
+ number=1,
1912
+ )
1913
+ advertiser_id: str = proto.Field(
1914
+ proto.STRING,
1915
+ number=2,
1916
+ )
1917
+ link_proposal_status_details: "LinkProposalStatusDetails" = proto.Field(
1918
+ proto.MESSAGE,
1919
+ number=3,
1920
+ message="LinkProposalStatusDetails",
1921
+ )
1922
+ advertiser_display_name: str = proto.Field(
1923
+ proto.STRING,
1924
+ number=4,
1925
+ )
1926
+ validation_email: str = proto.Field(
1927
+ proto.STRING,
1928
+ number=5,
1929
+ )
1930
+ ads_personalization_enabled: wrappers_pb2.BoolValue = proto.Field(
1931
+ proto.MESSAGE,
1932
+ number=6,
1933
+ message=wrappers_pb2.BoolValue,
1934
+ )
1935
+ campaign_data_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
1936
+ proto.MESSAGE,
1937
+ number=7,
1938
+ message=wrappers_pb2.BoolValue,
1939
+ )
1940
+ cost_data_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
1941
+ proto.MESSAGE,
1942
+ number=8,
1943
+ message=wrappers_pb2.BoolValue,
1944
+ )
1945
+
1946
+
1947
+ class SearchAds360Link(proto.Message):
1948
+ r"""A link between a Google Analytics property and a Search Ads
1949
+ 360 entity.
1950
+
1951
+ Attributes:
1952
+ name (str):
1953
+ Output only. The resource name for this
1954
+ SearchAds360Link resource. Format:
1955
+ properties/{propertyId}/searchAds360Links/{linkId}
1956
+
1957
+ Note: linkId is not the Search Ads 360
1958
+ advertiser ID
1959
+ advertiser_id (str):
1960
+ Immutable. This field represents the
1961
+ Advertiser ID of the Search Ads 360 Advertiser.
1962
+ that has been linked.
1963
+ campaign_data_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1964
+ Immutable. Enables the import of campaign
1965
+ data from Search Ads 360 into the Google
1966
+ Analytics property. After link creation, this
1967
+ can only be updated from the Search Ads 360
1968
+ product. If this field is not set on create, it
1969
+ will be defaulted to true.
1970
+ cost_data_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1971
+ Immutable. Enables the import of cost data from Search Ads
1972
+ 360 to the Google Analytics property. This can only be
1973
+ enabled if campaign_data_sharing_enabled is enabled. After
1974
+ link creation, this can only be updated from the Search Ads
1975
+ 360 product. If this field is not set on create, it will be
1976
+ defaulted to true.
1977
+ advertiser_display_name (str):
1978
+ Output only. The display name of the Search
1979
+ Ads 360 Advertiser. Allows users to easily
1980
+ identify the linked resource.
1981
+ ads_personalization_enabled (google.protobuf.wrappers_pb2.BoolValue):
1982
+ Enables personalized advertising features
1983
+ with this integration. If this field is not set
1984
+ on create, it will be defaulted to true.
1985
+ site_stats_sharing_enabled (google.protobuf.wrappers_pb2.BoolValue):
1986
+ Enables export of site stats with this
1987
+ integration. If this field is not set on create,
1988
+ it will be defaulted to true.
1989
+ """
1990
+
1991
+ name: str = proto.Field(
1992
+ proto.STRING,
1993
+ number=1,
1994
+ )
1995
+ advertiser_id: str = proto.Field(
1996
+ proto.STRING,
1997
+ number=2,
1998
+ )
1999
+ campaign_data_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
2000
+ proto.MESSAGE,
2001
+ number=3,
2002
+ message=wrappers_pb2.BoolValue,
2003
+ )
2004
+ cost_data_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
2005
+ proto.MESSAGE,
2006
+ number=4,
2007
+ message=wrappers_pb2.BoolValue,
2008
+ )
2009
+ advertiser_display_name: str = proto.Field(
2010
+ proto.STRING,
2011
+ number=5,
2012
+ )
2013
+ ads_personalization_enabled: wrappers_pb2.BoolValue = proto.Field(
2014
+ proto.MESSAGE,
2015
+ number=6,
2016
+ message=wrappers_pb2.BoolValue,
2017
+ )
2018
+ site_stats_sharing_enabled: wrappers_pb2.BoolValue = proto.Field(
2019
+ proto.MESSAGE,
2020
+ number=7,
2021
+ message=wrappers_pb2.BoolValue,
2022
+ )
2023
+
2024
+
2025
+ class LinkProposalStatusDetails(proto.Message):
2026
+ r"""Status information for a link proposal.
2027
+
2028
+ Attributes:
2029
+ link_proposal_initiating_product (google.analytics.admin_v1alpha.types.LinkProposalInitiatingProduct):
2030
+ Output only. The source of this proposal.
2031
+ requestor_email (str):
2032
+ Output only. The email address of the user
2033
+ that proposed this linkage.
2034
+ link_proposal_state (google.analytics.admin_v1alpha.types.LinkProposalState):
2035
+ Output only. The state of this proposal.
2036
+ """
2037
+
2038
+ link_proposal_initiating_product: "LinkProposalInitiatingProduct" = proto.Field(
2039
+ proto.ENUM,
2040
+ number=1,
2041
+ enum="LinkProposalInitiatingProduct",
2042
+ )
2043
+ requestor_email: str = proto.Field(
2044
+ proto.STRING,
2045
+ number=2,
2046
+ )
2047
+ link_proposal_state: "LinkProposalState" = proto.Field(
2048
+ proto.ENUM,
2049
+ number=3,
2050
+ enum="LinkProposalState",
2051
+ )
2052
+
2053
+
2054
+ class ConversionEvent(proto.Message):
2055
+ r"""A conversion event in a Google Analytics property.
2056
+
2057
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2058
+
2059
+ Attributes:
2060
+ name (str):
2061
+ Output only. Resource name of this conversion event. Format:
2062
+ properties/{property}/conversionEvents/{conversion_event}
2063
+ event_name (str):
2064
+ Immutable. The event name for this conversion
2065
+ event. Examples: 'click', 'purchase'
2066
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
2067
+ Output only. Time when this conversion event
2068
+ was created in the property.
2069
+ deletable (bool):
2070
+ Output only. If set, this event can currently
2071
+ be deleted with DeleteConversionEvent.
2072
+ custom (bool):
2073
+ Output only. If set to true, this conversion
2074
+ event refers to a custom event. If set to
2075
+ false, this conversion event refers to a default
2076
+ event in GA. Default events typically have
2077
+ special meaning in GA. Default events are
2078
+ usually created for you by the GA system, but in
2079
+ some cases can be created by property admins.
2080
+ Custom events count towards the maximum number
2081
+ of custom conversion events that may be created
2082
+ per property.
2083
+ counting_method (google.analytics.admin_v1alpha.types.ConversionEvent.ConversionCountingMethod):
2084
+ Optional. The method by which conversions will be counted
2085
+ across multiple events within a session. If this value is
2086
+ not provided, it will be set to ``ONCE_PER_EVENT``.
2087
+ default_conversion_value (google.analytics.admin_v1alpha.types.ConversionEvent.DefaultConversionValue):
2088
+ Optional. Defines a default value/currency
2089
+ for a conversion event.
2090
+
2091
+ This field is a member of `oneof`_ ``_default_conversion_value``.
2092
+ """
2093
+
2094
+ class ConversionCountingMethod(proto.Enum):
2095
+ r"""The method by which conversions will be counted across
2096
+ multiple events within a session.
2097
+
2098
+ Values:
2099
+ CONVERSION_COUNTING_METHOD_UNSPECIFIED (0):
2100
+ Counting method not specified.
2101
+ ONCE_PER_EVENT (1):
2102
+ Each Event instance is considered a
2103
+ Conversion.
2104
+ ONCE_PER_SESSION (2):
2105
+ An Event instance is considered a Conversion
2106
+ at most once per session per user.
2107
+ """
2108
+ CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0
2109
+ ONCE_PER_EVENT = 1
2110
+ ONCE_PER_SESSION = 2
2111
+
2112
+ class DefaultConversionValue(proto.Message):
2113
+ r"""Defines a default value/currency for a conversion event. Both
2114
+ value and currency must be provided.
2115
+
2116
+
2117
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2118
+
2119
+ Attributes:
2120
+ value (float):
2121
+ This value will be used to populate the value for all
2122
+ conversions of the specified event_name where the event
2123
+ "value" parameter is unset.
2124
+
2125
+ This field is a member of `oneof`_ ``_value``.
2126
+ currency_code (str):
2127
+ When a conversion event for this event_name has no set
2128
+ currency, this currency will be applied as the default. Must
2129
+ be in ISO 4217 currency code format. See
2130
+ https://en.wikipedia.org/wiki/ISO_4217 for more information.
2131
+
2132
+ This field is a member of `oneof`_ ``_currency_code``.
2133
+ """
2134
+
2135
+ value: float = proto.Field(
2136
+ proto.DOUBLE,
2137
+ number=1,
2138
+ optional=True,
2139
+ )
2140
+ currency_code: str = proto.Field(
2141
+ proto.STRING,
2142
+ number=2,
2143
+ optional=True,
2144
+ )
2145
+
2146
+ name: str = proto.Field(
2147
+ proto.STRING,
2148
+ number=1,
2149
+ )
2150
+ event_name: str = proto.Field(
2151
+ proto.STRING,
2152
+ number=2,
2153
+ )
2154
+ create_time: timestamp_pb2.Timestamp = proto.Field(
2155
+ proto.MESSAGE,
2156
+ number=3,
2157
+ message=timestamp_pb2.Timestamp,
2158
+ )
2159
+ deletable: bool = proto.Field(
2160
+ proto.BOOL,
2161
+ number=4,
2162
+ )
2163
+ custom: bool = proto.Field(
2164
+ proto.BOOL,
2165
+ number=5,
2166
+ )
2167
+ counting_method: ConversionCountingMethod = proto.Field(
2168
+ proto.ENUM,
2169
+ number=6,
2170
+ enum=ConversionCountingMethod,
2171
+ )
2172
+ default_conversion_value: DefaultConversionValue = proto.Field(
2173
+ proto.MESSAGE,
2174
+ number=7,
2175
+ optional=True,
2176
+ message=DefaultConversionValue,
2177
+ )
2178
+
2179
+
2180
+ class KeyEvent(proto.Message):
2181
+ r"""A key event in a Google Analytics property.
2182
+
2183
+ Attributes:
2184
+ name (str):
2185
+ Output only. Resource name of this key event. Format:
2186
+ properties/{property}/keyEvents/{key_event}
2187
+ event_name (str):
2188
+ Immutable. The event name for this key event.
2189
+ Examples: 'click', 'purchase'
2190
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
2191
+ Output only. Time when this key event was
2192
+ created in the property.
2193
+ deletable (bool):
2194
+ Output only. If set to true, this event can
2195
+ be deleted.
2196
+ custom (bool):
2197
+ Output only. If set to true, this key event
2198
+ refers to a custom event. If set to false, this
2199
+ key event refers to a default event in GA.
2200
+ Default events typically have special meaning in
2201
+ GA. Default events are usually created for you
2202
+ by the GA system, but in some cases can be
2203
+ created by property admins. Custom events count
2204
+ towards the maximum number of custom key events
2205
+ that may be created per property.
2206
+ counting_method (google.analytics.admin_v1alpha.types.KeyEvent.CountingMethod):
2207
+ Required. The method by which Key Events will
2208
+ be counted across multiple events within a
2209
+ session.
2210
+ default_value (google.analytics.admin_v1alpha.types.KeyEvent.DefaultValue):
2211
+ Optional. Defines a default value/currency
2212
+ for a key event.
2213
+ """
2214
+
2215
+ class CountingMethod(proto.Enum):
2216
+ r"""The method by which Key Events will be counted across
2217
+ multiple events within a session.
2218
+
2219
+ Values:
2220
+ COUNTING_METHOD_UNSPECIFIED (0):
2221
+ Counting method not specified.
2222
+ ONCE_PER_EVENT (1):
2223
+ Each Event instance is considered a Key
2224
+ Event.
2225
+ ONCE_PER_SESSION (2):
2226
+ An Event instance is considered a Key Event
2227
+ at most once per session per user.
2228
+ """
2229
+ COUNTING_METHOD_UNSPECIFIED = 0
2230
+ ONCE_PER_EVENT = 1
2231
+ ONCE_PER_SESSION = 2
2232
+
2233
+ class DefaultValue(proto.Message):
2234
+ r"""Defines a default value/currency for a key event.
2235
+
2236
+ Attributes:
2237
+ numeric_value (float):
2238
+ Required. This will be used to populate the "value"
2239
+ parameter for all occurrences of this Key Event (specified
2240
+ by event_name) where that parameter is unset.
2241
+ currency_code (str):
2242
+ Required. When an occurrence of this Key Event (specified by
2243
+ event_name) has no set currency this currency will be
2244
+ applied as the default. Must be in ISO 4217 currency code
2245
+ format.
2246
+
2247
+ See https://en.wikipedia.org/wiki/ISO_4217 for more
2248
+ information.
2249
+ """
2250
+
2251
+ numeric_value: float = proto.Field(
2252
+ proto.DOUBLE,
2253
+ number=1,
2254
+ )
2255
+ currency_code: str = proto.Field(
2256
+ proto.STRING,
2257
+ number=2,
2258
+ )
2259
+
2260
+ name: str = proto.Field(
2261
+ proto.STRING,
2262
+ number=1,
2263
+ )
2264
+ event_name: str = proto.Field(
2265
+ proto.STRING,
2266
+ number=2,
2267
+ )
2268
+ create_time: timestamp_pb2.Timestamp = proto.Field(
2269
+ proto.MESSAGE,
2270
+ number=3,
2271
+ message=timestamp_pb2.Timestamp,
2272
+ )
2273
+ deletable: bool = proto.Field(
2274
+ proto.BOOL,
2275
+ number=4,
2276
+ )
2277
+ custom: bool = proto.Field(
2278
+ proto.BOOL,
2279
+ number=5,
2280
+ )
2281
+ counting_method: CountingMethod = proto.Field(
2282
+ proto.ENUM,
2283
+ number=6,
2284
+ enum=CountingMethod,
2285
+ )
2286
+ default_value: DefaultValue = proto.Field(
2287
+ proto.MESSAGE,
2288
+ number=7,
2289
+ message=DefaultValue,
2290
+ )
2291
+
2292
+
2293
+ class GoogleSignalsSettings(proto.Message):
2294
+ r"""Settings values for Google Signals. This is a singleton
2295
+ resource.
2296
+
2297
+ Attributes:
2298
+ name (str):
2299
+ Output only. Resource name of this setting. Format:
2300
+ properties/{property_id}/googleSignalsSettings Example:
2301
+ "properties/1000/googleSignalsSettings".
2302
+ state (google.analytics.admin_v1alpha.types.GoogleSignalsState):
2303
+ Status of this setting.
2304
+ consent (google.analytics.admin_v1alpha.types.GoogleSignalsConsent):
2305
+ Output only. Terms of Service acceptance.
2306
+ """
2307
+
2308
+ name: str = proto.Field(
2309
+ proto.STRING,
2310
+ number=1,
2311
+ )
2312
+ state: "GoogleSignalsState" = proto.Field(
2313
+ proto.ENUM,
2314
+ number=3,
2315
+ enum="GoogleSignalsState",
2316
+ )
2317
+ consent: "GoogleSignalsConsent" = proto.Field(
2318
+ proto.ENUM,
2319
+ number=4,
2320
+ enum="GoogleSignalsConsent",
2321
+ )
2322
+
2323
+
2324
+ class CustomDimension(proto.Message):
2325
+ r"""A definition for a CustomDimension.
2326
+
2327
+ Attributes:
2328
+ name (str):
2329
+ Output only. Resource name for this
2330
+ CustomDimension resource. Format:
2331
+ properties/{property}/customDimensions/{customDimension}
2332
+ parameter_name (str):
2333
+ Required. Immutable. Tagging parameter name
2334
+ for this custom dimension.
2335
+ If this is a user-scoped dimension, then this is
2336
+ the user property name. If this is an
2337
+ event-scoped dimension, then this is the event
2338
+ parameter name.
2339
+
2340
+ If this is an item-scoped dimension, then this
2341
+ is the parameter name found in the eCommerce
2342
+ items array.
2343
+
2344
+ May only contain alphanumeric and underscore
2345
+ characters, starting with a letter. Max length
2346
+ of 24 characters for user-scoped dimensions, 40
2347
+ characters for event-scoped dimensions.
2348
+ display_name (str):
2349
+ Required. Display name for this custom
2350
+ dimension as shown in the Analytics UI. Max
2351
+ length of 82 characters, alphanumeric plus space
2352
+ and underscore starting with a letter. Legacy
2353
+ system-generated display names may contain
2354
+ square brackets, but updates to this field will
2355
+ never permit square brackets.
2356
+ description (str):
2357
+ Optional. Description for this custom
2358
+ dimension. Max length of 150 characters.
2359
+ scope (google.analytics.admin_v1alpha.types.CustomDimension.DimensionScope):
2360
+ Required. Immutable. The scope of this
2361
+ dimension.
2362
+ disallow_ads_personalization (bool):
2363
+ Optional. If set to true, sets this dimension
2364
+ as NPA and excludes it from ads personalization.
2365
+
2366
+ This is currently only supported by user-scoped
2367
+ custom dimensions.
2368
+ """
2369
+
2370
+ class DimensionScope(proto.Enum):
2371
+ r"""Valid values for the scope of this dimension.
2372
+
2373
+ Values:
2374
+ DIMENSION_SCOPE_UNSPECIFIED (0):
2375
+ Scope unknown or not specified.
2376
+ EVENT (1):
2377
+ Dimension scoped to an event.
2378
+ USER (2):
2379
+ Dimension scoped to a user.
2380
+ ITEM (3):
2381
+ Dimension scoped to eCommerce items
2382
+ """
2383
+ DIMENSION_SCOPE_UNSPECIFIED = 0
2384
+ EVENT = 1
2385
+ USER = 2
2386
+ ITEM = 3
2387
+
2388
+ name: str = proto.Field(
2389
+ proto.STRING,
2390
+ number=1,
2391
+ )
2392
+ parameter_name: str = proto.Field(
2393
+ proto.STRING,
2394
+ number=2,
2395
+ )
2396
+ display_name: str = proto.Field(
2397
+ proto.STRING,
2398
+ number=3,
2399
+ )
2400
+ description: str = proto.Field(
2401
+ proto.STRING,
2402
+ number=4,
2403
+ )
2404
+ scope: DimensionScope = proto.Field(
2405
+ proto.ENUM,
2406
+ number=5,
2407
+ enum=DimensionScope,
2408
+ )
2409
+ disallow_ads_personalization: bool = proto.Field(
2410
+ proto.BOOL,
2411
+ number=6,
2412
+ )
2413
+
2414
+
2415
+ class CustomMetric(proto.Message):
2416
+ r"""A definition for a custom metric.
2417
+
2418
+ Attributes:
2419
+ name (str):
2420
+ Output only. Resource name for this
2421
+ CustomMetric resource. Format:
2422
+ properties/{property}/customMetrics/{customMetric}
2423
+ parameter_name (str):
2424
+ Required. Immutable. Tagging name for this
2425
+ custom metric.
2426
+ If this is an event-scoped metric, then this is
2427
+ the event parameter name.
2428
+
2429
+ May only contain alphanumeric and underscore
2430
+ charactes, starting with a letter. Max length of
2431
+ 40 characters for event-scoped metrics.
2432
+ display_name (str):
2433
+ Required. Display name for this custom metric
2434
+ as shown in the Analytics UI. Max length of 82
2435
+ characters, alphanumeric plus space and
2436
+ underscore starting with a letter. Legacy
2437
+ system-generated display names may contain
2438
+ square brackets, but updates to this field will
2439
+ never permit square brackets.
2440
+ description (str):
2441
+ Optional. Description for this custom
2442
+ dimension. Max length of 150 characters.
2443
+ measurement_unit (google.analytics.admin_v1alpha.types.CustomMetric.MeasurementUnit):
2444
+ Required. The type for the custom metric's
2445
+ value.
2446
+ scope (google.analytics.admin_v1alpha.types.CustomMetric.MetricScope):
2447
+ Required. Immutable. The scope of this custom
2448
+ metric.
2449
+ restricted_metric_type (MutableSequence[google.analytics.admin_v1alpha.types.CustomMetric.RestrictedMetricType]):
2450
+ Optional. Types of restricted data that this
2451
+ metric may contain. Required for metrics with
2452
+ CURRENCY measurement unit. Must be empty for
2453
+ metrics with a non-CURRENCY measurement unit.
2454
+ """
2455
+
2456
+ class MeasurementUnit(proto.Enum):
2457
+ r"""Possible types of representing the custom metric's value.
2458
+
2459
+ Currency representation may change in the future, requiring a
2460
+ breaking API change.
2461
+
2462
+ Values:
2463
+ MEASUREMENT_UNIT_UNSPECIFIED (0):
2464
+ MeasurementUnit unspecified or missing.
2465
+ STANDARD (1):
2466
+ This metric uses default units.
2467
+ CURRENCY (2):
2468
+ This metric measures a currency.
2469
+ FEET (3):
2470
+ This metric measures feet.
2471
+ METERS (4):
2472
+ This metric measures meters.
2473
+ KILOMETERS (5):
2474
+ This metric measures kilometers.
2475
+ MILES (6):
2476
+ This metric measures miles.
2477
+ MILLISECONDS (7):
2478
+ This metric measures milliseconds.
2479
+ SECONDS (8):
2480
+ This metric measures seconds.
2481
+ MINUTES (9):
2482
+ This metric measures minutes.
2483
+ HOURS (10):
2484
+ This metric measures hours.
2485
+ """
2486
+ MEASUREMENT_UNIT_UNSPECIFIED = 0
2487
+ STANDARD = 1
2488
+ CURRENCY = 2
2489
+ FEET = 3
2490
+ METERS = 4
2491
+ KILOMETERS = 5
2492
+ MILES = 6
2493
+ MILLISECONDS = 7
2494
+ SECONDS = 8
2495
+ MINUTES = 9
2496
+ HOURS = 10
2497
+
2498
+ class MetricScope(proto.Enum):
2499
+ r"""The scope of this metric.
2500
+
2501
+ Values:
2502
+ METRIC_SCOPE_UNSPECIFIED (0):
2503
+ Scope unknown or not specified.
2504
+ EVENT (1):
2505
+ Metric scoped to an event.
2506
+ """
2507
+ METRIC_SCOPE_UNSPECIFIED = 0
2508
+ EVENT = 1
2509
+
2510
+ class RestrictedMetricType(proto.Enum):
2511
+ r"""Labels that mark the data in this custom metric as data that
2512
+ should be restricted to specific users.
2513
+
2514
+ Values:
2515
+ RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):
2516
+ Type unknown or unspecified.
2517
+ COST_DATA (1):
2518
+ Metric reports cost data.
2519
+ REVENUE_DATA (2):
2520
+ Metric reports revenue data.
2521
+ """
2522
+ RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0
2523
+ COST_DATA = 1
2524
+ REVENUE_DATA = 2
2525
+
2526
+ name: str = proto.Field(
2527
+ proto.STRING,
2528
+ number=1,
2529
+ )
2530
+ parameter_name: str = proto.Field(
2531
+ proto.STRING,
2532
+ number=2,
2533
+ )
2534
+ display_name: str = proto.Field(
2535
+ proto.STRING,
2536
+ number=3,
2537
+ )
2538
+ description: str = proto.Field(
2539
+ proto.STRING,
2540
+ number=4,
2541
+ )
2542
+ measurement_unit: MeasurementUnit = proto.Field(
2543
+ proto.ENUM,
2544
+ number=5,
2545
+ enum=MeasurementUnit,
2546
+ )
2547
+ scope: MetricScope = proto.Field(
2548
+ proto.ENUM,
2549
+ number=6,
2550
+ enum=MetricScope,
2551
+ )
2552
+ restricted_metric_type: MutableSequence[RestrictedMetricType] = proto.RepeatedField(
2553
+ proto.ENUM,
2554
+ number=8,
2555
+ enum=RestrictedMetricType,
2556
+ )
2557
+
2558
+
2559
+ class CalculatedMetric(proto.Message):
2560
+ r"""A definition for a calculated metric.
2561
+
2562
+ Attributes:
2563
+ name (str):
2564
+ Output only. Resource name for this CalculatedMetric.
2565
+ Format:
2566
+ 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
2567
+ description (str):
2568
+ Optional. Description for this calculated
2569
+ metric. Max length of 4096 characters.
2570
+ display_name (str):
2571
+ Required. Display name for this calculated
2572
+ metric as shown in the Google Analytics UI. Max
2573
+ length 82 characters.
2574
+ calculated_metric_id (str):
2575
+ Output only. The ID to use for the calculated metric. In the
2576
+ UI, this is referred to as the "API name."
2577
+
2578
+ The calculated_metric_id is used when referencing this
2579
+ calculated metric from external APIs. For example,
2580
+ "calcMetric:{calculated_metric_id}".
2581
+ metric_unit (google.analytics.admin_v1alpha.types.CalculatedMetric.MetricUnit):
2582
+ Required. The type for the calculated
2583
+ metric's value.
2584
+ restricted_metric_type (MutableSequence[google.analytics.admin_v1alpha.types.CalculatedMetric.RestrictedMetricType]):
2585
+ Output only. Types of restricted data that
2586
+ this metric contains.
2587
+ formula (str):
2588
+ Required. The calculated metric's definition. Maximum number
2589
+ of unique referenced custom metrics is 5. Formulas supports
2590
+ the following operations:
2591
+
2592
+ - (addition), - (subtraction), - (negative), \*
2593
+ (multiplication), / (division), () (parenthesis). Any
2594
+ valid real numbers are acceptable that fit in a Long
2595
+ (64bit integer) or a Double (64 bit floating point
2596
+ number). Example formula: "( customEvent:parameter_name +
2597
+ cartPurchaseQuantity ) / 2.0".
2598
+ invalid_metric_reference (bool):
2599
+ Output only. If true, this calculated metric has a invalid
2600
+ metric reference. Anything using a calculated metric with
2601
+ invalid_metric_reference set to true may fail, produce
2602
+ warnings, or produce unexpected results.
2603
+ """
2604
+
2605
+ class MetricUnit(proto.Enum):
2606
+ r"""Possible types of representing the calculated metric's value.
2607
+
2608
+ Values:
2609
+ METRIC_UNIT_UNSPECIFIED (0):
2610
+ MetricUnit unspecified or missing.
2611
+ STANDARD (1):
2612
+ This metric uses default units.
2613
+ CURRENCY (2):
2614
+ This metric measures a currency.
2615
+ FEET (3):
2616
+ This metric measures feet.
2617
+ MILES (4):
2618
+ This metric measures miles.
2619
+ METERS (5):
2620
+ This metric measures meters.
2621
+ KILOMETERS (6):
2622
+ This metric measures kilometers.
2623
+ MILLISECONDS (7):
2624
+ This metric measures milliseconds.
2625
+ SECONDS (8):
2626
+ This metric measures seconds.
2627
+ MINUTES (9):
2628
+ This metric measures minutes.
2629
+ HOURS (10):
2630
+ This metric measures hours.
2631
+ """
2632
+ METRIC_UNIT_UNSPECIFIED = 0
2633
+ STANDARD = 1
2634
+ CURRENCY = 2
2635
+ FEET = 3
2636
+ MILES = 4
2637
+ METERS = 5
2638
+ KILOMETERS = 6
2639
+ MILLISECONDS = 7
2640
+ SECONDS = 8
2641
+ MINUTES = 9
2642
+ HOURS = 10
2643
+
2644
+ class RestrictedMetricType(proto.Enum):
2645
+ r"""Labels that mark the data in calculated metric used in
2646
+ conjunction with user roles that restrict access to cost and/or
2647
+ revenue metrics.
2648
+
2649
+ Values:
2650
+ RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):
2651
+ Type unknown or unspecified.
2652
+ COST_DATA (1):
2653
+ Metric reports cost data.
2654
+ REVENUE_DATA (2):
2655
+ Metric reports revenue data.
2656
+ """
2657
+ RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0
2658
+ COST_DATA = 1
2659
+ REVENUE_DATA = 2
2660
+
2661
+ name: str = proto.Field(
2662
+ proto.STRING,
2663
+ number=1,
2664
+ )
2665
+ description: str = proto.Field(
2666
+ proto.STRING,
2667
+ number=2,
2668
+ )
2669
+ display_name: str = proto.Field(
2670
+ proto.STRING,
2671
+ number=3,
2672
+ )
2673
+ calculated_metric_id: str = proto.Field(
2674
+ proto.STRING,
2675
+ number=4,
2676
+ )
2677
+ metric_unit: MetricUnit = proto.Field(
2678
+ proto.ENUM,
2679
+ number=5,
2680
+ enum=MetricUnit,
2681
+ )
2682
+ restricted_metric_type: MutableSequence[RestrictedMetricType] = proto.RepeatedField(
2683
+ proto.ENUM,
2684
+ number=6,
2685
+ enum=RestrictedMetricType,
2686
+ )
2687
+ formula: str = proto.Field(
2688
+ proto.STRING,
2689
+ number=7,
2690
+ )
2691
+ invalid_metric_reference: bool = proto.Field(
2692
+ proto.BOOL,
2693
+ number=9,
2694
+ )
2695
+
2696
+
2697
+ class DataRetentionSettings(proto.Message):
2698
+ r"""Settings values for data retention. This is a singleton
2699
+ resource.
2700
+
2701
+ Attributes:
2702
+ name (str):
2703
+ Output only. Resource name for this
2704
+ DataRetentionSetting resource. Format:
2705
+ properties/{property}/dataRetentionSettings
2706
+ event_data_retention (google.analytics.admin_v1alpha.types.DataRetentionSettings.RetentionDuration):
2707
+ Required. The length of time that event-level
2708
+ data is retained.
2709
+ user_data_retention (google.analytics.admin_v1alpha.types.DataRetentionSettings.RetentionDuration):
2710
+ Required. The length of time that user-level
2711
+ data is retained.
2712
+ reset_user_data_on_new_activity (bool):
2713
+ If true, reset the retention period for the
2714
+ user identifier with every event from that user.
2715
+ """
2716
+
2717
+ class RetentionDuration(proto.Enum):
2718
+ r"""Valid values for the data retention duration.
2719
+
2720
+ Values:
2721
+ RETENTION_DURATION_UNSPECIFIED (0):
2722
+ Data retention time duration is not
2723
+ specified.
2724
+ TWO_MONTHS (1):
2725
+ The data retention time duration is 2 months.
2726
+ FOURTEEN_MONTHS (3):
2727
+ The data retention time duration is 14
2728
+ months.
2729
+ TWENTY_SIX_MONTHS (4):
2730
+ The data retention time duration is 26
2731
+ months. Available to 360 properties only.
2732
+ Available for event data only.
2733
+ THIRTY_EIGHT_MONTHS (5):
2734
+ The data retention time duration is 38
2735
+ months. Available to 360 properties only.
2736
+ Available for event data only.
2737
+ FIFTY_MONTHS (6):
2738
+ The data retention time duration is 50
2739
+ months. Available to 360 properties only.
2740
+ Available for event data only.
2741
+ """
2742
+ RETENTION_DURATION_UNSPECIFIED = 0
2743
+ TWO_MONTHS = 1
2744
+ FOURTEEN_MONTHS = 3
2745
+ TWENTY_SIX_MONTHS = 4
2746
+ THIRTY_EIGHT_MONTHS = 5
2747
+ FIFTY_MONTHS = 6
2748
+
2749
+ name: str = proto.Field(
2750
+ proto.STRING,
2751
+ number=1,
2752
+ )
2753
+ event_data_retention: RetentionDuration = proto.Field(
2754
+ proto.ENUM,
2755
+ number=2,
2756
+ enum=RetentionDuration,
2757
+ )
2758
+ user_data_retention: RetentionDuration = proto.Field(
2759
+ proto.ENUM,
2760
+ number=4,
2761
+ enum=RetentionDuration,
2762
+ )
2763
+ reset_user_data_on_new_activity: bool = proto.Field(
2764
+ proto.BOOL,
2765
+ number=3,
2766
+ )
2767
+
2768
+
2769
+ class AttributionSettings(proto.Message):
2770
+ r"""The attribution settings used for a given property. This is a
2771
+ singleton resource.
2772
+
2773
+ Attributes:
2774
+ name (str):
2775
+ Output only. Resource name of this attribution settings
2776
+ resource. Format:
2777
+ properties/{property_id}/attributionSettings Example:
2778
+ "properties/1000/attributionSettings".
2779
+ acquisition_conversion_event_lookback_window (google.analytics.admin_v1alpha.types.AttributionSettings.AcquisitionConversionEventLookbackWindow):
2780
+ Required. The lookback window configuration
2781
+ for acquisition conversion events. The default
2782
+ window size is 30 days.
2783
+ other_conversion_event_lookback_window (google.analytics.admin_v1alpha.types.AttributionSettings.OtherConversionEventLookbackWindow):
2784
+ Required. The lookback window for all other,
2785
+ non-acquisition conversion events. The default
2786
+ window size is 90 days.
2787
+ reporting_attribution_model (google.analytics.admin_v1alpha.types.AttributionSettings.ReportingAttributionModel):
2788
+ Required. The reporting attribution model
2789
+ used to calculate conversion credit in this
2790
+ property's reports.
2791
+
2792
+ Changing the attribution model will apply to
2793
+ both historical and future data. These changes
2794
+ will be reflected in reports with conversion and
2795
+ revenue data. User and session data will be
2796
+ unaffected.
2797
+ ads_web_conversion_data_export_scope (google.analytics.admin_v1alpha.types.AttributionSettings.AdsWebConversionDataExportScope):
2798
+ Required. The Conversion Export Scope for
2799
+ data exported to linked Ads Accounts.
2800
+ """
2801
+
2802
+ class AcquisitionConversionEventLookbackWindow(proto.Enum):
2803
+ r"""How far back in time events should be considered for
2804
+ inclusion in a converting path which leads to the first install
2805
+ of an app or the first visit to a site.
2806
+
2807
+ Values:
2808
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED (0):
2809
+ Lookback window size unspecified.
2810
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS (1):
2811
+ 7-day lookback window.
2812
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS (2):
2813
+ 30-day lookback window.
2814
+ """
2815
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0
2816
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS = 1
2817
+ ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 2
2818
+
2819
+ class OtherConversionEventLookbackWindow(proto.Enum):
2820
+ r"""How far back in time events should be considered for
2821
+ inclusion in a converting path for all conversions other than
2822
+ first app install/first site visit.
2823
+
2824
+ Values:
2825
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED (0):
2826
+ Lookback window size unspecified.
2827
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS (1):
2828
+ 30-day lookback window.
2829
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS (2):
2830
+ 60-day lookback window.
2831
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS (3):
2832
+ 90-day lookback window.
2833
+ """
2834
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0
2835
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 1
2836
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS = 2
2837
+ OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS = 3
2838
+
2839
+ class ReportingAttributionModel(proto.Enum):
2840
+ r"""The reporting attribution model used to calculate conversion
2841
+ credit in this property's reports.
2842
+
2843
+ Values:
2844
+ REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED (0):
2845
+ Reporting attribution model unspecified.
2846
+ PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN (1):
2847
+ Data-driven attribution distributes credit for the
2848
+ conversion based on data for each conversion event. Each
2849
+ Data-driven model is specific to each advertiser and each
2850
+ conversion event. Previously CROSS_CHANNEL_DATA_DRIVEN
2851
+ PAID_AND_ORGANIC_CHANNELS_LAST_CLICK (2):
2852
+ Ignores direct traffic and attributes 100% of the conversion
2853
+ value to the last channel that the customer clicked through
2854
+ (or engaged view through for YouTube) before converting.
2855
+ Previously CROSS_CHANNEL_LAST_CLICK
2856
+ GOOGLE_PAID_CHANNELS_LAST_CLICK (7):
2857
+ Attributes 100% of the conversion value to the last Google
2858
+ Paid channel that the customer clicked through before
2859
+ converting. Previously ADS_PREFERRED_LAST_CLICK
2860
+ """
2861
+ REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED = 0
2862
+ PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN = 1
2863
+ PAID_AND_ORGANIC_CHANNELS_LAST_CLICK = 2
2864
+ GOOGLE_PAID_CHANNELS_LAST_CLICK = 7
2865
+
2866
+ class AdsWebConversionDataExportScope(proto.Enum):
2867
+ r"""The Conversion Export Scope for data exported to linked Ads
2868
+ Accounts.
2869
+
2870
+ Values:
2871
+ ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED (0):
2872
+ Default value. This value is unused.
2873
+ NOT_SELECTED_YET (1):
2874
+ No data export scope selected yet.
2875
+ Export scope can never be changed back to this
2876
+ value.
2877
+ PAID_AND_ORGANIC_CHANNELS (2):
2878
+ Paid and organic channels are eligible to receive conversion
2879
+ credit, but only credit assigned to Google Ads channels will
2880
+ appear in your Ads accounts. To learn more, see `Paid and
2881
+ Organic
2882
+ channels <https://support.google.com/analytics/answer/10632359>`__.
2883
+ GOOGLE_PAID_CHANNELS (3):
2884
+ Only Google Ads paid channels are eligible to receive
2885
+ conversion credit. To learn more, see `Google Paid
2886
+ channels <https://support.google.com/analytics/answer/10632359>`__.
2887
+ """
2888
+ ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED = 0
2889
+ NOT_SELECTED_YET = 1
2890
+ PAID_AND_ORGANIC_CHANNELS = 2
2891
+ GOOGLE_PAID_CHANNELS = 3
2892
+
2893
+ name: str = proto.Field(
2894
+ proto.STRING,
2895
+ number=1,
2896
+ )
2897
+ acquisition_conversion_event_lookback_window: AcquisitionConversionEventLookbackWindow = proto.Field(
2898
+ proto.ENUM,
2899
+ number=2,
2900
+ enum=AcquisitionConversionEventLookbackWindow,
2901
+ )
2902
+ other_conversion_event_lookback_window: OtherConversionEventLookbackWindow = (
2903
+ proto.Field(
2904
+ proto.ENUM,
2905
+ number=3,
2906
+ enum=OtherConversionEventLookbackWindow,
2907
+ )
2908
+ )
2909
+ reporting_attribution_model: ReportingAttributionModel = proto.Field(
2910
+ proto.ENUM,
2911
+ number=4,
2912
+ enum=ReportingAttributionModel,
2913
+ )
2914
+ ads_web_conversion_data_export_scope: AdsWebConversionDataExportScope = proto.Field(
2915
+ proto.ENUM,
2916
+ number=5,
2917
+ enum=AdsWebConversionDataExportScope,
2918
+ )
2919
+
2920
+
2921
+ class AccessBinding(proto.Message):
2922
+ r"""A binding of a user to a set of roles.
2923
+
2924
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
2925
+
2926
+ Attributes:
2927
+ user (str):
2928
+ If set, the email address of the user to set
2929
+ roles for. Format: "someuser@gmail.com".
2930
+
2931
+ This field is a member of `oneof`_ ``access_target``.
2932
+ name (str):
2933
+ Output only. Resource name of this binding.
2934
+
2935
+ Format: accounts/{account}/accessBindings/{access_binding}
2936
+ or properties/{property}/accessBindings/{access_binding}
2937
+
2938
+ Example: "accounts/100/accessBindings/200".
2939
+ roles (MutableSequence[str]):
2940
+ A list of roles for to grant to the parent
2941
+ resource.
2942
+ Valid values:
2943
+
2944
+ predefinedRoles/viewer
2945
+ predefinedRoles/analyst
2946
+ predefinedRoles/editor
2947
+ predefinedRoles/admin
2948
+ predefinedRoles/no-cost-data
2949
+ predefinedRoles/no-revenue-data
2950
+
2951
+ For users, if an empty list of roles is set,
2952
+ this AccessBinding will be deleted.
2953
+ """
2954
+
2955
+ user: str = proto.Field(
2956
+ proto.STRING,
2957
+ number=2,
2958
+ oneof="access_target",
2959
+ )
2960
+ name: str = proto.Field(
2961
+ proto.STRING,
2962
+ number=1,
2963
+ )
2964
+ roles: MutableSequence[str] = proto.RepeatedField(
2965
+ proto.STRING,
2966
+ number=3,
2967
+ )
2968
+
2969
+
2970
+ class BigQueryLink(proto.Message):
2971
+ r"""A link between a Google Analytics property and BigQuery
2972
+ project.
2973
+
2974
+ Attributes:
2975
+ name (str):
2976
+ Output only. Resource name of this BigQuery link. Format:
2977
+ 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}'
2978
+ Format: 'properties/1234/bigQueryLinks/abc567'
2979
+ project (str):
2980
+ Immutable. The linked Google Cloud project.
2981
+ When creating a BigQueryLink, you may provide
2982
+ this resource name using either a project number
2983
+ or project ID. Once this resource has been
2984
+ created, the returned project will always have a
2985
+ project that contains a project number. Format:
2986
+ 'projects/{project number}'
2987
+ Example: 'projects/1234'
2988
+ create_time (google.protobuf.timestamp_pb2.Timestamp):
2989
+ Output only. Time when the link was created.
2990
+ daily_export_enabled (bool):
2991
+ If set true, enables daily data export to the
2992
+ linked Google Cloud project.
2993
+ streaming_export_enabled (bool):
2994
+ If set true, enables streaming export to the
2995
+ linked Google Cloud project.
2996
+ fresh_daily_export_enabled (bool):
2997
+ If set true, enables fresh daily export to
2998
+ the linked Google Cloud project.
2999
+ include_advertising_id (bool):
3000
+ If set true, exported data will include
3001
+ advertising identifiers for mobile app streams.
3002
+ export_streams (MutableSequence[str]):
3003
+ The list of streams under the parent property for which data
3004
+ will be exported. Format:
3005
+ properties/{property_id}/dataStreams/{stream_id} Example:
3006
+ ['properties/1000/dataStreams/2000']
3007
+ excluded_events (MutableSequence[str]):
3008
+ The list of event names that will be excluded
3009
+ from exports.
3010
+ dataset_location (str):
3011
+ Required. Immutable. The geographic location
3012
+ where the created BigQuery dataset should
3013
+ reside. See
3014
+ https://cloud.google.com/bigquery/docs/locations
3015
+ for supported locations.
3016
+ """
3017
+
3018
+ name: str = proto.Field(
3019
+ proto.STRING,
3020
+ number=1,
3021
+ )
3022
+ project: str = proto.Field(
3023
+ proto.STRING,
3024
+ number=2,
3025
+ )
3026
+ create_time: timestamp_pb2.Timestamp = proto.Field(
3027
+ proto.MESSAGE,
3028
+ number=3,
3029
+ message=timestamp_pb2.Timestamp,
3030
+ )
3031
+ daily_export_enabled: bool = proto.Field(
3032
+ proto.BOOL,
3033
+ number=4,
3034
+ )
3035
+ streaming_export_enabled: bool = proto.Field(
3036
+ proto.BOOL,
3037
+ number=5,
3038
+ )
3039
+ fresh_daily_export_enabled: bool = proto.Field(
3040
+ proto.BOOL,
3041
+ number=9,
3042
+ )
3043
+ include_advertising_id: bool = proto.Field(
3044
+ proto.BOOL,
3045
+ number=6,
3046
+ )
3047
+ export_streams: MutableSequence[str] = proto.RepeatedField(
3048
+ proto.STRING,
3049
+ number=7,
3050
+ )
3051
+ excluded_events: MutableSequence[str] = proto.RepeatedField(
3052
+ proto.STRING,
3053
+ number=8,
3054
+ )
3055
+ dataset_location: str = proto.Field(
3056
+ proto.STRING,
3057
+ number=10,
3058
+ )
3059
+
3060
+
3061
+ class EnhancedMeasurementSettings(proto.Message):
3062
+ r"""Singleton resource under a web DataStream, configuring
3063
+ measurement of additional site interactions and content.
3064
+
3065
+ Attributes:
3066
+ name (str):
3067
+ Output only. Resource name of the Enhanced Measurement
3068
+ Settings. Format:
3069
+ properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings
3070
+ Example:
3071
+ "properties/1000/dataStreams/2000/enhancedMeasurementSettings".
3072
+ stream_enabled (bool):
3073
+ Indicates whether Enhanced Measurement
3074
+ Settings will be used to automatically measure
3075
+ interactions and content on this web stream.
3076
+
3077
+ Changing this value does not affect the settings
3078
+ themselves, but determines whether they are
3079
+ respected.
3080
+ scrolls_enabled (bool):
3081
+ If enabled, capture scroll events each time a
3082
+ visitor gets to the bottom of a page.
3083
+ outbound_clicks_enabled (bool):
3084
+ If enabled, capture an outbound click event
3085
+ each time a visitor clicks a link that leads
3086
+ them away from your domain.
3087
+ site_search_enabled (bool):
3088
+ If enabled, capture a view search results
3089
+ event each time a visitor performs a search on
3090
+ your site (based on a query parameter).
3091
+ video_engagement_enabled (bool):
3092
+ If enabled, capture video play, progress, and
3093
+ complete events as visitors view embedded videos
3094
+ on your site.
3095
+ file_downloads_enabled (bool):
3096
+ If enabled, capture a file download event
3097
+ each time a link is clicked with a common
3098
+ document, compressed file, application, video,
3099
+ or audio extension.
3100
+ page_changes_enabled (bool):
3101
+ If enabled, capture a page view event each
3102
+ time the website changes the browser history
3103
+ state.
3104
+ form_interactions_enabled (bool):
3105
+ If enabled, capture a form interaction event
3106
+ each time a visitor interacts with a form on
3107
+ your website. False by default.
3108
+ search_query_parameter (str):
3109
+ Required. URL query parameters to interpret
3110
+ as site search parameters. Max length is 1024
3111
+ characters. Must not be empty.
3112
+ uri_query_parameter (str):
3113
+ Additional URL query parameters.
3114
+ Max length is 1024 characters.
3115
+ """
3116
+
3117
+ name: str = proto.Field(
3118
+ proto.STRING,
3119
+ number=1,
3120
+ )
3121
+ stream_enabled: bool = proto.Field(
3122
+ proto.BOOL,
3123
+ number=2,
3124
+ )
3125
+ scrolls_enabled: bool = proto.Field(
3126
+ proto.BOOL,
3127
+ number=3,
3128
+ )
3129
+ outbound_clicks_enabled: bool = proto.Field(
3130
+ proto.BOOL,
3131
+ number=4,
3132
+ )
3133
+ site_search_enabled: bool = proto.Field(
3134
+ proto.BOOL,
3135
+ number=5,
3136
+ )
3137
+ video_engagement_enabled: bool = proto.Field(
3138
+ proto.BOOL,
3139
+ number=6,
3140
+ )
3141
+ file_downloads_enabled: bool = proto.Field(
3142
+ proto.BOOL,
3143
+ number=7,
3144
+ )
3145
+ page_changes_enabled: bool = proto.Field(
3146
+ proto.BOOL,
3147
+ number=8,
3148
+ )
3149
+ form_interactions_enabled: bool = proto.Field(
3150
+ proto.BOOL,
3151
+ number=9,
3152
+ )
3153
+ search_query_parameter: str = proto.Field(
3154
+ proto.STRING,
3155
+ number=10,
3156
+ )
3157
+ uri_query_parameter: str = proto.Field(
3158
+ proto.STRING,
3159
+ number=11,
3160
+ )
3161
+
3162
+
3163
+ class ConnectedSiteTag(proto.Message):
3164
+ r"""Configuration for a specific Connected Site Tag.
3165
+
3166
+ Attributes:
3167
+ display_name (str):
3168
+ Required. User-provided display name for the
3169
+ connected site tag. Must be less than 256
3170
+ characters.
3171
+ tag_id (str):
3172
+ Required. "Tag ID to forward events to. Also
3173
+ known as the Measurement ID, or the "G-ID" (For
3174
+ example: G-12345).
3175
+ """
3176
+
3177
+ display_name: str = proto.Field(
3178
+ proto.STRING,
3179
+ number=1,
3180
+ )
3181
+ tag_id: str = proto.Field(
3182
+ proto.STRING,
3183
+ number=2,
3184
+ )
3185
+
3186
+
3187
+ class DataRedactionSettings(proto.Message):
3188
+ r"""Settings for client-side data redaction. Singleton resource
3189
+ under a Web Stream.
3190
+
3191
+ Attributes:
3192
+ name (str):
3193
+ Output only. Name of this Data Redaction Settings resource.
3194
+ Format:
3195
+ properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings
3196
+ Example:
3197
+ "properties/1000/dataStreams/2000/dataRedactionSettings".
3198
+ email_redaction_enabled (bool):
3199
+ If enabled, any event parameter or user
3200
+ property values that look like an email will be
3201
+ redacted.
3202
+ query_parameter_redaction_enabled (bool):
3203
+ Query Parameter redaction removes the key and value portions
3204
+ of a query parameter if it is in the configured set of query
3205
+ parameters.
3206
+
3207
+ If enabled, URL query replacement logic will be run for the
3208
+ Stream. Any query parameters defined in query_parameter_keys
3209
+ will be redacted.
3210
+ query_parameter_keys (MutableSequence[str]):
3211
+ The query parameter keys to apply redaction logic to if
3212
+ present in the URL. Query parameter matching is
3213
+ case-insensitive.
3214
+
3215
+ Must contain at least one element if
3216
+ query_parameter_replacement_enabled is true. Keys cannot
3217
+ contain commas.
3218
+ """
3219
+
3220
+ name: str = proto.Field(
3221
+ proto.STRING,
3222
+ number=1,
3223
+ )
3224
+ email_redaction_enabled: bool = proto.Field(
3225
+ proto.BOOL,
3226
+ number=2,
3227
+ )
3228
+ query_parameter_redaction_enabled: bool = proto.Field(
3229
+ proto.BOOL,
3230
+ number=3,
3231
+ )
3232
+ query_parameter_keys: MutableSequence[str] = proto.RepeatedField(
3233
+ proto.STRING,
3234
+ number=4,
3235
+ )
3236
+
3237
+
3238
+ class AdSenseLink(proto.Message):
3239
+ r"""A link between a Google Analytics property and an AdSense for
3240
+ Content ad client.
3241
+
3242
+ Attributes:
3243
+ name (str):
3244
+ Output only. The resource name for this
3245
+ AdSense Link resource. Format:
3246
+ properties/{propertyId}/adSenseLinks/{linkId}
3247
+ Example: properties/1234/adSenseLinks/6789
3248
+ ad_client_code (str):
3249
+ Immutable. The AdSense ad client code that
3250
+ the Google Analytics property is linked to.
3251
+ Example format: "ca-pub-1234567890".
3252
+ """
3253
+
3254
+ name: str = proto.Field(
3255
+ proto.STRING,
3256
+ number=1,
3257
+ )
3258
+ ad_client_code: str = proto.Field(
3259
+ proto.STRING,
3260
+ number=2,
3261
+ )
3262
+
3263
+
3264
+ class RollupPropertySourceLink(proto.Message):
3265
+ r"""A link that references a source property under the parent
3266
+ rollup property.
3267
+
3268
+ Attributes:
3269
+ name (str):
3270
+ Output only. Resource name of this RollupPropertySourceLink.
3271
+ Format:
3272
+ 'properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link}'
3273
+ Format: 'properties/123/rollupPropertySourceLinks/456'
3274
+ source_property (str):
3275
+ Immutable. Resource name of the source property. Format:
3276
+ properties/{property_id} Example: "properties/789".
3277
+ """
3278
+
3279
+ name: str = proto.Field(
3280
+ proto.STRING,
3281
+ number=1,
3282
+ )
3283
+ source_property: str = proto.Field(
3284
+ proto.STRING,
3285
+ number=2,
3286
+ )
3287
+
3288
+
3289
+ __all__ = tuple(sorted(__protobuf__.manifest))