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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
|
<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.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.audiences.html">audiences</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Archives an Audience on a property.</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Audience.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.</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 Audience on a property.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code>
<pre>Archives an Audience on a property.
Args:
name: string, Required. Example format: properties/1234/audiences/5678 (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ArchiveAudience RPC.
}
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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates an Audience.
Args:
parent: string, Required. Example format: properties/1234 (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing an Audience.
"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.
"createTime": "A String", # Output only. Time when the Audience was created.
"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’ed 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’ed 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’ed 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’ed 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’ed 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}
}
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 an Audience.
"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.
"createTime": "A String", # Output only. Time when the Audience was created.
"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’ed 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’ed 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’ed 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’ed 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’ed 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}
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
Args:
name: string, Required. The name of the Audience to get. Example format: properties/1234/audiences/5678 (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 an Audience.
"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.
"createTime": "A String", # Output only. Time when the Audience was created.
"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’ed 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’ed 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’ed 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’ed 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’ed 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}
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
Args:
parent: string, Required. Example format: properties/1234 (required)
pageSize: integer, The maximum number of resources to return. 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 `ListAudiences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudiences` must match the call that provided the page token.
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 ListAudiences RPC.
"audiences": [ # List of Audiences.
{ # A resource message representing an Audience.
"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.
"createTime": "A String", # Output only. Time when the Audience was created.
"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’ed 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’ed 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’ed 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’ed 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’ed 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}
},
],
"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 Audience on a property.
Args:
name: string, Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing an Audience.
"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.
"createTime": "A String", # Output only. Time when the Audience was created.
"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’ed 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’ed 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’ed 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’ed 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’ed 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}
}
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "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 an Audience.
"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.
"createTime": "A String", # Output only. Time when the Audience was created.
"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’ed 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’ed 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’ed 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’ed 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’ed 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}
}</pre>
</div>
</body></html>
|
