Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.audiences.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Archives an Audience on a property.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Creates an Audience.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an Audience on a property.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code>
101 <pre>Archives an Audience on a property.
102
103 Args:
104 name: string, Required. Example format: properties/1234/audiences/5678 (required)
105 body: object, The request body.
106 The object takes the form of:
107
108 { # Request message for ArchiveAudience RPC.
109 }
110
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116 Returns:
117 An object of the form:
118
119 { # 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); }
120 }</pre>
121 </div>
122
123 <div class="method">
124 <code class="details" id="close">close()</code>
125 <pre>Close httplib2 connections.</pre>
126 </div>
127
128 <div class="method">
129 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
130 <pre>Creates an Audience.
131
132 Args:
133 parent: string, Required. Example format: properties/1234 (required)
134 body: object, The request body.
135 The object takes the form of:
136
137 { # A resource message representing an Audience.
138 &quot;adsPersonalizationEnabled&quot;: 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.
139 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the Audience was created.
140 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the Audience.
141 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Audience.
142 &quot;eventTrigger&quot;: { # 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.
143 &quot;eventName&quot;: &quot;A String&quot;, # Required. The event name that will be logged.
144 &quot;logCondition&quot;: &quot;A String&quot;, # Required. When to log the event.
145 },
146 &quot;exclusionDurationMode&quot;: &quot;A String&quot;, # 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.
147 &quot;filterClauses&quot;: [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
148 { # 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).
149 &quot;clauseType&quot;: &quot;A String&quot;, # Required. Specifies whether this is an include or exclude filter clause.
150 &quot;sequenceFilter&quot;: { # 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.
151 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
152 &quot;sequenceMaximumDuration&quot;: &quot;A String&quot;, # Optional. Defines the time period in which the whole sequence must occur.
153 &quot;sequenceSteps&quot;: [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
154 { # A condition that must occur in the specified step order for this user to match the sequence.
155 &quot;constraintDuration&quot;: &quot;A String&quot;, # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] &lt;= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
156 &quot;filterExpression&quot;: { # 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.
157 &quot;andGroup&quot;: { # 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.
158 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
159 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
160 ],
161 },
162 &quot;dimensionOrMetricFilter&quot;: { # 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.
163 &quot;atAnyPointInTime&quot;: 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.
164 &quot;betweenFilter&quot;: { # 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.
165 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
166 &quot;doubleValue&quot;: 3.14, # Double value.
167 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
168 },
169 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
170 &quot;doubleValue&quot;: 3.14, # Double value.
171 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
172 },
173 },
174 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
175 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
176 &quot;inListFilter&quot;: { # 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.
177 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
178 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
179 &quot;A String&quot;,
180 ],
181 },
182 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
183 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
184 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
185 &quot;doubleValue&quot;: 3.14, # Double value.
186 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
187 },
188 },
189 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
190 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
191 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
192 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
193 },
194 },
195 &quot;eventFilter&quot;: { # 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.
196 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
197 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
198 },
199 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
200 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
201 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
202 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
203 ],
204 },
205 },
206 &quot;immediatelyFollows&quot;: 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.
207 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this step.
208 },
209 ],
210 },
211 &quot;simpleFilter&quot;: { # 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.
212 &quot;filterExpression&quot;: { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
213 &quot;andGroup&quot;: { # 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.
214 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
215 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
216 ],
217 },
218 &quot;dimensionOrMetricFilter&quot;: { # 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.
219 &quot;atAnyPointInTime&quot;: 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.
220 &quot;betweenFilter&quot;: { # 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.
221 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
222 &quot;doubleValue&quot;: 3.14, # Double value.
223 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
224 },
225 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
226 &quot;doubleValue&quot;: 3.14, # Double value.
227 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
228 },
229 },
230 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
231 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
232 &quot;inListFilter&quot;: { # 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.
233 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
234 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
235 &quot;A String&quot;,
236 ],
237 },
238 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
239 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
240 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
241 &quot;doubleValue&quot;: 3.14, # Double value.
242 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
243 },
244 },
245 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
246 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
247 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
248 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
249 },
250 },
251 &quot;eventFilter&quot;: { # 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.
252 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
253 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
254 },
255 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
256 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
257 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
258 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
259 ],
260 },
261 },
262 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
263 },
264 },
265 ],
266 &quot;membershipDurationDays&quot;: 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
267 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
268 }
269
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275 Returns:
276 An object of the form:
277
278 { # A resource message representing an Audience.
279 &quot;adsPersonalizationEnabled&quot;: 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.
280 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the Audience was created.
281 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the Audience.
282 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Audience.
283 &quot;eventTrigger&quot;: { # 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.
284 &quot;eventName&quot;: &quot;A String&quot;, # Required. The event name that will be logged.
285 &quot;logCondition&quot;: &quot;A String&quot;, # Required. When to log the event.
286 },
287 &quot;exclusionDurationMode&quot;: &quot;A String&quot;, # 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.
288 &quot;filterClauses&quot;: [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
289 { # 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).
290 &quot;clauseType&quot;: &quot;A String&quot;, # Required. Specifies whether this is an include or exclude filter clause.
291 &quot;sequenceFilter&quot;: { # 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.
292 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
293 &quot;sequenceMaximumDuration&quot;: &quot;A String&quot;, # Optional. Defines the time period in which the whole sequence must occur.
294 &quot;sequenceSteps&quot;: [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
295 { # A condition that must occur in the specified step order for this user to match the sequence.
296 &quot;constraintDuration&quot;: &quot;A String&quot;, # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] &lt;= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
297 &quot;filterExpression&quot;: { # 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.
298 &quot;andGroup&quot;: { # 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.
299 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
300 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
301 ],
302 },
303 &quot;dimensionOrMetricFilter&quot;: { # 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.
304 &quot;atAnyPointInTime&quot;: 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.
305 &quot;betweenFilter&quot;: { # 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.
306 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
307 &quot;doubleValue&quot;: 3.14, # Double value.
308 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
309 },
310 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
311 &quot;doubleValue&quot;: 3.14, # Double value.
312 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
313 },
314 },
315 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
316 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
317 &quot;inListFilter&quot;: { # 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.
318 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
319 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
320 &quot;A String&quot;,
321 ],
322 },
323 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
324 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
325 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
326 &quot;doubleValue&quot;: 3.14, # Double value.
327 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
328 },
329 },
330 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
331 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
332 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
333 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
334 },
335 },
336 &quot;eventFilter&quot;: { # 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.
337 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
338 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
339 },
340 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
341 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
342 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
343 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
344 ],
345 },
346 },
347 &quot;immediatelyFollows&quot;: 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.
348 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this step.
349 },
350 ],
351 },
352 &quot;simpleFilter&quot;: { # 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.
353 &quot;filterExpression&quot;: { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
354 &quot;andGroup&quot;: { # 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.
355 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
356 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
357 ],
358 },
359 &quot;dimensionOrMetricFilter&quot;: { # 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.
360 &quot;atAnyPointInTime&quot;: 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.
361 &quot;betweenFilter&quot;: { # 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.
362 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
363 &quot;doubleValue&quot;: 3.14, # Double value.
364 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
365 },
366 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
367 &quot;doubleValue&quot;: 3.14, # Double value.
368 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
369 },
370 },
371 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
372 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
373 &quot;inListFilter&quot;: { # 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.
374 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
375 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
376 &quot;A String&quot;,
377 ],
378 },
379 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
380 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
381 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
382 &quot;doubleValue&quot;: 3.14, # Double value.
383 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
384 },
385 },
386 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
387 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
388 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
389 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
390 },
391 },
392 &quot;eventFilter&quot;: { # 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.
393 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
394 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
395 },
396 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
397 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
398 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
399 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
400 ],
401 },
402 },
403 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
404 },
405 },
406 ],
407 &quot;membershipDurationDays&quot;: 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
408 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
409 }</pre>
410 </div>
411
412 <div class="method">
413 <code class="details" id="get">get(name, x__xgafv=None)</code>
414 <pre>Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
415
416 Args:
417 name: string, Required. The name of the Audience to get. Example format: properties/1234/audiences/5678 (required)
418 x__xgafv: string, V1 error format.
419 Allowed values
420 1 - v1 error format
421 2 - v2 error format
422
423 Returns:
424 An object of the form:
425
426 { # A resource message representing an Audience.
427 &quot;adsPersonalizationEnabled&quot;: 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.
428 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the Audience was created.
429 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the Audience.
430 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Audience.
431 &quot;eventTrigger&quot;: { # 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.
432 &quot;eventName&quot;: &quot;A String&quot;, # Required. The event name that will be logged.
433 &quot;logCondition&quot;: &quot;A String&quot;, # Required. When to log the event.
434 },
435 &quot;exclusionDurationMode&quot;: &quot;A String&quot;, # 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.
436 &quot;filterClauses&quot;: [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
437 { # 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).
438 &quot;clauseType&quot;: &quot;A String&quot;, # Required. Specifies whether this is an include or exclude filter clause.
439 &quot;sequenceFilter&quot;: { # 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.
440 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
441 &quot;sequenceMaximumDuration&quot;: &quot;A String&quot;, # Optional. Defines the time period in which the whole sequence must occur.
442 &quot;sequenceSteps&quot;: [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
443 { # A condition that must occur in the specified step order for this user to match the sequence.
444 &quot;constraintDuration&quot;: &quot;A String&quot;, # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] &lt;= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
445 &quot;filterExpression&quot;: { # 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.
446 &quot;andGroup&quot;: { # 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.
447 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
448 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
449 ],
450 },
451 &quot;dimensionOrMetricFilter&quot;: { # 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.
452 &quot;atAnyPointInTime&quot;: 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.
453 &quot;betweenFilter&quot;: { # 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.
454 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
455 &quot;doubleValue&quot;: 3.14, # Double value.
456 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
457 },
458 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
459 &quot;doubleValue&quot;: 3.14, # Double value.
460 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
461 },
462 },
463 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
464 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
465 &quot;inListFilter&quot;: { # 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.
466 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
467 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
468 &quot;A String&quot;,
469 ],
470 },
471 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
472 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
473 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
474 &quot;doubleValue&quot;: 3.14, # Double value.
475 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
476 },
477 },
478 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
479 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
480 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
481 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
482 },
483 },
484 &quot;eventFilter&quot;: { # 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.
485 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
486 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
487 },
488 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
489 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
490 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
491 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
492 ],
493 },
494 },
495 &quot;immediatelyFollows&quot;: 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.
496 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this step.
497 },
498 ],
499 },
500 &quot;simpleFilter&quot;: { # 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.
501 &quot;filterExpression&quot;: { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
502 &quot;andGroup&quot;: { # 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.
503 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
504 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
505 ],
506 },
507 &quot;dimensionOrMetricFilter&quot;: { # 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.
508 &quot;atAnyPointInTime&quot;: 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.
509 &quot;betweenFilter&quot;: { # 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.
510 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
511 &quot;doubleValue&quot;: 3.14, # Double value.
512 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
513 },
514 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
515 &quot;doubleValue&quot;: 3.14, # Double value.
516 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
517 },
518 },
519 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
520 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
521 &quot;inListFilter&quot;: { # 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.
522 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
523 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
524 &quot;A String&quot;,
525 ],
526 },
527 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
528 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
529 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
530 &quot;doubleValue&quot;: 3.14, # Double value.
531 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
532 },
533 },
534 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
535 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
536 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
537 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
538 },
539 },
540 &quot;eventFilter&quot;: { # 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.
541 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
542 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
543 },
544 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
545 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
546 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
547 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
548 ],
549 },
550 },
551 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
552 },
553 },
554 ],
555 &quot;membershipDurationDays&quot;: 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
556 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
557 }</pre>
558 </div>
559
560 <div class="method">
561 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
562 <pre>Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
563
564 Args:
565 parent: string, Required. Example format: properties/1234 (required)
566 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).
567 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.
568 x__xgafv: string, V1 error format.
569 Allowed values
570 1 - v1 error format
571 2 - v2 error format
572
573 Returns:
574 An object of the form:
575
576 { # Response message for ListAudiences RPC.
577 &quot;audiences&quot;: [ # List of Audiences.
578 { # A resource message representing an Audience.
579 &quot;adsPersonalizationEnabled&quot;: 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.
580 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the Audience was created.
581 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the Audience.
582 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Audience.
583 &quot;eventTrigger&quot;: { # 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.
584 &quot;eventName&quot;: &quot;A String&quot;, # Required. The event name that will be logged.
585 &quot;logCondition&quot;: &quot;A String&quot;, # Required. When to log the event.
586 },
587 &quot;exclusionDurationMode&quot;: &quot;A String&quot;, # 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.
588 &quot;filterClauses&quot;: [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
589 { # 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).
590 &quot;clauseType&quot;: &quot;A String&quot;, # Required. Specifies whether this is an include or exclude filter clause.
591 &quot;sequenceFilter&quot;: { # 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.
592 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
593 &quot;sequenceMaximumDuration&quot;: &quot;A String&quot;, # Optional. Defines the time period in which the whole sequence must occur.
594 &quot;sequenceSteps&quot;: [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
595 { # A condition that must occur in the specified step order for this user to match the sequence.
596 &quot;constraintDuration&quot;: &quot;A String&quot;, # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] &lt;= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
597 &quot;filterExpression&quot;: { # 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.
598 &quot;andGroup&quot;: { # 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.
599 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
600 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
601 ],
602 },
603 &quot;dimensionOrMetricFilter&quot;: { # 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.
604 &quot;atAnyPointInTime&quot;: 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.
605 &quot;betweenFilter&quot;: { # 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.
606 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
607 &quot;doubleValue&quot;: 3.14, # Double value.
608 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
609 },
610 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
611 &quot;doubleValue&quot;: 3.14, # Double value.
612 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
613 },
614 },
615 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
616 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
617 &quot;inListFilter&quot;: { # 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.
618 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
619 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
620 &quot;A String&quot;,
621 ],
622 },
623 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
624 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
625 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
626 &quot;doubleValue&quot;: 3.14, # Double value.
627 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
628 },
629 },
630 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
631 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
632 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
633 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
634 },
635 },
636 &quot;eventFilter&quot;: { # 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.
637 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
638 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
639 },
640 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
641 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
642 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
643 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
644 ],
645 },
646 },
647 &quot;immediatelyFollows&quot;: 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.
648 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this step.
649 },
650 ],
651 },
652 &quot;simpleFilter&quot;: { # 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.
653 &quot;filterExpression&quot;: { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
654 &quot;andGroup&quot;: { # 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.
655 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
656 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
657 ],
658 },
659 &quot;dimensionOrMetricFilter&quot;: { # 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.
660 &quot;atAnyPointInTime&quot;: 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.
661 &quot;betweenFilter&quot;: { # 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.
662 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
663 &quot;doubleValue&quot;: 3.14, # Double value.
664 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
665 },
666 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
667 &quot;doubleValue&quot;: 3.14, # Double value.
668 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
669 },
670 },
671 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
672 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
673 &quot;inListFilter&quot;: { # 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.
674 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
675 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
676 &quot;A String&quot;,
677 ],
678 },
679 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
680 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
681 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
682 &quot;doubleValue&quot;: 3.14, # Double value.
683 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
684 },
685 },
686 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
687 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
688 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
689 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
690 },
691 },
692 &quot;eventFilter&quot;: { # 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.
693 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
694 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
695 },
696 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
697 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
698 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
699 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
700 ],
701 },
702 },
703 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
704 },
705 },
706 ],
707 &quot;membershipDurationDays&quot;: 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
708 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
709 },
710 ],
711 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
712 }</pre>
713 </div>
714
715 <div class="method">
716 <code class="details" id="list_next">list_next()</code>
717 <pre>Retrieves the next page of results.
718
719 Args:
720 previous_request: The request for the previous page. (required)
721 previous_response: The response from the request for the previous page. (required)
722
723 Returns:
724 A request object that you can call &#x27;execute()&#x27; on to request the next
725 page. Returns None if there are no more items in the collection.
726 </pre>
727 </div>
728
729 <div class="method">
730 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
731 <pre>Updates an Audience on a property.
732
733 Args:
734 name: string, Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} (required)
735 body: object, The request body.
736 The object takes the form of:
737
738 { # A resource message representing an Audience.
739 &quot;adsPersonalizationEnabled&quot;: 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.
740 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the Audience was created.
741 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the Audience.
742 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Audience.
743 &quot;eventTrigger&quot;: { # 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.
744 &quot;eventName&quot;: &quot;A String&quot;, # Required. The event name that will be logged.
745 &quot;logCondition&quot;: &quot;A String&quot;, # Required. When to log the event.
746 },
747 &quot;exclusionDurationMode&quot;: &quot;A String&quot;, # 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.
748 &quot;filterClauses&quot;: [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
749 { # 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).
750 &quot;clauseType&quot;: &quot;A String&quot;, # Required. Specifies whether this is an include or exclude filter clause.
751 &quot;sequenceFilter&quot;: { # 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.
752 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
753 &quot;sequenceMaximumDuration&quot;: &quot;A String&quot;, # Optional. Defines the time period in which the whole sequence must occur.
754 &quot;sequenceSteps&quot;: [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
755 { # A condition that must occur in the specified step order for this user to match the sequence.
756 &quot;constraintDuration&quot;: &quot;A String&quot;, # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] &lt;= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
757 &quot;filterExpression&quot;: { # 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.
758 &quot;andGroup&quot;: { # 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.
759 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
760 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
761 ],
762 },
763 &quot;dimensionOrMetricFilter&quot;: { # 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.
764 &quot;atAnyPointInTime&quot;: 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.
765 &quot;betweenFilter&quot;: { # 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.
766 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
767 &quot;doubleValue&quot;: 3.14, # Double value.
768 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
769 },
770 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
771 &quot;doubleValue&quot;: 3.14, # Double value.
772 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
773 },
774 },
775 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
776 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
777 &quot;inListFilter&quot;: { # 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.
778 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
779 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
780 &quot;A String&quot;,
781 ],
782 },
783 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
784 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
785 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
786 &quot;doubleValue&quot;: 3.14, # Double value.
787 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
788 },
789 },
790 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
791 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
792 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
793 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
794 },
795 },
796 &quot;eventFilter&quot;: { # 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.
797 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
798 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
799 },
800 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
801 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
802 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
803 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
804 ],
805 },
806 },
807 &quot;immediatelyFollows&quot;: 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.
808 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this step.
809 },
810 ],
811 },
812 &quot;simpleFilter&quot;: { # 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.
813 &quot;filterExpression&quot;: { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
814 &quot;andGroup&quot;: { # 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.
815 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
816 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
817 ],
818 },
819 &quot;dimensionOrMetricFilter&quot;: { # 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.
820 &quot;atAnyPointInTime&quot;: 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.
821 &quot;betweenFilter&quot;: { # 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.
822 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
823 &quot;doubleValue&quot;: 3.14, # Double value.
824 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
825 },
826 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
827 &quot;doubleValue&quot;: 3.14, # Double value.
828 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
829 },
830 },
831 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
832 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
833 &quot;inListFilter&quot;: { # 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.
834 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
835 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
836 &quot;A String&quot;,
837 ],
838 },
839 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
840 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
841 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
842 &quot;doubleValue&quot;: 3.14, # Double value.
843 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
844 },
845 },
846 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
847 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
848 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
849 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
850 },
851 },
852 &quot;eventFilter&quot;: { # 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.
853 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
854 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
855 },
856 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
857 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
858 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
859 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
860 ],
861 },
862 },
863 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
864 },
865 },
866 ],
867 &quot;membershipDurationDays&quot;: 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
868 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
869 }
870
871 updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
872 x__xgafv: string, V1 error format.
873 Allowed values
874 1 - v1 error format
875 2 - v2 error format
876
877 Returns:
878 An object of the form:
879
880 { # A resource message representing an Audience.
881 &quot;adsPersonalizationEnabled&quot;: 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.
882 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the Audience was created.
883 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the Audience.
884 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Audience.
885 &quot;eventTrigger&quot;: { # 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.
886 &quot;eventName&quot;: &quot;A String&quot;, # Required. The event name that will be logged.
887 &quot;logCondition&quot;: &quot;A String&quot;, # Required. When to log the event.
888 },
889 &quot;exclusionDurationMode&quot;: &quot;A String&quot;, # 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.
890 &quot;filterClauses&quot;: [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
891 { # 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).
892 &quot;clauseType&quot;: &quot;A String&quot;, # Required. Specifies whether this is an include or exclude filter clause.
893 &quot;sequenceFilter&quot;: { # 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.
894 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
895 &quot;sequenceMaximumDuration&quot;: &quot;A String&quot;, # Optional. Defines the time period in which the whole sequence must occur.
896 &quot;sequenceSteps&quot;: [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
897 { # A condition that must occur in the specified step order for this user to match the sequence.
898 &quot;constraintDuration&quot;: &quot;A String&quot;, # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] &lt;= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
899 &quot;filterExpression&quot;: { # 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.
900 &quot;andGroup&quot;: { # 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.
901 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
902 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
903 ],
904 },
905 &quot;dimensionOrMetricFilter&quot;: { # 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.
906 &quot;atAnyPointInTime&quot;: 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.
907 &quot;betweenFilter&quot;: { # 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.
908 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
909 &quot;doubleValue&quot;: 3.14, # Double value.
910 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
911 },
912 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
913 &quot;doubleValue&quot;: 3.14, # Double value.
914 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
915 },
916 },
917 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
918 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
919 &quot;inListFilter&quot;: { # 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.
920 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
921 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
922 &quot;A String&quot;,
923 ],
924 },
925 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
926 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
927 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
928 &quot;doubleValue&quot;: 3.14, # Double value.
929 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
930 },
931 },
932 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
933 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
934 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
935 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
936 },
937 },
938 &quot;eventFilter&quot;: { # 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.
939 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
940 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
941 },
942 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
943 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
944 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
945 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
946 ],
947 },
948 },
949 &quot;immediatelyFollows&quot;: 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.
950 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this step.
951 },
952 ],
953 },
954 &quot;simpleFilter&quot;: { # 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.
955 &quot;filterExpression&quot;: { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
956 &quot;andGroup&quot;: { # 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.
957 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
958 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
959 ],
960 },
961 &quot;dimensionOrMetricFilter&quot;: { # 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.
962 &quot;atAnyPointInTime&quot;: 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.
963 &quot;betweenFilter&quot;: { # 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.
964 &quot;fromValue&quot;: { # To represent a number. # Required. Begins with this number, inclusive.
965 &quot;doubleValue&quot;: 3.14, # Double value.
966 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
967 },
968 &quot;toValue&quot;: { # To represent a number. # Required. Ends with this number, inclusive.
969 &quot;doubleValue&quot;: 3.14, # Double value.
970 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
971 },
972 },
973 &quot;fieldName&quot;: &quot;A String&quot;, # 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).
974 &quot;inAnyNDayPeriod&quot;: 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&#x27;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.
975 &quot;inListFilter&quot;: { # 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.
976 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
977 &quot;values&quot;: [ # Required. The list of possible string values to match against. Must be non-empty.
978 &quot;A String&quot;,
979 ],
980 },
981 &quot;numericFilter&quot;: { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric.
982 &quot;operation&quot;: &quot;A String&quot;, # Required. The operation applied to a numeric filter.
983 &quot;value&quot;: { # To represent a number. # Required. The numeric or date value to match against.
984 &quot;doubleValue&quot;: 3.14, # Double value.
985 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value.
986 },
987 },
988 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
989 &quot;caseSensitive&quot;: True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
990 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
991 &quot;value&quot;: &quot;A String&quot;, # Required. The string value to be matched against.
992 },
993 },
994 &quot;eventFilter&quot;: { # 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.
995 &quot;eventName&quot;: &quot;A String&quot;, # Required. Immutable. The name of the event to match against.
996 &quot;eventParameterFilterExpression&quot;: # 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 &quot;eventCount&quot;, only that one will be considered; all the other filters will be ignored.
997 },
998 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT&#x27;ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
999 &quot;orGroup&quot;: { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
1000 &quot;filterExpressions&quot;: [ # A list of Audience filter expressions.
1001 # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression
1002 ],
1003 },
1004 },
1005 &quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. Specifies the scope for this filter.
1006 },
1007 },
1008 ],
1009 &quot;membershipDurationDays&quot;: 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
1010 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
1011 }</pre>
1012 </div>
1013
1014 </body></html>