-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
analyticsadmin_v1alpha.accounts.html
1523 lines (1460 loc) 路 189 KB
/
analyticsadmin_v1alpha.accounts.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="analyticsadmin_v1alpha.accounts.accessBindings.html">accessBindings()</a></code>
</p>
<p class="firstline">Returns the accessBindings Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Lookup for a single Account.</p>
<p class="toc_element">
<code><a href="#getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get data sharing settings on an account. Data sharing settings are singletons.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an account.</p>
<p class="toc_element">
<code><a href="#provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Requests a ticket for creating an account.</p>
<p class="toc_element">
<code><a href="#runAccessReport">runAccessReport(entity, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).</p>
<p class="toc_element">
<code><a href="#searchChangeHistoryEvents">searchChangeHistoryEvents(account, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches through all changes to an account or its children given the specified set of filters.</p>
<p class="toc_element">
<code><a href="#searchChangeHistoryEvents_next">searchChangeHistoryEvents_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
Args:
name: string, Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Lookup for a single Account.
Args:
name: string, Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</code>
<pre>Get data sharing settings on an account. Data sharing settings are singletons.
Args:
name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing data sharing settings of a Google Analytics account.
"name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
"sharingWithGoogleAnySalesEnabled": True or False, # Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
"sharingWithGoogleAssignedSalesEnabled": True or False, # Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.
"sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services.
"sharingWithGoogleSupportEnabled": True or False, # Allows Google support to access the data in order to help troubleshoot issues.
"sharingWithOthersEnabled": True or False, # Allows Google to share the data anonymously in aggregate form with others.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
<pre>Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Args:
pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Request message for ListAccounts RPC.
"accounts": [ # Results that were accessible to the caller.
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an account.
Args:
name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
}
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</code>
<pre>Requests a ticket for creating an account.
Args:
body: object, The request body.
The object takes the form of:
{ # Request message for ProvisionAccountTicket RPC.
"account": { # A resource message representing a Google Analytics account. # The account to create.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
"redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ProvisionAccountTicket RPC.
"accountTicketId": "A String", # The param to be passed in the ToS link.
}</pre>
</div>
<div class="method">
<code class="details" id="runAccessReport">runAccessReport(entity, body=None, x__xgafv=None)</code>
<pre>Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
Args:
entity: string, The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID. (required)
body: object, The request body.
The object takes the form of:
{ # The request for a Data Access Record Report.
"dateRanges": [ # Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
{ # A contiguous range of days: startDate, startDate + 1, ..., endDate.
"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.
"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.
},
],
"dimensionFilter": { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
"accessFilter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.
"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
"fromValue": { # To represent a number. # Begins with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
"toValue": { # To represent a number. # Ends with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"fieldName": "A String", # The dimension name or metric name.
"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"values": [ # The list of string values. Must be non-empty.
"A String",
],
},
"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
"operation": "A String", # The operation type for this filter.
"value": { # To represent a number. # A numeric value or a date value.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"stringFilter": { # The filter for strings. # Strings related filter.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"matchType": "A String", # The match type for this filter.
"value": "A String", # The string value used for the matching.
},
},
"andGroup": { # A list of filter expressions. # Each of the FilterExpressions in the and_group has an AND relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
],
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression # The FilterExpression is NOT of not_expression.
"orGroup": { # A list of filter expressions. # Each of the FilterExpressions in the or_group has an OR relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
],
},
},
"dimensions": [ # The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
{ # Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings.
"dimensionName": "A String", # The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
},
],
"expandGroups": True or False, # Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.
"includeAllUsers": True or False, # Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.
"limit": "A String", # The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
"metricFilter": { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
"accessFilter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.
"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
"fromValue": { # To represent a number. # Begins with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
"toValue": { # To represent a number. # Ends with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"fieldName": "A String", # The dimension name or metric name.
"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"values": [ # The list of string values. Must be non-empty.
"A String",
],
},
"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
"operation": "A String", # The operation type for this filter.
"value": { # To represent a number. # A numeric value or a date value.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"stringFilter": { # The filter for strings. # Strings related filter.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"matchType": "A String", # The match type for this filter.
"value": "A String", # The string value used for the matching.
},
},
"andGroup": { # A list of filter expressions. # Each of the FilterExpressions in the and_group has an AND relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
],
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression # The FilterExpression is NOT of not_expression.
"orGroup": { # A list of filter expressions. # Each of the FilterExpressions in the or_group has an OR relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
],
},
},
"metrics": [ # The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
{ # The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records.
"metricName": "A String", # The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`.
},
],
"offset": "A String", # The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
"orderBys": [ # Specifies how rows are ordered in the response.
{ # Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.
"desc": True or False, # If true, sorts by descending order. If false or unspecified, sorts in ascending order.
"dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.
"dimensionName": "A String", # A dimension name in the request to order by.
"orderType": "A String", # Controls the rule for dimension value ordering.
},
"metric": { # Sorts by metric values. # Sorts results by a metric's values.
"metricName": "A String", # A metric name in the request to order by.
},
},
],
"returnEntityQuota": True or False, # Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false.
"timeZone": "A String", # This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The customized Data Access Record Report response.
"dimensionHeaders": [ # The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
{ # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
"dimensionName": "A String", # The dimension's name; for example 'userEmail'.
},
],
"metricHeaders": [ # The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
{ # Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.
"metricName": "A String", # The metric's name; for example 'accessCount'.
},
],
"quota": { # Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # The quota state for this Analytics property including this request. This field doesn't work with account-level requests.
"concurrentRequests": { # Current state for a particular quota group. # Properties can use up to 50 concurrent requests.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"serverErrorsPerProjectPerHour": { # Current state for a particular quota group. # Properties and cloud project pairs can have up to 50 server errors per hour.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"tokensPerDay": { # Current state for a particular quota group. # Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"tokensPerHour": { # Current state for a particular quota group. # Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"tokensPerProjectPerHour": { # Current state for a particular quota group. # Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
},
"rowCount": 42, # The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
"rows": [ # Rows of dimension value combinations and metric values in the report.
{ # Access report data for each row.
"dimensionValues": [ # List of dimension values. These values are in the same order as specified in the request.
{ # The value of a dimension.
"value": "A String", # The dimension value. For example, this value may be 'France' for the 'country' dimension.
},
],
"metricValues": [ # List of metric values. These values are in the same order as specified in the request.
{ # The value of a metric.
"value": "A String", # The measurement value. For example, this value may be '13'.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="searchChangeHistoryEvents">searchChangeHistoryEvents(account, body=None, x__xgafv=None)</code>
<pre>Searches through all changes to an account or its children given the specified set of filters.
Args:
account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SearchChangeHistoryEvents RPC.
"action": [ # Optional. If set, only return changes that match one or more of these types of actions.
"A String",
],
"actorEmail": [ # Optional. If set, only return changes if they are made by a user in this list.
"A String",
],
"earliestChangeTime": "A String", # Optional. If set, only return changes made after this time (inclusive).
"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).
"pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
"pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token.
"property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100"
"resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SearchAccounts RPC.
"changeHistoryEvents": [ # Results that were accessible to the caller.
{ # A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.
"actorType": "A String", # The type of actor that made this change.
"changeTime": "A String", # Time when change was made.
"changes": [ # A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.
{ # A description of a change to a single Google Analytics resource.
"action": "A String", # The type of action that changed this resource.
"resource": "A String", # Resource name of the resource whose changes are described by this entry.
"resourceAfterChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.
"account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
"adsenseLink": { # A link between a GA4 Property and an AdSense for Content ad client. # A snapshot of an AdSenseLink resource in change history.
"adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890"
"name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789
},
"attributionSettings": { # The attribution settings used for a given property. This is a singleton resource. # A snapshot of AttributionSettings resource in change history.
"acquisitionConversionEventLookbackWindow": "A String", # Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.
"adsWebConversionDataExportScope": "A String", # Required. The Conversion Export Scope for data exported to linked Ads Accounts.
"name": "A String", # Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"
"otherConversionEventLookbackWindow": "A String", # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.
"reportingAttributionModel": "A String", # Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.
},
"audience": { # A resource message representing a GA4 Audience. # A snapshot of an Audience resource in change history.
"adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
"description": "A String", # Required. The description of the Audience.
"displayName": "A String", # Required. The display name of the Audience.
"eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
"eventName": "A String", # Required. The event name that will be logged.
"logCondition": "A String", # Required. When to log the event.
},
"exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.
"filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND鈥檈d together.
{ # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience).
"clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause.
"sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience.
"scope": "A String", # Required. Immutable. Specifies the scope for this filter.
"sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur.
"sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
{ # A condition that must occur in the specified step order for this user to match the sequence.
"constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
"filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.
"andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND鈥檈d together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression.
"filterExpressions": [ # A list of Audience filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
],
},
"dimensionOrMetricFilter": { # A specific filter for a single dimension or metric. # A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression.
"atAnyPointInTime": True or False, # Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
"betweenFilter": { # A filter for numeric or date values between certain values on a dimension or metric. # A filter for numeric or date values between certain values on a dimension or metric.
"fromValue": { # To represent a number. # Required. Begins with this number, inclusive.
"doubleValue": 3.14, # Double value.
"int64Value": "A String", # Integer value.
},
"toValue": { # To represent a number. # Required. Ends with this number, inclusive.
"doubleValue": 3.14, # Double value.
"int64Value": "A String", # Integer value.
},
},
"fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
"inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"numericFilter": { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
"operation": "A String", # Required. The operation applied to a numeric filter.
"value": { # To represent a number. # Required. The numeric or date value to match against.
"doubleValue": 3.14, # Double value.
"int64Value": "A String", # Integer value.
},
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression.
"eventName": "A String", # Required. Immutable. The name of the event to match against.
"eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
"orGroup": { # A list of Audience filter expressions. # A list of expressions to OR鈥檈d together. It cannot contain AudienceFilterExpressions with and_group or or_group.
"filterExpressions": [ # A list of Audience filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
],
},
},
"immediatelyFollows": True or False, # Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.
"scope": "A String", # Required. Immutable. Specifies the scope for this step.
},
],
},
"simpleFilter": { # Defines a simple filter that a user must satisfy to be a member of the Audience. # A simple filter that a user must satisfy to be a member of the Audience.
"filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
"andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND鈥檈d together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression.
"filterExpressions": [ # A list of Audience filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
],
},
"dimensionOrMetricFilter": { # A specific filter for a single dimension or metric. # A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression.
"atAnyPointInTime": True or False, # Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
"betweenFilter": { # A filter for numeric or date values between certain values on a dimension or metric. # A filter for numeric or date values between certain values on a dimension or metric.
"fromValue": { # To represent a number. # Required. Begins with this number, inclusive.
"doubleValue": 3.14, # Double value.
"int64Value": "A String", # Integer value.
},
"toValue": { # To represent a number. # Required. Ends with this number, inclusive.
"doubleValue": 3.14, # Double value.
"int64Value": "A String", # Integer value.
},
},
"fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
"inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"numericFilter": { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
"operation": "A String", # Required. The operation applied to a numeric filter.
"value": { # To represent a number. # Required. The numeric or date value to match against.
"doubleValue": 3.14, # Double value.
"int64Value": "A String", # Integer value.
},
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression.
"eventName": "A String", # Required. Immutable. The name of the event to match against.
"eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
"orGroup": { # A list of Audience filter expressions. # A list of expressions to OR鈥檈d together. It cannot contain AudienceFilterExpressions with and_group or or_group.
"filterExpressions": [ # A list of Audience filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
],
},
},
"scope": "A String", # Required. Immutable. Specifies the scope for this filter.
},
},
],
"membershipDurationDays": 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
"name": "A String", # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
},
"bigqueryLink": { # A link between a GA4 Property and BigQuery project. # A snapshot of a BigQuery link resource in change history.
"createTime": "A String", # Output only. Time when the link was created.
"dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
"excludedEvents": [ # The list of event names that will be excluded from exports.
"A String",
],
"exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
"A String",
],
"freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
"includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
"name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
"project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
"streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
},
"calculatedMetric": { # A definition for a calculated metric. # A snapshot of a CalculatedMetric resource in change history.
"calculatedMetricId": "A String", # Output only. The ID to use for the calculated metric. In the UI, this is referred to as the "API name." The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, "calcMetric:{calculated_metric_id}".
"description": "A String", # Optional. Description for this calculated metric. Max length of 4096 characters.
"displayName": "A String", # Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
"formula": "A String", # Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"
"invalidMetricReference": True or False, # Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results.
"metricUnit": "A String", # Required. The type for the calculated metric's value.
"name": "A String", # Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'
"restrictedMetricType": [ # Output only. Types of restricted data that this metric contains.
"A String",
],
},
"channelGroup": { # A resource message representing a Channel Group. # A snapshot of a ChannelGroup resource in change history.
"description": "A String", # The description of the Channel Group. Max length of 256 characters.
"displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
"groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
{ # The rules that govern how traffic is grouped into one channel.
"displayName": "A String", # Required. Customer defined display name for the channel.
"expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
"andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND鈥檈d together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
"filterExpressions": [ # A list of Channel Group filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
],
},
"filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
"fieldName": "A String", # Required. Immutable. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
"orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR鈥檈d together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
"filterExpressions": [ # A list of Channel Group filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
],
},
},
},
],
"name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
"primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
"systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
},
"conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
"countingMethod": "A String", # Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to `ONCE_PER_EVENT`.
"createTime": "A String", # Output only. Time when this conversion event was created in the property.
"custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
"defaultConversionValue": { # Defines a default value/currency for a conversion event. Both value and currency must be provided. # Optional. Defines a default value/currency for a conversion event.
"currencyCode": "A String", # When a conversion event for this event_name has no set currency, this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
"value": 3.14, # This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset.
},
"deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent.
"eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
"name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
},
"customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history.
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
"name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
"scope": "A String", # Required. Immutable. The scope of this dimension.
},
"customMetric": { # A definition for a custom metric. # A snapshot of a CustomMetric resource in change history.
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
"displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
"measurementUnit": "A String", # Required. The type for the custom metric's value.
"name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
"parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
"restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
"A String",
],
"scope": "A String", # Required. Immutable. The scope of this custom metric.
},
"dataRedactionSettings": { # Settings for client-side data redaction. Singleton resource under a Web Stream. # A snapshot of DataRedactionSettings resource in change history.
"emailRedactionEnabled": True or False, # If enabled, any event parameter or user property values that look like an email will be redacted.
"name": "A String", # Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
"queryParameterKeys": [ # The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.
"A String",
],
"queryParameterRedactionEnabled": True or False, # Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.
},
"dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
"eventDataRetention": "A String", # The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
},
"dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
"androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
"firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
"packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
},
"createTime": "A String", # Output only. Time when this stream was originally created.
"displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
"iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
"firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
},
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
"type": "A String", # Required. Immutable. The type of this DataStream resource.
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
"webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
"defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
"measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
},
},
"displayVideo360AdvertiserLink": { # A link between a GA4 property and a Display & Video 360 advertiser. # A snapshot of a DisplayVideo360AdvertiserLink resource in change history.
"adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
"advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
"campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
"costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
"name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
},
"displayVideo360AdvertiserLinkProposal": { # A proposal for a link between a GA4 property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals. # A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history.
"adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.
"advertiserDisplayName": "A String", # Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.
"advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
"campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.
"costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.
"linkProposalStatusDetails": { # Status information for a link proposal. # Output only. The status information for this link proposal.
"linkProposalInitiatingProduct": "A String", # Output only. The source of this proposal.
"linkProposalState": "A String", # Output only. The state of this proposal.
"requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage.
},
"name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID
"validationEmail": "A String", # Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal.
},
"enhancedMeasurementSettings": { # Singleton resource under a web DataStream, configuring measurement of additional site interactions and content. # A snapshot of EnhancedMeasurementSettings resource in change history.
"fileDownloadsEnabled": True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
"formInteractionsEnabled": True or False, # If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.
"name": "A String", # Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.
"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
"siteSearchEnabled": True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
"streamEnabled": True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.
"uriQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.
"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
},
"eventCreateRule": { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule. # A snapshot of an EventCreateRule resource in change history.
"destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
"eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
{ # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
"comparisonType": "A String", # Required. The type of comparison to be applied to the value.
"field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
"negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
"value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
},
],
"name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
"parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
{ # Defines an event parameter to mutate.
"parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
"parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
},
],
"sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
},
"expandedDataSet": { # A resource message representing a GA4 ExpandedDataSet. # A snapshot of an ExpandedDataSet resource in change history.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering `other` row.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND鈥檈d together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
},
"firebaseLink": { # A link between a GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
"createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
"name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
},
"googleAdsLink": { # A link between a GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
"createTime": "A String", # Output only. Time when this link was originally created.
"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
"customerId": "A String", # Immutable. Google Ads customer ID.
"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
"updateTime": "A String", # Output only. Time when this link was last updated.
},
"googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history.
"consent": "A String", # Output only. Terms of Service acceptance.
"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
"state": "A String", # Status of this setting.
},
"measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
"displayName": "A String", # Required. Human-readable display name for this secret.
"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
},
"property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.
"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
"createTime": "A String", # Output only. Time when the entity was originally created.
"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"
"propertyType": "A String", # Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.
"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
},
"searchAds360Link": { # A link between a GA4 property and a Search Ads 360 entity. # A snapshot of a SearchAds360Link resource in change history.
"adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.
"advertiserDisplayName": "A String", # Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource.
"advertiserId": "A String", # Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.
"campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
"costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
"name": "A String", # Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID
"siteStatsSharingEnabled": True or False, # Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.
},
"skadnetworkConversionValueSchema": { # SKAdNetwork conversion value schema of an iOS stream. # A snapshot of SKAdNetworkConversionValueSchema resource in change history.
"applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
"name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
"postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
"conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
"minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
"minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
},
],
"fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
"conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
"minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
"minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
},
],
"fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
"conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.